epyt-flow 0.8.1__py3-none-any.whl → 0.10.0__py3-none-any.whl

epyt_flow/rest_api/scenario/handlers.py

@@ -54,7 +54,7 @@ class ScenarioRemoveHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         scenario_id : `str`
             UUID of the scenario.
@@ -95,7 +95,7 @@ class ScenarioExportHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         tmp_file : `str`
             Path to the temporary file to be send.
@@ -111,7 +111,7 @@ class ScenarioExportHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         scenario_id : `str`
             UUID of the scenario.
@@ -152,7 +152,7 @@ class ScenarioConfigHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         scenario_id : `str`
             UUID of the scenario.
@@ -179,9 +179,9 @@ class ScenarioNewHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        req : `falcon.Request`
+        req : `falcon.Request <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#request>`_
             Request instance.
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         scenario_id : `str`
             UUID of the scenario.
@@ -205,7 +205,7 @@ class ScenarioTopologyHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         scenario_id : `str`
             UUID of the scenario.
@@ -232,7 +232,7 @@ class ScenarioGeneralParamsHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         scenario_id : `str`
             UUID of the scenario.
@@ -255,9 +255,9 @@ class ScenarioGeneralParamsHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        req : `falcon.Request`
+        req : `falcon.Request <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#request>`_
             Request instance.
-        resp : `falcon.Request`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Request instance.
         scenario_id : `str`
             UUID of the scenario.
@@ -288,7 +288,7 @@ class ScenarioSensorConfigHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         scenario_id : `str`
             UUID of the scenario.
@@ -310,9 +310,9 @@ class ScenarioSensorConfigHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        req : `falcon.Request`
+        req : `falcon.Request <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#request>`_
             Request instance.
-        resp : `falcon.Request`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Request instance.
         scenario_id : `str`
             UUID of the scenario.
@@ -345,9 +345,9 @@ class ScenarioNodeDemandPatternHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        req : `falcon.Request`
+        req : `falcon.Request <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#request>`_
             Request instance.
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         scenario_id : `str`
             UUID of the scenario.

epyt_flow/rest_api/scenario/simulation_handlers.py

@@ -33,9 +33,9 @@ class ScenarioSimulationHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        req : `falcon.Request`
+        req : `falcon.Request <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#request>`_
             Request instance.
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         scenario_id : `str`
             UUID of the scenario.
@@ -63,7 +63,7 @@ class ScenarioSimulationHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         scenario_id : `str`
             UUID of the scenario.
@@ -104,9 +104,9 @@ class ScenarioBasicQualitySimulationHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        req : `falcon.Request`
+        req : `falcon.Request <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#request>`_
             Request instance.
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         scenario_id : `str`
             UUID of the scenario.
@@ -149,9 +149,9 @@ class ScenarioAdvancedQualitySimulationHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        req : `falcon.Request`
+        req : `falcon.Request <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#request>`_
             Request instance.
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         scenario_id : `str`
             UUID of the scenario.

epyt_flow/rest_api/scenario/uncertainty_handlers.py

@@ -18,7 +18,7 @@ class ScenarioModelUncertaintyHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         scenario_id : `str`
             UUID of the scenario.
@@ -40,9 +40,9 @@ class ScenarioModelUncertaintyHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        req : `falcon.Request`
+        req : `falcon.Request <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#request>`_
             Request instance.
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         scenario_id : `str`
             UUID of the scenario.
@@ -73,7 +73,7 @@ class ScenarioSensorUncertaintyHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         scenario_id : `str`
             UUID of the scenario.
@@ -95,9 +95,9 @@ class ScenarioSensorUncertaintyHandler(ScenarioBaseHandler):
 
         Parameters
         ----------
-        req : `falcon.Request`
+        req : `falcon.Request <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#request>`_
             Request instance.
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         scenario_id : `str`
             UUID of the scenario.

epyt_flow/serialization.py

@@ -48,18 +48,24 @@ PUMP_STATE_EVENT_ID                     = 28
 PUMP_SPEED_EVENT_ID                     = 29
 VALVE_STATE_EVENT_ID                    = 30
 SPECIESINJECTION_EVENT_ID               = 31
+SIMPLE_CONTROL_ID                       = 32
+COMPLEX_CONTROL_ID                      = 33
+COMPLEX_CONTROL_CONDITION_ID            = 34
+COMPLEX_CONTROL_ACTION_ID               = 35
 
 
 def my_packb(data: Any) -> bytes:
     """
-    Overriden `umsgpack.packb` method to support custom serialization handlers.
+    Overriden `umsgpack.packb <https://msgpack-python.readthedocs.io/en/latest/api.html#msgpack.packb>`_
+    method to support custom serialization handlers.
     """
     return umsgpack.packb(data, ext_handlers=ext_handler_pack)
 
 
 def my_unpackb(data: Any) -> Any:
     """
-    Overriden `umsgpack.unpackb` method to support custom serialization handlers.
+    Overriden `umsgpack.unpackb <https://msgpack-python.readthedocs.io/en/latest/api.html#msgpack.unpackb>`_
+    method to support custom serialization handlers.
     """
     return umsgpack.unpackb(data, ext_handlers=ext_handler_unpack)
 

epyt_flow/simulation/events/actuator_events.py

@@ -180,7 +180,7 @@ class PumpSpeedEvent(PumpEvent, JsonSerializable):
         if pattern_idx == 0:
             warnings.warn(f"No pattern for pump '{self.pump_id}' found -- a new pattern is created")
             pattern_idx = self._epanet_api.addPattern(f"pump_speed_{self.pump_id}")
-            self._epanet_api.setLinkPumpPatternIndex(pattern_idx)
+            self._epanet_api.setLinkPumpPatternIndex(pump_idx, pattern_idx)
 
         self._epanet_api.setPattern(pattern_idx, np.array([self.__pump_speed]))
 

epyt_flow/simulation/events/leakages.py

@@ -37,7 +37,7 @@ class Leakage(SystemEvent, JsonSerializable):
         in this case, 'area' must be set to 'None'.
 
         The default is None.
-    profile : `numpy.ndarray`
+    profile : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Pattern of this leak.
     node_id : `str`, optional
         ID of the node at which the leak is placed.

epyt_flow/simulation/events/quality_events.py

@@ -24,7 +24,7 @@ class SpeciesInjectionEvent(SystemEvent, JsonSerializable):
         ID of the bulk species that is going to be injected.
     node_id : `str`
         ID of the node at which the injection is palced.
-    profile : `numpy.ndarray`
+    profile : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Injection strength profile -- i.e. every entry corresponds to the strength of the injection
         at a point in time. Pattern will repeat if it is shorter than the total injection time.
     source_type : `int`
@@ -136,7 +136,7 @@ class SpeciesInjectionEvent(SystemEvent, JsonSerializable):
             f"node_id: {self.__node_id} profile: {self.__profile} source_type: {self.__source_type}"
 
     def _get_pattern_id(self) -> str:
-        return f"{self.__species_id}_{self.__node_id}_{self.start_time}"
+        return f"{self.__species_id}_{self.__node_id}"
 
     def init(self, epanet_api: epyt.epanet) -> None:
         super().init(epanet_api)
@@ -180,9 +180,20 @@ class SpeciesInjectionEvent(SystemEvent, JsonSerializable):
 
         pattern_id = self._get_pattern_id()
         if pattern_id in self._epanet_api.getMSXPatternsNameID():
-            raise ValueError("Duplicated injection event")
-
-        self._epanet_api.addMSXPattern(pattern_id, pattern)
+            node_idx = self._epanet_api.getNodeIndex(self.__node_id)
+            species_idx, = self._epanet_api.getMSXSpeciesIndex([self.__species_id])
+            cur_source_type = self._epanet_api.msx.MSXgetsource(node_idx, species_idx)
+            if cur_source_type[0] != source_type_:
+                raise ValueError("Source type does not match existing source type")
+
+            # Add new injection amount to existing injection --
+            # i.e. two injection events at the same node
+            pattern_idx, = self._epanet_api.getMSXPatternsIndex([pattern_id])
+            cur_pattern = self._epanet_api.getMSXPattern()[pattern_idx - 1]
+            cur_pattern += pattern
+            self._epanet_api.setMSXPattern(pattern_idx, cur_pattern)
+        else:
+            self._epanet_api.addMSXPattern(pattern_id, pattern)
         self._epanet_api.setMSXSources(self.__node_id, self.__species_id, source_type_, 1,
                                        pattern_id)
 

epyt_flow/simulation/events/sensor_reading_attack.py

@@ -26,7 +26,7 @@ class SensorOverrideAttack(SensorReadingAttack, JsonSerializable):
 
     Parameters
     ----------
-    new_sensor_values : `numpy.ndarray`
+    new_sensor_values : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         New sensor reading values -- i.e. these values replace the true sensor reading values.
     """
     def __init__(self, new_sensor_values: np.ndarray, **kwds):
@@ -46,7 +46,7 @@ class SensorOverrideAttack(SensorReadingAttack, JsonSerializable):
     @property
     def new_sensor_values(self) -> np.ndarray:
         """
-        Get the new sensor reading values -- i.e. these values replace the
+        Returns the new sensor reading values -- i.e. these values replace the
         true sensor reading values.
 
         Returns
@@ -64,7 +64,7 @@ class SensorOverrideAttack(SensorReadingAttack, JsonSerializable):
             raise TypeError("Can not compare 'SensorOverrideAttack' instance " +
                             f"with '{type(other)}' instance")
 
-        return super().__eq__(other) and self.__new_sensor_values == other.new_sensor_values
+        return super().__eq__(other) and np.all(self.__new_sensor_values == other.new_sensor_values)
 
     def __str__(self) -> str:
         return f"{type(self).__name__} {super().__str__()} " +\
@@ -151,6 +151,19 @@ class SensorReplayAttack(SensorReadingAttack, JsonSerializable):
         """
         return self.__sensor_data_time_window_end
 
+    @property
+    def new_sensor_values(self) -> np.ndarray:
+        """
+        Returns the new sensor reading values -- i.e. these values replace the
+        true sensor reading values.
+
+        Returns
+        -------
+        `np.ndarray`
+            New sensor readings.
+        """
+        return deepcopy(self.__new_sensor_values)
+
     def get_attributes(self) -> dict:
         my_attributes = {"new_sensor_values": self.__new_sensor_values,
                          "replay_data_time_window_start": self.__sensor_data_time_window_start,
@@ -163,7 +176,7 @@ class SensorReplayAttack(SensorReadingAttack, JsonSerializable):
             raise TypeError("Can not compare 'SensorReplayAttack' instance " +
                             f"with '{type(other)}' instance")
 
-        return super().__eq__(other) and self.__new_sensor_values == other.new_sensor_values
+        return super().__eq__(other) and np.all(self.__new_sensor_values == other.new_sensor_values)
 
     def __str__(self) -> str:
         return f"{type(self).__name__} {super().__str__()} " +\

epyt_flow/simulation/events/sensor_reading_event.py

@@ -95,13 +95,28 @@ class SensorReadingEvent(Event):
             if self.__sensor_id not in sensor_config.tank_volume_sensors:
                 __show_warning()
         elif self.__sensor_type == SENSOR_TYPE_NODE_BULK_SPECIES:
-            if self.__sensor_id not in sensor_config.bulk_species_node_sensors:
+            sensor_present = False
+            for _, sensors_id in sensor_config.bulk_species_node_sensors.items():
+                if self.__sensor_id in sensors_id:
+                    sensor_present = True
+                    break
+            if sensor_present is False:
                 __show_warning()
         elif self.__sensor_type == SENSOR_TYPE_LINK_BULK_SPECIES:
-            if self.__sensor_id not in sensor_config.bulk_species_link_sensors:
+            sensor_present = False
+            for _, sensors_id in sensor_config.bulk_species_link_sensors.items():
+                if self.__sensor_id in sensors_id:
+                    sensor_present = True
+                    break
+            if sensor_present is False:
                 __show_warning()
         elif self.__sensor_type == SENSOR_TYPE_SURFACE_SPECIES:
-            if self.__sensor_id not in sensor_config.surface_species_sensors:
+            sensor_present = False
+            for _, sensors_id in sensor_config.surface_species_sensors.items():
+                if self.__sensor_id in sensors_id:
+                    sensor_present = True
+                    break
+            if sensor_present is False:
                 __show_warning()
 
     @property
@@ -157,14 +172,14 @@ class SensorReadingEvent(Event):
 
         Parameters
         ----------
-        sensor_readings : `numpy.ndarray`
+        sensor_readings : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             Original sensor readings.
-        sensor_readings_time : `numpy.ndarray`
+        sensor_readings_time : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             Time (seconds since simulation start) for each sensor reading row in 'sensor_readings'.
 
         Returns
         -------
-        `numpy.ndarray`
+        `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             Modified sensor readings.
         """
         raise NotImplementedError()

epyt_flow/simulation/events/system_event.py

@@ -23,7 +23,7 @@ class SystemEvent(Event):
 
         Parameters
         ----------
-        epanet_api : `epyt.epanet`
+        epanet_api : `epyt.epanet <https://epanet-python-toolkit-epyt.readthedocs.io/en/stable/api.html#epyt.epanet.epanet>`_
             API to EPANET and EPANET-MSX.
         """
         self._epanet_api = epanet_api

epyt_flow/simulation/parallel_simulation.py

@@ -4,8 +4,8 @@ Module provides functions for simulating several scenarios in parallel.
 from typing import Callable, Any
 import os
 import warnings
-from multiprocess import Pool, cpu_count
 import shutil
+from multiprocess import Pool, cpu_count
 import psutil
 
 from .scenario_config import ScenarioConfig

epyt_flow/simulation/scada/__init__.py

@@ -1,3 +1,5 @@
 from .scada_data import *
 from .scada_data_export import *
-from .advanced_control import *
+from .custom_control import *
+from .simple_control import *
+from .complex_control import *

epyt_flow/simulation/scada/advanced_control.py

@@ -1,21 +1,25 @@
 """
-Module provides a base class for control modules.
+Deprecated -- use epyt_flow.simulation.scada.custom_control instead
 """
-from abc import abstractmethod, ABC
 import warnings
+from abc import abstractmethod, ABC
 import numpy as np
 import epyt
 
 from . import ScadaData
 
 
+warnings.warn("'epyt_flow.simulation.scada.advanced_control' is deprecated and will be removed " +
+              "in future releases -- use 'epyt_flow.simulation.scada.custom_control' instead")
+
+
 class AdvancedControlModule(ABC):
     """
     Base class for a control module.
 
     Attributes
     ----------
-    epanet_api : `epyt.epanet`
+    epanet_api : `epyt.epanet <https://epanet-python-toolkit-epyt.readthedocs.io/en/latest/api.html#epyt.epanet.epanet>`_
         API to EPANET and EPANET-MSX. Is set in :func:`init`.
     """
     def __init__(self, **kwds):
@@ -29,7 +33,7 @@ class AdvancedControlModule(ABC):
 
         Parameters
         ----------
-        epanet_api : `epyt.epanet`
+        epanet_api : `epyt.epanet <https://epanet-python-toolkit-epyt.readthedocs.io/en/latest/api.html#epyt.epanet.epanet>`_
             API to EPANET for implementing the control module.
         """
         if not isinstance(epanet_api, epyt.epanet):