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

epyt_flow/VERSION

@@ -1 +1 @@
-0.9.0
+0.10.0

epyt_flow/gym/scenario_control_env.py

@@ -107,6 +107,14 @@ class ScenarioControlEnv(ABC):
             Current SCADA data (i.e. sensor readings).
         """
         if self._scenario_sim is not None:
+            # Abort current simulation if any is runing
+            try:
+                next(self._sim_generator)
+                self._sim_generator.send(True)
+            except StopIteration:
+                pass
+
+            # Close scenario
             self._scenario_sim.close()
 
         self._scenario_sim = ScenarioSimulator(
@@ -194,7 +202,7 @@ class ScenarioControlEnv(ABC):
         if pattern_idx == 0:
             warnings.warn(f"No pattern for pump '{pump_id}' found -- a new pattern is created")
             pattern_idx = self._scenario_sim.epanet_api.addPattern(f"pump_speed_{pump_id}")
-            self._scenario_sim.epanet_api.setLinkPumpPatternIndex(pump_idx, pattern_idx)
+            self._scenario_sim.epanet_api.setLinkPumpPatternIndex(pump_idx + 1, pattern_idx)
 
         self._scenario_sim.epanet_api.setPattern(pattern_idx, np.array([speed]))
 

epyt_flow/serialization.py

@@ -48,6 +48,10 @@ 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:

epyt_flow/simulation/events/sensor_reading_attack.py

@@ -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

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,14 +1,18 @@
 """
-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.