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

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

@@ -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 → epyt_flow-0.14.0}/README.md

@@ -47,12 +47,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 → epyt_flow-0.14.0}/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-0.14.0/epyt_flow/VERSION

@@ -0,0 +1 @@
+0.14.0

{epyt_flow-0.13.0 → epyt_flow-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-0.13.0 → epyt_flow-0.14.0}/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-0.13.0 → epyt_flow-0.14.0}/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