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

epyt_flow/VERSION

@@ -1 +1 @@
-0.9.0
+0.11.0

epyt_flow/data/networks.py

@@ -154,8 +154,9 @@ def load_net1(download_dir: str = get_temp_folder(), verbose: bool = True,
     """
     f_in = os.path.join(download_dir, "Net1.inp")
     url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/Net1.inp"
+    backup_urls = ["https://raw.githubusercontent.com/OpenWaterAnalytics/EPyT/refs/heads/dev/epyt/networks/asce-tf-wdst/Net1.inp"]
 
-    download_if_necessary(f_in, url, verbose)
+    download_if_necessary(f_in, url, verbose, backup_urls)
     return load_inp(f_in, flow_units_id=flow_units_id)
 
 
@@ -201,8 +202,9 @@ def load_net2(download_dir: str = get_temp_folder(), verbose: bool = True,
     """
     f_in = os.path.join(download_dir, "Net2.inp")
     url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/Net2.inp"
+    backup_urls = ["https://raw.githubusercontent.com/OpenWaterAnalytics/EPyT/refs/heads/dev/epyt/networks/asce-tf-wdst/Net2.inp"]
 
-    download_if_necessary(f_in, url, verbose)
+    download_if_necessary(f_in, url, verbose, backup_urls)
     return load_inp(f_in, flow_units_id=flow_units_id)
 
 
@@ -248,8 +250,9 @@ def load_net3(download_dir: str = get_temp_folder(), verbose: bool = True,
     """
     f_in = os.path.join(download_dir, "Net3.inp")
     url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/Net3.inp"
+    backup_urls = ["https://raw.githubusercontent.com/OpenWaterAnalytics/EPyT/refs/heads/dev/epyt/networks/asce-tf-wdst/Net3.inp"]
 
-    download_if_necessary(f_in, url, verbose)
+    download_if_necessary(f_in, url, verbose, backup_urls)
     return load_inp(f_in, flow_units_id=flow_units_id)
 
 
@@ -342,8 +345,9 @@ def load_richmond(download_dir: str = get_temp_folder(), verbose: bool = True,
     """
     f_in = os.path.join(download_dir, "Richmond_standard.inp")
     url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/Richmond_standard.inp"
+    backup_urls = ["https://raw.githubusercontent.com/KIOS-Research/EPANET-Benchmarks/refs/heads/master/collect-epanet-inp/Richmond_standard.inp"]
 
-    download_if_necessary(f_in, url, verbose)
+    download_if_necessary(f_in, url, verbose, backup_urls)
     return load_inp(f_in, flow_units_id=flow_units_id)
 
 
@@ -389,8 +393,9 @@ def load_micropolis(download_dir: str = get_temp_folder(), verbose: bool = True,
     """
     f_in = os.path.join(download_dir, "MICROPOLIS_v1.inp")
     url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/MICROPOLIS_v1.inp"
+    backup_urls = ["https://raw.githubusercontent.com/KIOS-Research/EPANET-Benchmarks/refs/heads/master/collect-epanet-inp/MICROPOLIS_v1.inp"]
 
-    download_if_necessary(f_in, url, verbose)
+    download_if_necessary(f_in, url, verbose, backup_urls)
     return load_inp(f_in, flow_units_id=flow_units_id)
 
 
@@ -436,8 +441,9 @@ def load_balerma(download_dir: str = get_temp_folder(), verbose: bool = True,
     """
     f_in = os.path.join(download_dir, "Balerma.inp")
     url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/Balerma.inp"
+    backup_urls = ["https://raw.githubusercontent.com/KIOS-Research/EPANET-Benchmarks/refs/heads/master/collect-epanet-inp/Balerma.inp"]
 
-    download_if_necessary(f_in, url, verbose)
+    download_if_necessary(f_in, url, verbose, backup_urls)
     return load_inp(f_in, flow_units_id=flow_units_id)
 
 
@@ -483,8 +489,9 @@ def load_rural(download_dir: str = get_temp_folder(), verbose: bool = True,
     """
     f_in = os.path.join(download_dir, "RuralNetwork.inp")
     url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/RuralNetwork.inp"
+    backup_urls = ["https://raw.githubusercontent.com/KIOS-Research/EPANET-Benchmarks/refs/heads/master/collect-epanet-inp/RuralNetwork.inp"]
 
-    download_if_necessary(f_in, url, verbose)
+    download_if_necessary(f_in, url, verbose, backup_urls)
     return load_inp(f_in, flow_units_id=flow_units_id)
 
 
@@ -530,8 +537,9 @@ def load_bwsn1(download_dir: str = get_temp_folder(), verbose: bool = True,
     """
     f_in = os.path.join(download_dir, "BWSN_Network_1.inp")
     url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/BWSN_Network_1.inp"
+    backup_urls = ["https://raw.githubusercontent.com/KIOS-Research/EPANET-Benchmarks/refs/heads/master/collect-epanet-inp/BWSN_Network_1.inp"]
 
-    download_if_necessary(f_in, url, verbose)
+    download_if_necessary(f_in, url, verbose, backup_urls)
     return load_inp(f_in, flow_units_id=flow_units_id)
 
 
@@ -577,8 +585,9 @@ def load_bwsn2(download_dir: str = get_temp_folder(), verbose: bool = True,
     """
     f_in = os.path.join(download_dir, "BWSN_Network_2.inp")
     url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/BWSN_Network_2.inp"
+    backup_urls = ["https://raw.githubusercontent.com/KIOS-Research/EPANET-Benchmarks/refs/heads/master/collect-epanet-inp/BWSN_Network_2.inp"]
 
-    download_if_necessary(f_in, url, verbose)
+    download_if_necessary(f_in, url, verbose, backup_urls)
     return load_inp(f_in, flow_units_id=flow_units_id)
 
 
@@ -624,8 +633,9 @@ def load_anytown(download_dir: str = get_temp_folder(), verbose: bool = True,
     """
     f_in = os.path.join(download_dir, "Anytown.inp")
     url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/Anytown.inp"
+    backup_urls = ["https://raw.githubusercontent.com/OpenWaterAnalytics/EPyT/refs/heads/dev/epyt/networks/asce-tf-wdst/Anytown.inp"]
 
-    download_if_necessary(f_in, url, verbose)
+    download_if_necessary(f_in, url, verbose, backup_urls)
     return load_inp(f_in, flow_units_id=flow_units_id)
 
 
@@ -670,9 +680,10 @@ def load_dtown(download_dir: str = get_temp_folder(), verbose: bool = True,
         :class:`~epyt_flow.simulation.scenario_simulator.ScenarioSimulator`.
     """
     f_in = os.path.join(download_dir, "d-town.inp")
-    url = "https://www.exeter.ac.uk/media/universityofexeter/emps/research/cws/downloads/d-town.inp"
+    url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/d-town.inp"
+    backup_urls = ["https://raw.githubusercontent.com/KIOS-Research/EPANET-Benchmarks/refs/heads/master/collect-epanet-inp/d-town.inp"]
 
-    download_if_necessary(f_in, url, verbose)
+    download_if_necessary(f_in, url, verbose, backup_urls)
     return load_inp(f_in, flow_units_id=flow_units_id)
 
 
@@ -774,8 +785,9 @@ def load_kentucky(wdn_id: int = 1, download_dir: str = get_temp_folder(),
 
     f_in = os.path.join(download_dir, f"ky{wdn_id}.inp")
     url = f"https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/ky{wdn_id}.inp"
+    backup_urls = [f"https://raw.githubusercontent.com/OpenWaterAnalytics/EPyT/refs/heads/dev/epyt/networks/asce-tf-wdst/ky{wdn_id}.inp"]
 
-    download_if_necessary(f_in, url, verbose)
+    download_if_necessary(f_in, url, verbose, backup_urls)
     return load_inp(f_in, flow_units_id=flow_units_id)
 
 
@@ -826,8 +838,9 @@ def load_hanoi(download_dir: str = get_temp_folder(),
     """
     f_in = os.path.join(download_dir, "Hanoi.inp")
     url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/Hanoi.inp"
+    backup_urls = ["https://raw.githubusercontent.com/OpenWaterAnalytics/EPyT/refs/heads/dev/epyt/networks/asce-tf-wdst/Hanoi.inp"]
 
-    download_if_necessary(f_in, url, verbose)
+    download_if_necessary(f_in, url, verbose, backup_urls)
     config = load_inp(f_in, flow_units_id=flow_units_id)
 
     if include_default_sensor_placement is True:

epyt_flow/gym/control_gyms.py

@@ -1,6 +1,8 @@
 """
 Module provides functions for registering and creating control environments.
 """
+import warnings
+
 from .scenario_control_env import ScenarioControlEnv
 
 
@@ -18,6 +20,9 @@ def register(env_name: str, env: ScenarioControlEnv) -> None:
     env : :class:`~epyt_flow.gym.scenario_control_env.ScenarioControlEnv`
         Environment.
     """
+    warnings.warn("'register()' is deprecated and will be removed in future releases -- " +
+                  "please consider switching to the EPyT-Control package")
+
     if env_name in environments:
         raise ValueError(f"Environment '{env_name}' already exists.")
     if not issubclass(env, ScenarioControlEnv):
@@ -41,6 +46,9 @@ def make(env_name: str, **kwds) -> ScenarioControlEnv:
     :class:`~epyt_flow.gym.scenario_control_env.ScenarioControlEnv`
         Environment.
     """
+    warnings.warn("'make()' is deprecated and will be removed in future releases -- " +
+                  "please consider switching to the EPyT-Control package")
+
     if env_name not in environments:
         raise ValueError(f"Unknown environment '{env_name}'.")
 

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(
@@ -169,9 +177,14 @@ class ScenarioControlEnv(ABC):
             raise RuntimeError("Can not execute actions affecting the hydraulics "+
                                "when running EPANET-MSX")
 
-        pump_idx = self._scenario_sim.epanet_api.getLinkPumpNameID().index(pump_id)
-        pump_link_idx = self._scenario_sim.epanet_api.getLinkPumpIndex(pump_idx + 1)
-        self._scenario_sim.epanet_api.setLinkStatus(pump_link_idx, status)
+        pump_idx = self._scenario_sim.epanet_api.getLinkPumpNameID().index(pump_id) + 1
+        pump_link_idx = self._scenario_sim.epanet_api.getLinkPumpIndex(pump_idx)
+
+        pattern_idx = self._scenario_sim.epanet_api.getLinkPumpPatternIndex(pump_idx)
+        if pattern_idx != 0:
+            warnings.warn(f"Can not set pump state of pump {pump_id} because a pump pattern exists")
+        else:
+            self._scenario_sim.epanet_api.setLinkStatus(pump_link_idx, status)
 
     def set_pump_speed(self, pump_id: str, speed: float) -> None:
         """
@@ -194,7 +207,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/metrics.py

@@ -1,11 +1,16 @@
 """
 This module provides different metrics for evaluation.
 """
+import warnings
 import numpy as np
 from sklearn.metrics import roc_auc_score as skelarn_roc_auc_score, f1_score as skelarn_f1_scpre, \
     mean_absolute_error, root_mean_squared_error, r2_score as sklearn_r2_score
 
 
+warnings.warn("'epyt_flow.metrics' is deprecated in favor of EPyT-Control " +
+              "and will be removed in future releases.")
+
+
 def r2_score(y_pred: np.ndarray, y: np.ndarray) -> float:
     """
     Computes the R^2 score (also called the coefficient of determination).

epyt_flow/models/event_detector.py

@@ -1,11 +1,16 @@
 """
 Module provides a base class for event detectors.
 """
+import warnings
 from abc import abstractmethod, ABC
 
 from ..simulation.scada import ScadaData
 
 
+warnings.warn("'epyt_flow.models' is deprecated in favor of EPyT-Control " +
+              "and will be removed in future releases.")
+
+
 class EventDetector(ABC):
     """
     Base class for event detectors.

epyt_flow/models/sensor_interpolation_detector.py

@@ -1,6 +1,7 @@
 """
 Module provides a simple residual-based event detector that performs sensor interpolation.
 """
+import warnings
 from typing import Any, Union
 from copy import deepcopy
 import numpy as np
@@ -10,6 +11,10 @@ from .event_detector import EventDetector
 from ..simulation.scada import ScadaData
 
 
+warnings.warn("'epyt_flow.models' is deprecated in favor of EPyT-Control " +
+              "and will be removed in future releases.")
+
+
 class SensorInterpolationDetector(EventDetector):
     """
     Class implementing a residual-based event detector based on sensor interpolation.

epyt_flow/serialization.py

@@ -48,6 +48,11 @@ 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
+COLOR_SCHEMES_ID                        = 36
 
 
 def my_packb(data: Any) -> bytes:

epyt_flow/simulation/__init__.py

@@ -1,5 +1,4 @@
 from .scenario_config import *
 from .sensor_config import *
 from .scenario_simulator import *
-from .scenario_visualizer import *
 from .parallel_simulation import *

epyt_flow/simulation/events/actuator_events.py

@@ -134,7 +134,13 @@ class PumpStateEvent(PumpEvent, JsonSerializable):
     def apply(self, cur_time: int) -> None:
         pump_idx = self._epanet_api.getLinkPumpNameID().index(self.pump_id) + 1
         pump_link_idx = self._epanet_api.getLinkPumpIndex(pump_idx)
-        self._epanet_api.setLinkStatus(pump_link_idx, self.__pump_state)
+
+        pattern_idx = self._epanet_api.getLinkPumpPatternIndex(pump_idx)
+        if pattern_idx != 0:
+            warnings.warn(f"Can not set pump state of pump {self.pump_id} " +
+                          "because a pump pattern exists")
+        else:
+            self._epanet_api.setLinkStatus(pump_link_idx, self.__pump_state)
 
 
 @serializable(PUMP_SPEED_EVENT_ID, ".epytflow_pump_speed_event")

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.