epyt-flow 0.12.0__tar.gz → 0.13.0__tar.gz

{epyt_flow-0.12.0 → epyt_flow-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: epyt-flow
-Version: 0.12.0
+Version: 0.13.0
 Summary: EPyT-Flow -- EPANET Python Toolkit - Flow
 Author-email: André Artelt <aartelt@techfak.uni-bielefeld.de>, "Marios S. Kyriakou" <kiriakou.marios@ucy.ac.cy>, "Stelios G. Vrachimis" <vrachimis.stelios@ucy.ac.cy>
 License-Expression: MIT

{epyt_flow-0.12.0 → epyt_flow-0.13.0}/epyt_flow/EPANET/EPANET-MSX/Src/msxtoolkit.c

@@ -203,7 +203,7 @@ int   MSXDLLEXPORT  MSXusehydfile(char *fname)
 // --- read length of simulation period covered by file
 
     fread(&n, sizeof(INT4), 1, MSX.HydFile.file);
-    MSX.Dur = 1000 * n;
+    MSX.Dur = INT64_C(1000) * n;
     MSX.HydOffset = ftell(MSX.HydFile.file);
     return 0;
 }

epyt_flow-0.13.0/epyt_flow/VERSION

@@ -0,0 +1 @@
+0.13.0

{epyt_flow-0.12.0 → epyt_flow-0.13.0}/epyt_flow/gym/scenario_control_env.py

@@ -131,7 +131,7 @@ class ScenarioControlEnv(ABC):
     def _next_sim_itr(self) -> Union[tuple[ScadaData, bool], ScadaData]:
         try:
             next(self._sim_generator)
-            scada_data = self._sim_generator.send(False)
+            scada_data, terminated = self._sim_generator.send(False)
 
             if self._scenario_sim.f_msx_in is not None:
                 cur_time = int(scada_data.sensor_readings_time[0])
@@ -142,7 +142,7 @@ class ScenarioControlEnv(ABC):
             if self.autoreset is True:
                 return scada_data
             else:
-                return scada_data, False
+                return scada_data, terminated
         except StopIteration:
             if self.__autoreset is True:
                 return self.reset()

{epyt_flow-0.12.0 → epyt_flow-0.13.0}/epyt_flow/simulation/scenario_simulator.py

@@ -1999,12 +1999,12 @@ class ScenarioSimulator():
         result = None
 
         gen = self.run_advanced_quality_simulation_as_generator
-        for scada_data in gen(hyd_file_in=hyd_file_in,
-                              verbose=verbose,
-                              return_as_dict=True,
-                              frozen_sensor_config=frozen_sensor_config,
-                              use_quality_time_step_as_reporting_time_step=
-                              use_quality_time_step_as_reporting_time_step):
+        for scada_data, _ in gen(hyd_file_in=hyd_file_in,
+                                 verbose=verbose,
+                                 return_as_dict=True,
+                                 frozen_sensor_config=frozen_sensor_config,
+                                 use_quality_time_step_as_reporting_time_step=
+                                 use_quality_time_step_as_reporting_time_step):
             if result is None:
                 result = {}
                 for data_type, data in scada_data.items():
@@ -2032,7 +2032,7 @@ class ScenarioSimulator():
                                                      return_as_dict: bool = False,
                                                      frozen_sensor_config: bool = False,
                                                      use_quality_time_step_as_reporting_time_step: bool = False,
-                                                     ) -> Generator[Union[ScadaData, dict], bool, None]:
+                                                     ) -> Generator[Union[tuple[ScadaData, bool], tuple[dict, bool]], bool, None]:
         """
         Runs an advanced quality analysis using EPANET-MSX.
 
@@ -2066,7 +2066,7 @@ class ScenarioSimulator():
         -------
         :class:`~epyt_flow.simulation.scada.scada_data.ScadaData`
             Generator containing the current EPANET-MSX simulation results as SCADA data
-            (i.e. species concentrations).
+            (i.e. species concentrations) and a boolean indicating whether the simulation terminated or not.
         """
         if self.__running_simulation is True:
             raise RuntimeError("A simulation is already running.")
@@ -2175,13 +2175,16 @@ class ScenarioSimulator():
                 data = {"bulk_species_node_concentration_raw": bulk_species_node_concentrations,
                         "bulk_species_link_concentration_raw": bulk_species_link_concentrations,
                         "surface_species_concentration_raw": surface_species_concentrations,
-                        "sensor_readings_time": np.array([0])}
+                        "sensor_readings_time": np.array([0]),
+                        "warnings_code": np.array([0]) # TODO: Replace with MSX error
+                        }
             else:
                 data = ScadaData(network_topo=network_topo, sensor_config=self._sensor_config,
                                  bulk_species_node_concentration_raw=bulk_species_node_concentrations,
                                  bulk_species_link_concentration_raw=bulk_species_link_concentrations,
                                  surface_species_concentration_raw=surface_species_concentrations,
                                  sensor_readings_time=np.array([0]),
+                                 warnings_code=np.array([0]), # TODO: Replace with MSX error
                                  sensor_reading_events=self._sensor_reading_events,
                                  sensor_noise=self._sensor_noise,
                                  frozen_sensor_config=frozen_sensor_config)
@@ -2191,7 +2194,7 @@ class ScenarioSimulator():
                 if abort is True:
                     return None
 
-            yield data
+            yield (data, False)
 
         # Run step-by-step simulation
         tleft = 1
@@ -2219,7 +2222,9 @@ class ScenarioSimulator():
                                 "bulk_species_link_concentration_raw":
                                     bulk_species_link_concentrations,
                                 "surface_species_concentration_raw": surface_species_concentrations,
-                                "sensor_readings_time": np.array([total_time])}
+                                "sensor_readings_time": np.array([total_time]),
+                                "warnings_code": np.array([0]), # TODO: Replace with MSX error
+                                }
                     else:
                         data = ScadaData(network_topo=network_topo,
                                          sensor_config=self._sensor_config,
@@ -2230,6 +2235,7 @@ class ScenarioSimulator():
                                          surface_species_concentration_raw=
                                             surface_species_concentrations,
                                          sensor_readings_time=np.array([total_time]),
+                                         warnings_code=np.array([0]), # TODO: Replace with MSX error
                                          sensor_reading_events=self._sensor_reading_events,
                                          sensor_noise=self._sensor_noise,
                                          frozen_sensor_config=frozen_sensor_config)
@@ -2239,7 +2245,7 @@ class ScenarioSimulator():
                         if abort is not False:
                             break
 
-                    yield data
+                    yield (data, tleft <= 0)
 
         self.__running_simulation = False
 
@@ -2284,12 +2290,12 @@ class ScenarioSimulator():
 
         # Run simulation step-by-step
         gen = self.run_basic_quality_simulation_as_generator
-        for scada_data in gen(hyd_file_in=hyd_file_in,
-                              verbose=verbose,
-                              return_as_dict=True,
-                              frozen_sensor_config=frozen_sensor_config,
-                              use_quality_time_step_as_reporting_time_step=
-                              use_quality_time_step_as_reporting_time_step):
+        for scada_data, _ in gen(hyd_file_in=hyd_file_in,
+                                 verbose=verbose,
+                                 return_as_dict=True,
+                                 frozen_sensor_config=frozen_sensor_config,
+                                 use_quality_time_step_as_reporting_time_step=
+                                 use_quality_time_step_as_reporting_time_step):
             if result is None:
                 result = {}
                 for data_type, data in scada_data.items():
@@ -2314,7 +2320,7 @@ class ScenarioSimulator():
                                                   return_as_dict: bool = False,
                                                   frozen_sensor_config: bool = False,
                                                   use_quality_time_step_as_reporting_time_step: bool = False
-                                                  ) -> Generator[Union[ScadaData, dict], bool, None]:
+                                                  ) -> Generator[Union[tuple[ScadaData, bool], tuple[dict, bool]], bool, None]:
         """
         Runs a basic quality analysis using EPANET.
 
@@ -2349,11 +2355,13 @@ class ScenarioSimulator():
         Returns
         -------
         :class:`~epyt_flow.simulation.scada.scada_data.ScadaData`
-            Generator with the current simulation results/states as SCADA data.
+            Generator with the current simulation results/states as SCADA data and a
+            boolean indicating whether the simulation terminated or not.
         """
         if self.__running_simulation is True:
             raise RuntimeError("A simulation is already running.")
 
+        requested_total_time = self.epanet_api.getTimeSimulationDuration()
         requested_time_step = self.epanet_api.getTimeHydraulicStep()
         reporting_time_start = self.epanet_api.getTimeReportingStart()
         reporting_time_step = self.epanet_api.getTimeReportingStep()
@@ -2424,7 +2432,7 @@ class ScenarioSimulator():
                     if abort is True:
                         break
 
-                yield data
+                yield (data, total_time < requested_total_time)
 
             # Next
             tstep = self.epanet_api.api.ENstepQ()
@@ -2471,10 +2479,10 @@ class ScenarioSimulator():
 
         # Run hydraulic simulation step-by-step
         gen = self.run_hydraulic_simulation_as_generator
-        for scada_data in gen(hyd_export=hyd_export,
-                              verbose=verbose,
-                              return_as_dict=True,
-                              frozen_sensor_config=frozen_sensor_config):
+        for scada_data, _ in gen(hyd_export=hyd_export,
+                                 verbose=verbose,
+                                 return_as_dict=True,
+                                 frozen_sensor_config=frozen_sensor_config):
             if result is None:
                 result = {}
                 for data_type, data in scada_data.items():
@@ -2499,7 +2507,7 @@ class ScenarioSimulator():
                                               support_abort: bool = False,
                                               return_as_dict: bool = False,
                                               frozen_sensor_config: bool = False,
-                                              ) -> Generator[Union[ScadaData, dict], bool, None]:
+                                              ) -> Generator[Union[tuple[ScadaData, bool], tuple[dict, bool]], bool, None]:
         """
         Runs the hydraulic simulation of this scenario (incl. basic quality if set) and
         provides the results as a generator.
@@ -2540,7 +2548,7 @@ class ScenarioSimulator():
         -------
         :class:`~epyt_flow.simulation.scada.scada_data.ScadaData`
             Generator with the current simulation results/states as SCADA data
-            (i.e. sensor readings).
+            (i.e. sensor readings) and a boolean indicating whether the simulation terminated or not.
         """
         if self.__running_simulation is True:
             raise RuntimeError("A simulation is already running.")
@@ -2556,6 +2564,7 @@ class ScenarioSimulator():
         self.epanet_api.initializeHydraulicAnalysis(ToolkitConstants.EN_SAVE)
         self.epanet_api.initializeQualityAnalysis(ToolkitConstants.EN_SAVE)
 
+        requested_total_time = self.epanet_api.getTimeSimulationDuration()
         requested_time_step = self.epanet_api.getTimeHydraulicStep()
         reporting_time_start = self.epanet_api.getTimeReportingStart()
         reporting_time_step = self.epanet_api.getTimeReportingStep()
@@ -2655,7 +2664,7 @@ class ScenarioSimulator():
                         if abort is True:
                             break
 
-                    yield data
+                    yield (data, total_time < requested_total_time)
 
                 # Apply control modules
                 for control in self._custom_controls:

{epyt_flow-0.12.0 → epyt_flow-0.13.0}/epyt_flow/uncertainty/sensor_noise.py

@@ -3,7 +3,6 @@ Module provides a class for implementing sensor noise (e.g. uncertainty in senso
 """
 from typing import Optional, Callable
 from copy import deepcopy
-import warnings
 import numpy
 from numpy.random import default_rng
 
@@ -32,18 +31,12 @@ class SensorNoise(JsonSerializable):
 
         The default is None.
     """
-    def __init__(self, uncertainty: Optional[Uncertainty] = None,
-                 global_uncertainty: Optional[Uncertainty] = None,
+    def __init__(self, global_uncertainty: Optional[Uncertainty] = None,
                  local_uncertainties: Optional[dict[int, str, Uncertainty]] = None,
                  seed: Optional[int] = None,
                  **kwds):
-        if uncertainty is not None:
-            global_uncertainty = uncertainty
-            warnings.warn("'uncertainty' is deprecated and will be removed in future releases. " +
-                          "Use 'global_uncertainty' instead")
-
         if not isinstance(global_uncertainty, Uncertainty):
-            raise TypeError("'uncertainty' must be an instance of " +
+            raise TypeError("'global_uncertainty' must be an instance of " +
                             "'epyt_flow.uncertainty.Uncertainty' but not of " +
                             f"'{type(global_uncertainty)}'")
         if local_uncertainties is not None:

{epyt_flow-0.12.0 → epyt_flow-0.13.0}/epyt_flow.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: epyt-flow
-Version: 0.12.0
+Version: 0.13.0
 Summary: EPyT-Flow -- EPANET Python Toolkit - Flow
 Author-email: André Artelt <aartelt@techfak.uni-bielefeld.de>, "Marios S. Kyriakou" <kiriakou.marios@ucy.ac.cy>, "Stelios G. Vrachimis" <vrachimis.stelios@ucy.ac.cy>
 License-Expression: MIT

epyt_flow-0.12.0/epyt_flow/VERSION

@@ -1 +0,0 @@
-0.12.0