epyt-flow 0.1.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

epyt_flow/simulation/scada/scada_data_export.py

@@ -8,7 +8,8 @@ from scipy.io import savemat
 import pandas as pd
 
 from .scada_data import ScadaData
-from ..sensor_config import SensorConfig
+from ..sensor_config import SensorConfig, massunit_to_str, flowunit_to_str, qualityunit_to_str, \
+    is_flowunit_simetric
 
 
 class ScadaDataExport():
@@ -73,13 +74,7 @@ class ScadaDataExport():
         """
         old_sensor_config = scada_data.sensor_config
 
-        sensor_config = SensorConfig(nodes=old_sensor_config.nodes,
-                                     links=old_sensor_config.links,
-                                     valves=old_sensor_config.valves,
-                                     pumps=old_sensor_config.pumps,
-                                     tanks=old_sensor_config.tanks,
-                                     bulk_species=old_sensor_config.bulk_species,
-                                     surface_species=old_sensor_config.surface_species)
+        sensor_config = SensorConfig.create_empty_sensor_config(old_sensor_config)
         sensor_config.pressure_sensors = sensor_config.nodes
         sensor_config.flow_sensors = sensor_config.links
         sensor_config.demand_sensors = sensor_config.nodes
@@ -112,13 +107,42 @@ class ScadaDataExport():
         """
         sensor_readings = scada_data.get_data()
 
+        def __get_sensor_unit(sensor_type):
+            if sensor_type == "pressure":
+                if is_flowunit_simetric(scada_data.sensor_config.flow_unit):
+                    return "psi"
+                else:
+                    return "meter"
+            elif sensor_type == "flow" or sensor_type == "demand":
+                return flowunit_to_str(scada_data.sensor_config.flow_unit)
+            elif sensor_type == "quality_node" or sensor_type == "quality_link":
+                return qualityunit_to_str(scada_data.sensor_config.quality_unit)
+            elif sensor_type == "tank_volume":
+                if is_flowunit_simetric(scada_data.sensor_config.flow_unit):
+                    return "cubic meter"
+                else:
+                    return "cubic foot"
+            else:
+                return ""
+
         col_desc = [None for _ in range(sensor_readings.shape[1])]
         sensor_config = scada_data.sensor_config
         sensors_id_to_idx = sensor_config.sensors_id_to_idx
         for sensor_type in sensors_id_to_idx:
+            unit_desc = __get_sensor_unit(sensor_type)
             for item_id in sensors_id_to_idx[sensor_type]:
                 col_id = sensors_id_to_idx[sensor_type][item_id]
-                col_desc[col_id] = [sensor_type, item_id]
+
+                if sensor_type == "bulk_species_node" or sensor_type == "bulk_species_link":
+                    bulk_species_idx = sensor_config.bulk_species.index(item_id)
+                    unit_desc = massunit_to_str(sensor_config.
+                                                bulk_species_mass_unit[bulk_species_idx])
+                elif sensor_type == "surface_species":
+                    surface_species_idx = sensor_config.surface_species.index(item_id)
+                    unit_desc = massunit_to_str(sensor_config.
+                                                bulk_species_mass_unit[surface_species_idx])
+
+                col_desc[col_id] = [sensor_type, item_id, unit_desc]
 
         return np.array(col_desc, dtype=object)
 
@@ -169,7 +193,8 @@ class ScadaDataNumpyExport(ScadaDataExport):
             scada_data.change_sensor_config(old_sensor_config)
 
         np.savez(self.f_out, sensor_readings=sensor_readings, col_desc=col_desc,
-                 sensor_readings_time=sensor_readings_time)
+                 sensor_readings_time=sensor_readings_time,
+                 flow_unit=scada_data.sensor_config.flow_unit)
 
 
 class ScadaDataXlsxExport(ScadaDataExport):
@@ -214,7 +239,7 @@ class ScadaDataXlsxExport(ScadaDataExport):
                 to_excel(writer, sheet_name="Sensor readings", index=False)
             pd.DataFrame(sensor_readings_time, columns=["Time (s)"]). \
                 to_excel(writer, sheet_name="Sensor readings time", index=False)
-            pd.DataFrame(col_desc, columns=["Name", "Type", "Location"]). \
+            pd.DataFrame(col_desc, columns=["Name", "Type", "Location", "Unit"]). \
                 to_excel(writer, sheet_name="Sensors description", index=False)
 
 
@@ -252,4 +277,6 @@ class ScadaDataMatlabExport(ScadaDataExport):
             scada_data.change_sensor_config(old_sensor_config)
 
         savemat(self.f_out, {"sensor_readings": sensor_readings,
-                             "sensor_readings_time": sensor_readings_time, "col_desc": col_desc})
+                             "sensor_readings_time": sensor_readings_time,
+                             "col_desc": col_desc,
+                             "flow_unit": scada_data.sensor_config.flow_unit})

epyt_flow/simulation/scenario_config.py

@@ -415,8 +415,8 @@ class ScenarioConfig(Serializable):
             general_params["demand_model"] = general_settings["demand_model"]
         if "quality_model" in general_settings.keys():
             general_params["quality_model"] = general_settings["quality_model"]
-        if "flow_units" in general_settings.keys():
-            general_params["flow_units"] = general_settings["flow_units"]
+        if "flow_units_id" in general_settings.keys():
+            general_params["flow_units_id"] = general_settings["flow_units_id"]
 
         sensor_config = data["sensors"]
 
@@ -582,24 +582,18 @@ class ScenarioConfig(Serializable):
         sensor_config = None
         from .scenario_simulator import ScenarioSimulator
         with ScenarioSimulator(f_inp_in) as scenario:
-            sensor_config = SensorConfig(nodes=scenario.sensor_config.nodes,
-                                         links=scenario.sensor_config.links,
-                                         valves=scenario.sensor_config.valves,
-                                         pumps=scenario.sensor_config.pumps,
-                                         tanks=scenario.sensor_config.tanks,
-                                         bulk_species=scenario.sensor_config.bulk_species,
-                                         surface_species=scenario.sensor_config.surface_species,
-                                         pressure_sensors=pressure_sensors,
-                                         flow_sensors=flow_sensors,
-                                         demand_sensors=demand_sensors,
-                                         quality_node_sensors=node_quality_sensors,
-                                         quality_link_sensors=link_quality_sensors,
-                                         valve_state_sensors=valve_state_sensors,
-                                         pump_state_sensors=pump_state_sensors,
-                                         tank_volume_sensors=tank_volume_sensors,
-                                         bulk_species_node_sensors=bulk_species_node_sensors,
-                                         bulk_species_link_sensors=bulk_species_link_sensors,
-                                         surface_species_sensors=surface_species_sensors)
+            sensor_config = SensorConfig.create_empty_sensor_config(scenario.sensor_config)
+            sensor_config.pressure_sensors = pressure_sensors
+            sensor_config.flow_sensors = flow_sensors
+            sensor_config.demand_sensors = demand_sensors
+            sensor_config.quality_node_sensors = node_quality_sensors
+            sensor_config.quality_link_sensors = link_quality_sensors
+            sensor_config.valve_state_sensors = valve_state_sensors
+            sensor_config.pump_state_sensors = pump_state_sensors
+            sensor_config.tank_volume_sensors = tank_volume_sensors
+            sensor_config.bulk_species_node_sensors = bulk_species_node_sensors
+            sensor_config.bulk_species_link_sensors = bulk_species_link_sensors
+            sensor_config.surface_species_sensors = surface_species_sensors
 
         # Create final scenario configuration
         return ScenarioConfig(f_inp_in=f_inp_in, f_msx_in=f_msx_in, general_params=general_params,