epyt-flow 0.13.0__py3-none-any.whl → 0.14.0__py3-none-any.whl

epyt_flow/EPANET/compile_macos.sh

@@ -1,4 +1,4 @@
 #!/bin/bash
 mkdir -p "../customlibs/"
-gcc-12 -w -O3 -march=native -dynamiclib -fPIC -install_name libepanet2_2.dylib -o "../customlibs/libepanet2_2.dylib" EPANET/SRC_engines/*.c -IEPANET/SRC_engines/include -lc -lm -pthread
-gcc-12 -w -O3 -march=native -dynamiclib -fPIC -install_name libepanetmsx2_2_0.dylib -o "../customlibs/libepanetmsx2_2_0.dylib" -fopenmp -Depanetmsx_EXPORTS -IEPANET-MSX/Src/include -IEPANET/SRC_engines/include EPANET-MSX/Src/*.c -L'../customlibs' -lepanet2_2 -lm -lgomp -lpthread
+gcc-15 -w -O3 -march=native -dynamiclib -fPIC -install_name libepanet2_2.dylib -o "../customlibs/libepanet2_2.dylib" EPANET/SRC_engines/*.c -IEPANET/SRC_engines/include -lc -lm -pthread
+gcc-15 -w -O3 -march=native -dynamiclib -fPIC -install_name libepanetmsx2_2_0.dylib -o "../customlibs/libepanetmsx2_2_0.dylib" -fopenmp -Depanetmsx_EXPORTS -IEPANET-MSX/Src/include -IEPANET/SRC_engines/include EPANET-MSX/Src/*.c -L'../customlibs' -lepanet2_2 -lm -lgomp -lpthread

epyt_flow/VERSION

@@ -1 +1 @@
-0.13.0
+0.14.0

epyt_flow/__init__.py

@@ -39,4 +39,4 @@ def compile_libraries_unix(lib_epanet_name: str, compile_script_name: str,
 if sys.platform.startswith("linux"):
     compile_libraries_unix("libepanet2_2.so", "compile_linux.sh")
 elif sys.platform.startswith("darwin"):
-    compile_libraries_unix("libepanet2_2.dylib", "compile_macos.sh", gcc_name="gcc-12")
+    compile_libraries_unix("libepanet2_2.dylib", "compile_macos.sh", gcc_name="gcc-15")

epyt_flow/simulation/backend/my_epyt.py

@@ -1,6 +1,7 @@
 """
 This module contains a wrapper for EPyT that allows a better error/warning handling.
 """
+import warnings
 from ctypes import byref, create_string_buffer
 from epyt import epanet
 from epyt.epanet import epanetapi, epanetmsxapi
@@ -30,6 +31,10 @@ class EPyT(epanet):
         self.LibEPANETpath = self.api.LibEPANETpath
         self.LibEPANET = self.api.LibEPANET
 
+    def _logFunctionError(self, function_name):
+        # Do not print warnings.
+        pass
+
     def loadMSXFile(self, msxname, customMSXlib=None, ignore_properties=False):
         super().loadMSXFile(msxname, customMSXlib, ignore_properties)
 
@@ -40,17 +45,25 @@ class EPyT(epanet):
                                   msxrealfile=self.MSXFile)
         return self.msx
 
-    def set_error_handling(self, raise_exception_on_error: bool) -> None:
+    def set_error_handling(self, raise_exception_on_error: bool, warn_on_error: bool,
+                           ignore_error_codes: list[int]) -> None:
         """
         Specifies the behavior in the case of an error/warning --
-        i.e. should an exception be raised or not?
+        i.e. should an exception or warning be raised or not?
 
         Parameters
         ----------
         raise_exception_on_error : `bool`
             True if an exception should be raise, False otherwise.
+        warn_on_error : `bool`
+            True if a warning should be generated, False otherwise.
+        ignore_error_codes : `list[int]`
+            List of error codes that should be ignored -- i.e., no exception or
+            warning will be generated.
         """
-        self.api.set_error_handling(raise_exception_on_error)
+        self.api.set_error_handling(raise_exception_on_error, warn_on_error, ignore_error_codes)
+        if self.msx is not None:
+            self.msx.set_error_handling(raise_exception_on_error, warn_on_error, ignore_error_codes)
 
     def was_last_func_successful(self) -> bool:
         """
@@ -96,24 +109,39 @@ class MyEpanetMsxAPI(epanetmsxapi):
     Wrapper for the `epyt.epanet.epanetmsxapi <https://epanet-python-toolkit-epyt.readthedocs.io/en/latest/api.html#epyt.epanet.epanetmsxapi>`_
     class adding error/warning storage functionalities.
     """
-    def __init__(self, raise_on_error: bool = True, **kwds):
+    def __init__(self, raise_on_error: bool = True, warn_on_error: bool = False,
+                 ignore_error_codes: list[int] = [], **kwds):
         self.__raise_on_error = raise_on_error
+        self.__warn_on_error = warn_on_error
+        self.__ignore_error_codes = ignore_error_codes
         self.__last_error_code = None
         self.__last_error_desc = None
 
         super().__init__(**kwds)
 
-    def set_error_handling(self, raise_on_error: bool) -> None:
+    def _logFunctionError(self, function_name):
+        # Do not print warnings.
+        pass
+
+    def set_error_handling(self, raise_on_error: bool, warn_on_error: bool,
+                           ignore_error_codes: list[int] = []) -> None:
         """
         Specifies the behavior in the case of an error/warning --
-        i.e. should an exception be raised or not?
+        i.e. should an exception or warning be raised or not?
 
         Parameters
         ----------
         raise_exception_on_error : `bool`
             True if an exception should be raise, False otherwise.
+        warn_on_error : `bool`
+            True if a warning should be generated, False otherwise.
+        ignore_error_codes : `list[int]`
+            List of error codes that should be ignored -- i.e., no exception or
+            warning will be generated.
         """
         self.__raise_on_error = raise_on_error
+        self.__warn_on_error = warn_on_error
+        self.__ignore_error_codes = ignore_error_codes
 
     def get_last_error_desc(self) -> str:
         """
@@ -161,8 +189,11 @@ class MyEpanetMsxAPI(epanetmsxapi):
         self.__last_error_code = err_code
         self.__last_error_desc = error_desc.value.decode()
 
-        if self.__raise_on_error:
-            raise RuntimeError(self.__last_error_desc)
+        if self.__last_error_code not in self.__ignore_error_codes:
+            if self.__warn_on_error:
+                warnings.warn(self.__last_error_desc, RuntimeWarning)
+            if self.__raise_on_error:
+                raise RuntimeError(self.__last_error_desc)
 
     def MSXopen(self, msxfile, msxrealfile):
         self._reset_error()
@@ -286,24 +317,35 @@ class MyEpanetAPI(epanetapi):
     Wrapper for the `epyt.epanet.epanetapi <https://epanet-python-toolkit-epyt.readthedocs.io/en/latest/api.html#epyt.epanet.epanetapi>`_
     class adding error/warning storage functionalities.
     """
-    def __init__(self, raise_on_error: bool = True, **kwds):
+    def __init__(self, raise_on_error: bool = True, warn_on_error: bool = False,
+                 ignore_error_codes: list[int] = [], **kwds):
         self.__raise_on_error = raise_on_error
+        self.__warn_on_error = warn_on_error
+        self.__ignore_error_codes = ignore_error_codes
         self.__last_error_code = None
         self.__last_error_desc = None
 
         super().__init__(**kwds)
 
-    def set_error_handling(self, raise_on_error: bool) -> None:
+    def set_error_handling(self, raise_on_error: bool, warn_on_error: bool,
+                           ignore_error_codes: list[int] = []) -> None:
         """
         Specifies the behavior in the case of an error/warning --
-        i.e. should an exception be raised or not?
+        i.e. should an exception or warning be raised or not?
 
         Parameters
         ----------
         raise_exception_on_error : `bool`
             True if an exception should be raise, False otherwise.
+        warn_on_error : `bool`
+            True if a warning should be generated, False otherwise.
+        ignore_error_codes : `list[int]`
+            List of error codes that should be ignored -- i.e., no exception or
+            warning will be generated.
         """
         self.__raise_on_error = raise_on_error
+        self.__warn_on_error = warn_on_error
+        self.__ignore_error_codes = ignore_error_codes
 
     def get_last_error_desc(self) -> str:
         """
@@ -353,8 +395,11 @@ class MyEpanetAPI(epanetapi):
             self.__last_error_code = self.errcode
             self.__last_error_desc = error_desc.value.decode()
 
-            if self.__raise_on_error:
-                raise RuntimeError(self.__last_error_desc)
+            if self.__last_error_code not in self.__ignore_error_codes:
+                if self.__warn_on_error:
+                    warnings.warn(self.__last_error_desc, RuntimeWarning)
+                if self.__raise_on_error:
+                    raise RuntimeError(self.__last_error_desc)
 
     def ENepanet(self, inpfile="", rptfile="", binfile=""):
         self._reset_error()

epyt_flow/simulation/scada/scada_data.py

@@ -167,9 +167,7 @@ class ScadaData(Serializable):
             raise TypeError("'sensor_readings_time' must be an instance of 'numpy.ndarray' " +
                             f"but not of '{type(sensor_readings_time)}'")
         if warnings_code is None:
-            warnings.warn("Loading a file that was created with an outdated version of EPyT-Flow" +
-                          " -- support of such old files will be removed in the next release!",
-                          DeprecationWarning)
+            warnings_code = [0] * len(sensor_readings_time)
         else:
             if not isinstance(warnings_code, np.ndarray):
                 raise TypeError("'warnings_code' must be an instance of 'numpy.ndarray' " +
@@ -376,6 +374,8 @@ class ScadaData(Serializable):
         self.__sensor_readings = None
         self.__frozen_sensor_config = frozen_sensor_config
         self.__sensor_readings_time = sensor_readings_time
+        self.__sensor_readings_time_to_idx = {time: idx for idx, time in
+                                              enumerate(self.__sensor_readings_time)}
 
         if self.__frozen_sensor_config is False:
             self.__pressure_data_raw = pressure_data_raw
@@ -1748,8 +1748,8 @@ class ScadaData(Serializable):
         else:
             end_time = self.__sensor_readings_time[-1]
 
-        start_idx = self.__sensor_readings_time.tolist().index(start_time)
-        end_idx = self.__sensor_readings_time.tolist().index(end_time) + 1
+        start_idx = self.__sensor_readings_time_to_idx[start_time]
+        end_idx = self.__sensor_readings_time_to_idx[end_time] + 1
 
         pressure_data_raw = None
         if self.__pressure_data_raw is not None:
@@ -2375,11 +2375,10 @@ class ScadaData(Serializable):
         mask = np.zeros(len(self.__sensor_config.nodes))
         node_features = np.array([[default_missing_value] * len(self.__sensor_config.nodes)
                                   for _ in range(len(self.__sensor_readings_time))])
-        nodes_id = self.__network_topo.get_all_nodes()
 
         pressure_readings = self.get_data_pressures()
         for pressures_idx, node_id in enumerate(self.__sensor_config.pressure_sensors):
-            idx = nodes_id.index(node_id)
+            idx = self.__sensor_config.map_node_id_to_idx(node_id)
             node_features[:, idx] = pressure_readings[:, pressures_idx]
             mask[idx] = 1
 
@@ -2617,11 +2616,10 @@ class ScadaData(Serializable):
         mask = np.zeros(len(self.__sensor_config.nodes))
         node_features = np.array([[default_missing_value] * len(self.__sensor_config.nodes)
                                   for _ in range(len(self.__sensor_readings_time))])
-        nodes_id = self.__network_topo.get_all_nodes()
 
         demand_readings = self.get_data_demands()
         for demands_idx, node_id in enumerate(self.__sensor_config.demand_sensors):
-            idx = nodes_id.index(node_id)
+            idx = self.__sensor_config.map_node_id_to_idx(node_id)
             node_features[:, idx] = demand_readings[:, demands_idx]
             mask[idx] = 1
 
@@ -2737,11 +2735,10 @@ class ScadaData(Serializable):
         mask = np.zeros(len(self.__sensor_config.nodes))
         node_features = np.array([[default_missing_value] * len(self.__sensor_config.nodes)
                                   for _ in range(len(self.__sensor_readings_time))])
-        nodes_id = self.__network_topo.get_all_nodes()
 
         node_quality_readings = self.get_data_nodes_quality()
         for quality_idx, node_id in enumerate(self.__sensor_config.quality_node_sensors):
-            idx = nodes_id.index(node_id)
+            idx = self.__sensor_config.map_node_id_to_idx(node_id)
             node_features[:, idx] = node_quality_readings[:, quality_idx]
             mask[idx] = 1
 
@@ -3752,7 +3749,6 @@ class ScadaData(Serializable):
         masks = []
         results = []
 
-        all_nodes_id = self.__network_topo.get_all_nodes()
         bulk_species_sensor_locations = self.__sensor_config.bulk_species_node_sensors
 
         for species_id, nodes_id in bulk_species_sensor_locations.items():
@@ -3762,7 +3758,7 @@ class ScadaData(Serializable):
             
             sensor_readings = self.get_data_bulk_species_node_concentration({species_id: nodes_id})
             for sensor_readings_idx, node_id in enumerate(nodes_id):
-                idx = all_nodes_id.index(node_id) 
+                idx = self.__sensor_config.map_node_id_to_idx(node_id) 
                 node_features[:, idx] = sensor_readings[:, sensor_readings_idx]
                 mask[idx] = 1
 

epyt_flow/simulation/scenario_simulator.py

@@ -59,6 +59,20 @@ class ScenarioSimulator():
         If True, EPyT is verbose and might print messages from time to time.
 
         The default is False.
+    raise_exception_on_error : `bool`, optional
+        If True, an exception is raised whenever an error occurs in EPANET or EPANET-MSX.
+
+        The default is False.
+    warn_on_error : `bool`, optional
+        If True, a warning is generated whenever an error occurs in EPANET or EPANET-MSX.
+
+        The default is True.
+    ignore_error_codes : `list[int]`, optional
+        List of error codes that should be ignored -- i.e., no exception or
+        warning will be generated.
+        However, error codes will still be included in the SCADA data.
+
+        The default is [].
 
     Attributes
     ----------
@@ -83,7 +97,9 @@ class ScenarioSimulator():
     """
 
     def __init__(self, f_inp_in: str = None, f_msx_in: str = None,
-                 scenario_config: ScenarioConfig = None, epanet_verbose: bool = False):
+                 scenario_config: ScenarioConfig = None, epanet_verbose: bool = False,
+                 raise_exception_on_error: bool = False, warn_on_error: bool = True,
+                 ignore_error_codes: list[int] = []):
         if f_msx_in is not None and f_inp_in is None:
             raise ValueError("'f_inp_in' must be set if 'f_msx_in' is set.")
         if f_inp_in is None and scenario_config is None:
@@ -118,6 +134,7 @@ class ScenarioSimulator():
         self._system_events = []
         self._sensor_reading_events = []
         self.__running_simulation = False
+        self.__uncertainties_applied = False
 
         # Check availability of custom EPANET libraries
         custom_epanet_lib = None
@@ -176,7 +193,9 @@ class ScenarioSimulator():
             self.epanet_api.loadMSXFile(my_f_msx_in, customMSXlib=custom_epanetmsx_lib)
 
         # Do not raise exceptions in the case of EPANET warnings and errors
-        self.epanet_api.set_error_handling(False)
+        self.epanet_api.set_error_handling(raise_exception_on_error=raise_exception_on_error,
+                                           warn_on_error=warn_on_error,
+                                           ignore_error_codes=ignore_error_codes)
 
         # Parse and initialize scenario
         self._simple_controls = self._parse_simple_control_rules()
@@ -1943,11 +1962,13 @@ class ScenarioSimulator():
         """
         self._sensor_config.place_sensors_everywhere()
 
-    def _prepare_simulation(self) -> None:
+    def _prepare_simulation(self, reapply_uncertainties: bool = False) -> None:
         self._adapt_to_network_changes()
 
         if self._model_uncertainty is not None:
-            self._model_uncertainty.apply(self.epanet_api)
+            if self.__uncertainties_applied is True and reapply_uncertainties is True:
+                self._model_uncertainty.apply(self.epanet_api)
+                self.__uncertainties_applied = True
 
         for event in self._system_events:
             event.reset()
@@ -1958,7 +1979,8 @@ class ScenarioSimulator():
 
     def run_advanced_quality_simulation(self, hyd_file_in: str, verbose: bool = False,
                                         frozen_sensor_config: bool = False,
-                                        use_quality_time_step_as_reporting_time_step: bool = False
+                                        use_quality_time_step_as_reporting_time_step: bool = False,
+                                        reapply_uncertainties: bool = False
                                         ) -> ScadaData:
         """
         Runs an advanced quality analysis using EPANET-MSX.
@@ -1983,6 +2005,10 @@ class ScenarioSimulator():
             As a consequence, the simualtion results can not be merged
             with the hydraulic simulation.
 
+            The default is False.
+        reapply_uncertainties: bool = False : `bool`, optional
+            If True, the uncertainties are re-applied.
+
             The default is False.
 
         Returns
@@ -2004,7 +2030,8 @@ class ScenarioSimulator():
                                  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):
+                                 use_quality_time_step_as_reporting_time_step,
+                                 reapply_uncertainties=reapply_uncertainties):
             if result is None:
                 result = {}
                 for data_type, data in scada_data.items():
@@ -2032,6 +2059,7 @@ class ScenarioSimulator():
                                                      return_as_dict: bool = False,
                                                      frozen_sensor_config: bool = False,
                                                      use_quality_time_step_as_reporting_time_step: bool = False,
+                                                     reapply_uncertainties: bool = False
                                                      ) -> Generator[Union[tuple[ScadaData, bool], tuple[dict, bool]], bool, None]:
         """
         Runs an advanced quality analysis using EPANET-MSX.
@@ -2060,6 +2088,10 @@ class ScenarioSimulator():
             As a consequence, the simualtion results can not be merged
             with the hydraulic simulation.
 
+            The default is False.
+        reapply_uncertainties: bool = False : `bool`, optional
+            If True, the uncertainties are re-applied.
+
             The default is False.
 
         Returns
@@ -2074,6 +2106,8 @@ class ScenarioSimulator():
         if self.__f_msx_in is None:
             raise ValueError("No .msx file specified")
 
+        self._prepare_simulation(reapply_uncertainties)
+
         # Load pre-computed hydraulics
         self.epanet_api.useMSXHydraulicFile(hyd_file_in)
 
@@ -2171,12 +2205,14 @@ class ScenarioSimulator():
                 pass
 
         if reporting_time_start == 0:
+            msx_error_code = self.epanet_api.msx.get_last_error_code()
+
             if return_as_dict is True:
                 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]),
-                        "warnings_code": np.array([0]) # TODO: Replace with MSX error
+                        "warnings_code": np.array([msx_error_code])
                         }
             else:
                 data = ScadaData(network_topo=network_topo, sensor_config=self._sensor_config,
@@ -2184,7 +2220,7 @@ class ScenarioSimulator():
                                  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
+                                 warnings_code=np.array([msx_error_code]),
                                  sensor_reading_events=self._sensor_reading_events,
                                  sensor_noise=self._sensor_noise,
                                  frozen_sensor_config=frozen_sensor_config)
@@ -2199,9 +2235,13 @@ class ScenarioSimulator():
         # Run step-by-step simulation
         tleft = 1
         total_time = 0
+        last_msx_error_code = 0
         while tleft > 0:
             # Compute current time step
             total_time, tleft = self.epanet_api.stepMSXQualityAnalysisTimeLeft()
+            msx_error_code = self.epanet_api.msx.get_last_error_code()
+            if last_msx_error_code == 0:
+                last_msx_error_code = msx_error_code
 
             # Fetch data at regular time intervals
             if total_time % hyd_time_step == 0:
@@ -2223,7 +2263,7 @@ class ScenarioSimulator():
                                     bulk_species_link_concentrations,
                                 "surface_species_concentration_raw": surface_species_concentrations,
                                 "sensor_readings_time": np.array([total_time]),
-                                "warnings_code": np.array([0]), # TODO: Replace with MSX error
+                                "warnings_code": np.array([last_msx_error_code]),
                                 }
                     else:
                         data = ScadaData(network_topo=network_topo,
@@ -2235,7 +2275,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
+                                         warnings_code=np.array([last_msx_error_code]),
                                          sensor_reading_events=self._sensor_reading_events,
                                          sensor_noise=self._sensor_noise,
                                          frozen_sensor_config=frozen_sensor_config)
@@ -2388,6 +2428,7 @@ class ScenarioSimulator():
         total_time = 0
         tstep = 1
         first_itr = True
+        last_error_code = 0
         while tstep > 0:
             if first_itr is True:  # Fix current time in the first iteration
                 tstep = 0
@@ -2406,6 +2447,8 @@ class ScenarioSimulator():
 
             # Fetch data
             error_code = self.epanet_api.get_last_error_code()
+            if last_error_code == 0:
+                last_error_code = error_code
             quality_node_data = self.epanet_api.getNodeActualQuality().reshape(1, -1)
             quality_link_data = self.epanet_api.getLinkActualQuality().reshape(1, -1)
 
@@ -2415,14 +2458,14 @@ class ScenarioSimulator():
                     data = {"node_quality_data_raw": quality_node_data,
                             "link_quality_data_raw": quality_link_data,
                             "sensor_readings_time": np.array([total_time]),
-                            "warnings_code": np.array([error_code])}
+                            "warnings_code": np.array([last_error_code])}
                 else:
                     data = ScadaData(network_topo=network_topo,
                                      sensor_config=self._sensor_config,
                                      node_quality_data_raw=quality_node_data,
                                      link_quality_data_raw=quality_link_data,
                                      sensor_readings_time=np.array([total_time]),
-                                     warnings_code=np.array([error_code]),
+                                     warnings_code=np.array([last_error_code]),
                                      sensor_reading_events=self._sensor_reading_events,
                                      sensor_noise=self._sensor_noise,
                                      frozen_sensor_config=frozen_sensor_config)
@@ -2432,15 +2475,19 @@ class ScenarioSimulator():
                     if abort is True:
                         break
 
-                yield (data, total_time < requested_total_time)
+                yield (data, total_time >= requested_total_time)
 
             # Next
             tstep = self.epanet_api.api.ENstepQ()
+            error_code = self.epanet_api.get_last_error_code()
+            if last_error_code == 0:
+                last_error_code = error_code
 
         self.epanet_api.closeQualityAnalysis()
 
     def run_hydraulic_simulation(self, hyd_export: str = None, verbose: bool = False,
-                                 frozen_sensor_config: bool = False) -> ScadaData:
+                                 frozen_sensor_config: bool = False,
+                                 reapply_uncertainties: bool = False) -> ScadaData:
         """
         Runs the hydraulic simulation of this scenario (incl. basic quality if set).
 
@@ -2463,6 +2510,10 @@ class ScenarioSimulator():
             If True, the sensor config can not be changed and only the required sensor nodes/links
             will be stored -- this usually leads to a significant reduction in memory consumption.
 
+            The default is False.
+        reapply_uncertainties: bool = False : `bool`, optional
+            If True, the uncertainties are re-applied.
+
             The default is False.
 
         Returns
@@ -2482,7 +2533,8 @@ class ScenarioSimulator():
         for scada_data, _ in gen(hyd_export=hyd_export,
                                  verbose=verbose,
                                  return_as_dict=True,
-                                 frozen_sensor_config=frozen_sensor_config):
+                                 frozen_sensor_config=frozen_sensor_config,
+                                 reapply_uncertainties=reapply_uncertainties):
             if result is None:
                 result = {}
                 for data_type, data in scada_data.items():
@@ -2507,6 +2559,7 @@ class ScenarioSimulator():
                                               support_abort: bool = False,
                                               return_as_dict: bool = False,
                                               frozen_sensor_config: bool = False,
+                                              reapply_uncertainties: bool = False
                                               ) -> Generator[Union[tuple[ScadaData, bool], tuple[dict, bool]], bool, None]:
         """
         Runs the hydraulic simulation of this scenario (incl. basic quality if set) and
@@ -2542,6 +2595,10 @@ class ScenarioSimulator():
             If True, the sensor config can not be changed and only the required sensor nodes/links
             will be stored -- this usually leads to a significant reduction in memory consumption.
 
+            The default is False.
+        reapply_uncertainties: bool = False : `bool`, optional
+            If True, the uncertainties are re-applied.
+
             The default is False.
 
         Returns
@@ -2555,7 +2612,7 @@ class ScenarioSimulator():
 
         self._adapt_to_network_changes()
 
-        self._prepare_simulation()
+        self._prepare_simulation(reapply_uncertainties)
 
         self.__running_simulation = True
 
@@ -2582,6 +2639,7 @@ class ScenarioSimulator():
             total_time = 0
             tstep = 1
             first_itr = True
+            last_error_code = 0
             while tstep > 0:
                 if first_itr is True:  # Fix current time in the first iteration
                     tstep = 0
@@ -2606,6 +2664,8 @@ class ScenarioSimulator():
                 if error_code == 0:
                     error_code = self.epanet_api.get_last_error_code()
                 total_time = t
+                if last_error_code == 0:
+                    last_error_code = error_code
 
                 # Fetch data
                 pressure_data = self.epanet_api.getNodePressure().reshape(1, -1)
@@ -2636,7 +2696,7 @@ class ScenarioSimulator():
                                        pumps_energy_usage_data_raw=pumps_energy_usage_data,
                                        pumps_efficiency_data_raw=pumps_efficiency_data,
                                        sensor_readings_time=np.array([total_time]),
-                                       warnings_code=np.array([error_code]),
+                                       warnings_code=np.array([last_error_code]),
                                        sensor_reading_events=self._sensor_reading_events,
                                        sensor_noise=self._sensor_noise,
                                        frozen_sensor_config=frozen_sensor_config)
@@ -2655,16 +2715,18 @@ class ScenarioSimulator():
                                 "pumps_energy_usage_data_raw": pumps_energy_usage_data,
                                 "pumps_efficiency_data_raw": pumps_efficiency_data,
                                 "sensor_readings_time": np.array([total_time]),
-                                "warnings_code": np.array([error_code])}
+                                "warnings_code": np.array([last_error_code])}
                     else:
                         data = scada_data
 
+                    last_error_code = 0
+
                     if support_abort is True:  # Can the simulation be aborted? If so, handle it.
                         abort = yield
                         if abort is True:
                             break
 
-                    yield (data, total_time < requested_total_time)
+                    yield (data, total_time >= requested_total_time)
 
                 # Apply control modules
                 for control in self._custom_controls:
@@ -2672,7 +2734,14 @@ class ScenarioSimulator():
 
                 # Next
                 tstep = self.epanet_api.api.ENnextH()
+                error_code = self.epanet_api.get_last_error_code()
+                if last_error_code == 0:
+                    last_error_code = error_code
+
                 self.epanet_api.api.ENnextQ()
+                error_code = self.epanet_api.get_last_error_code()
+                if last_error_code == 0:
+                    last_error_code = error_code
 
             self.epanet_api.api.ENcloseQ()
             self.epanet_api.api.ENcloseH()
@@ -2686,7 +2755,8 @@ class ScenarioSimulator():
             raise ex
 
     def run_simulation(self, hyd_export: str = None, verbose: bool = False,
-                       frozen_sensor_config: bool = False) -> ScadaData:
+                       frozen_sensor_config: bool = False,
+                       reapply_uncertainties: bool = False) -> ScadaData:
         """
         Runs the simulation of this scenario.
 
@@ -2707,6 +2777,10 @@ class ScenarioSimulator():
             If True, the sensor config can not be changed and only the required sensor nodes/links
             will be stored -- this usually leads to a significant reduction in memory consumption.
 
+            The default is False.
+        reapply_uncertainties: bool = False : `bool`, optional
+            If True, the uncertainties are re-applied.
+
             The default is False.
 
         Returns
@@ -2727,14 +2801,16 @@ class ScenarioSimulator():
 
         # Run hydraulic simulation step-by-step
         result = self.run_hydraulic_simulation(hyd_export=hyd_export, verbose=verbose,
-                                               frozen_sensor_config=frozen_sensor_config)
+                                               frozen_sensor_config=frozen_sensor_config,
+                                               reapply_uncertainties=reapply_uncertainties)
 
         # If necessary, run advanced quality simulation utilizing the computed hydraulics
         if self.f_msx_in is not None:
             gen = self.run_advanced_quality_simulation
             result_msx = gen(hyd_file_in=hyd_export,
                              verbose=verbose,
-                             frozen_sensor_config=frozen_sensor_config)
+                             frozen_sensor_config=frozen_sensor_config,
+                             reapply_uncertainties=reapply_uncertainties)
             result.join(result_msx)
 
             if hyd_export_old is not None:
@@ -2768,6 +2844,7 @@ class ScenarioSimulator():
                             f"'{type(model_uncertainty)}'")
 
         self._model_uncertainty = model_uncertainty
+        self.__uncertainties_applied = False
 
     def set_sensor_noise(self, sensor_noise: SensorNoise) -> None:
         """

epyt_flow/uncertainty/uncertainties.py

@@ -126,9 +126,9 @@ class Uncertainty(ABC):
             Clipped data.
         """
         if self.__min_value is not None:
-            data = np.min([data, self.__min_value])
+            data = np.max([data, self.__min_value])
         if self.__max_value is not None:
-            data = np.max([data, self.__max_value])
+            data = np.min([data, self.__max_value])
 
         return data
 

{epyt_flow-0.13.0.dist-info → epyt_flow-0.14.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: epyt-flow
-Version: 0.13.0
+Version: 0.14.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
@@ -85,12 +85,12 @@ By this, we not only aim to achieve a better performance of the simulations but
 compatibility issues of pre-compiled binaries.
 
 #### Prerequisites for macOS users
-The "true" *gcc* compiler (version 12) is needed which is not the
+The "true" *gcc* compiler (version 15) is needed which is not the
 *clang* compiler that is shipped with Xcode and is linked to gcc!
 
 The correct version of the "true" *gcc* can be installed via [brew](https://brew.sh/):
 ```
-brew install gcc@12
+brew install gcc@15
 ```
 
 ### PyPI

{epyt_flow-0.13.0.dist-info → epyt_flow-0.14.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
-epyt_flow/VERSION,sha256=2EyeWWx9apTl90V5742JEqgHsNKFgkdJAK0137Pt_PQ,7
-epyt_flow/__init__.py,sha256=n-zI5G3DUofs_pNC5YNWopNPCPUtpL-jYi8RPH6eakw,1768
+epyt_flow/VERSION,sha256=BlWCZVqs1vyD_3QqVxXAS7Slc5W_PuRVl5j6QsLORYk,7
+epyt_flow/__init__.py,sha256=wktX10SXX9GEamDUWR-tcm-8T4d5s6j6aPYr_x4EpOc,1768
 epyt_flow/serialization.py,sha256=uGGN1iZ21ek1u6Xzs4z2xum5Qt8554Wem-wEMGEaa7I,14574
 epyt_flow/topology.py,sha256=Ih6m_tMT1JlPOJv8rHDVBtNayFOarPyAmCbMyojJtQg,26037
 epyt_flow/utils.py,sha256=R_IE6uuTF2MRjUkgWDEa3xOYk8iorieHCqqQ0tDUZ40,17476
 epyt_flow/EPANET/compile_linux.sh,sha256=wcrDyiB8NkivmaC-X9FI2WxhY3IJqDLiyIbVTv2XEPY,489
-epyt_flow/EPANET/compile_macos.sh,sha256=1K33-bPdgr01EIf87YUvmOFHXyOkBWI6mKXQ8x1Hzmo,504
+epyt_flow/EPANET/compile_macos.sh,sha256=JfXkCDe5OHhNXgukU13_ViCsD7KPV8qClzSXGLH1HVk,504
 epyt_flow/EPANET/EPANET/SRC_engines/AUTHORS,sha256=yie5yAsEEPY0984PmkSRUdqEU9rVvRSGGWmjxdwCYMU,925
 epyt_flow/EPANET/EPANET/SRC_engines/LICENSE,sha256=8SIIcPPO-ga2HotvptcK3uRccZOEGCeUOIU0Asiq7CU,1070
 epyt_flow/EPANET/EPANET/SRC_engines/Readme_SRC_Engines.txt,sha256=7LWHGbghkYJb18wkIskUzYswRq0ZTMu_m6nV0IfvCOs,1005
@@ -108,10 +108,10 @@ epyt_flow/rest_api/scenario/uncertainty_handlers.py,sha256=Pdo2YmiawOqKXWcLs2P-l
 epyt_flow/simulation/__init__.py,sha256=nihvZ8O2rJjYQkv7JhtVMqNacO5bA38VtS8Y_0BWrVQ,129
 epyt_flow/simulation/parallel_simulation.py,sha256=ph4KXw9jCt-hiJFJbmC6fNvEsrbQoWV-tFKE5-qSfoQ,6523
 epyt_flow/simulation/scenario_config.py,sha256=uHHwwzCRwooVdODxDNoCOUgfrlol1K-TS8P8_Ja9Coc,30435
-epyt_flow/simulation/scenario_simulator.py,sha256=AhsMh3KcVRmhqqRgwH3WU26YqUvJuTZbNKxsRYwDukA,161461
+epyt_flow/simulation/scenario_simulator.py,sha256=pEHpV_HJkgwPmnPlvBzJCAXaTNIBBRIVmTdkopcgxEc,165155
 epyt_flow/simulation/sensor_config.py,sha256=AGAIC5vqcu2UZsglSCwv2pvZ3E0kbTtdaqtFPEMBwSw,94262
 epyt_flow/simulation/backend/__init__.py,sha256=tkJb2NB_hruTv39sYHAq9ffazyA-UzZzFmiy2nYVTqA,23
-epyt_flow/simulation/backend/my_epyt.py,sha256=edkhDDOZBtYSpaQmnui_opdetebaS9ZzBwngnIpkc3s,32040
+epyt_flow/simulation/backend/my_epyt.py,sha256=9zcHUo-shPuUNewsuxFpbBgtAbbTu7ppSaK6x4Xgt50,34414
 epyt_flow/simulation/events/__init__.py,sha256=gv8ZcvwjJN0Z5MwRXEOVFRNq4X5NPyyqXIQnhBxszQ0,215
 epyt_flow/simulation/events/actuator_events.py,sha256=gNOIZL9WNiIhEANi8yEyGxKx4vSMBZiRpiSJ4BbDL60,8171
 epyt_flow/simulation/events/event.py,sha256=kARPV20XCAl6zxnJwI9U7ICtZUPACO_rgAmtHm1mGCs,2603
@@ -124,19 +124,19 @@ epyt_flow/simulation/events/system_event.py,sha256=IGypfTL-miosmwKd4DGTYvByyBcl8
 epyt_flow/simulation/scada/__init__.py,sha256=pfJhg-tM5DaiZTXs0_1qJsY2R6Py_LwSz6BUFJexfQM,150
 epyt_flow/simulation/scada/complex_control.py,sha256=p2ehLyScJbj2jbyevXf7T3Ot8jnBYWgRR3Cz-m3boB0,22107
 epyt_flow/simulation/scada/custom_control.py,sha256=QzkKcn7t53GcTaRofRDbY-HErcDReMF4utWkck6bN60,4681
-epyt_flow/simulation/scada/scada_data.py,sha256=vzhTUoUIdmqTj9rP2w00q1dAaT90rY5vY2S6Sgo04jg,203434
+epyt_flow/simulation/scada/scada_data.py,sha256=fzcy35rSwoTcIsZpda9JOU17SpR-cV4DZ1tb6qFGpEc,203267
 epyt_flow/simulation/scada/scada_data_export.py,sha256=WNAFn_WNfzYAEFbl2Al-cOIx-A0ozY4AI60-i_qEHdc,11643
 epyt_flow/simulation/scada/simple_control.py,sha256=wUsxsrgqmYxXR93_atcKbV9E-t3hgqj60ZeTvoBBnoQ,12215
 epyt_flow/uncertainty/__init__.py,sha256=ZRjuJL9rDpWVSdPwObPxFpEmMTcgAl3VmPOsS6cIyGg,89
 epyt_flow/uncertainty/model_uncertainty.py,sha256=Bfc9OgecJbX2qOiANhTSKdK_m95aRuXkIGyc22b8d30,41183
 epyt_flow/uncertainty/sensor_noise.py,sha256=-AnBfuW1VAx7Ya-q_gJ9bAr7Kx6pzP_y0PvNeuRjXIg,6477
-epyt_flow/uncertainty/uncertainties.py,sha256=5bZu1Zx8RZ6ESzJSvjtPogNkft3eemTojRsYdi_i1Qo,20495
+epyt_flow/uncertainty/uncertainties.py,sha256=QBRbI3zIzkeFScyYD5Dy0TBxuL9jPV4SnVU8QwOrJq8,20495
 epyt_flow/uncertainty/utils.py,sha256=K-ZhyO6Bg7UmNPgpfND0JLa_wRwyrtUUgGTWyWwy-fo,8029
 epyt_flow/visualization/__init__.py,sha256=uQ7lO6AsgLc88X48Te3QhBQY-iDKGvdPtxKCl4b-Mfw,70
 epyt_flow/visualization/scenario_visualizer.py,sha256=vkP0J_OfjvePUz_HehXJkH4CGKR3chAHe_UTx4hQ6XI,57860
 epyt_flow/visualization/visualization_utils.py,sha256=l-EQ9UlY9MDBcOhK-uUZ9c-tX9emVqlo4xSqR-Sg17M,27525
-epyt_flow-0.13.0.dist-info/licenses/LICENSE,sha256=YRJC2kcAhMlpEeHwUF0lzE-GRXLFyAjXNErI8L5UwYk,1071
-epyt_flow-0.13.0.dist-info/METADATA,sha256=M-XauQzx0P0u0_vvNEMgsXybG5V64q2pLZTOkhfnzYU,9713
-epyt_flow-0.13.0.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-epyt_flow-0.13.0.dist-info/top_level.txt,sha256=Wh_kd7TRL8ownCw3Y3dxx-9C0iTSk6wNauv_NX9JcrY,10
-epyt_flow-0.13.0.dist-info/RECORD,,
+epyt_flow-0.14.0.dist-info/licenses/LICENSE,sha256=YRJC2kcAhMlpEeHwUF0lzE-GRXLFyAjXNErI8L5UwYk,1071
+epyt_flow-0.14.0.dist-info/METADATA,sha256=M7BM9VPwrVrFRzuBSVAFnimiOoPsCgjbiGiAjeSFw-A,9713
+epyt_flow-0.14.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+epyt_flow-0.14.0.dist-info/top_level.txt,sha256=Wh_kd7TRL8ownCw3Y3dxx-9C0iTSk6wNauv_NX9JcrY,10
+epyt_flow-0.14.0.dist-info/RECORD,,

{epyt_flow-0.13.0.dist-info → epyt_flow-0.14.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.3.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any