epyt-flow 0.4.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

epyt_flow/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

epyt_flow/simulation/scada/scada_data.py

@@ -1163,6 +1163,9 @@ class ScadaData(Serializable):
             :func:`~epyt_flow.simulation.scada.scada_data.ScadaData.get_data` --
             calling this function is the only way of accessing the energy usage of each pump.
 
+            The odering in the returned NumPy array corresponds to the ordering
+            of the pumps in EPANET.
+
         Returns
         -------
         `numpy.ndarray`
@@ -1180,6 +1183,9 @@ class ScadaData(Serializable):
             :func:`~epyt_flow.simulation.scada.scada_data.ScadaData.get_data` --
             calling this function is the only way of accessing the pumps' efficiency.
 
+            The odering in the returned NumPy array corresponds to the ordering
+            of the pumps in EPANET.
+
         Returns
         -------
         `numpy.ndarray`

epyt_flow/simulation/scenario_visualizer.py

@@ -12,7 +12,7 @@ class ScenarioVisualizer():
 
     Parameters
     ----------
-    scenario : :class:`epyt_flow.simulation.scenario_simulator.ScenarioSimulator`
+    scenario : :class:`~epyt_flow.simulation.scenario_simulator.ScenarioSimulator`
         Scenario to be visualized.
     """
     def __init__(self, scenario: ScenarioSimulator):

epyt_flow/simulation/sensor_config.py

@@ -1647,6 +1647,42 @@ class SensorConfig(JsonSerializable):
         """
         return deepcopy(self.__sensors_id_to_idx)
 
+    def get_as_dict(self) -> dict:
+        """
+        Gets the sensor configuration as a dictionary.
+
+        Returns
+        -------
+        `dict`
+            Dictionary of set sensors -- the keys are the sensor types.
+        """
+        r = {}
+
+        if self.__pressure_sensors != []:
+            r["pressure"] = self.__pressure_sensors
+        if self.__flow_sensors != []:
+            r["flow"] = self.__flow_sensors
+        if self.__demand_sensors != []:
+            r["demand"] = self.__demand_sensors
+        if self.__tank_volume_sensors != []:
+            r["tank_volume"] = self.__tank_volume_sensors
+        if self.__valve_state_sensors != []:
+            r["valve_state"] = self.__valve_state_sensors
+        if self.__pump_state_sensors != []:
+            r["pump_state"] = self.__pump_state_sensors
+        if self.__quality_node_sensors != []:
+            r["node_quality"] = self.__quality_node_sensors
+        if self.__quality_link_sensors != []:
+            r["link_quality"] = self.__quality_link_sensors
+        if self.__bulk_species_node_sensors != {}:
+            r["node_bulk_species"] = self.__bulk_species_node_sensors
+        if self.__bulk_species_link_sensors != {}:
+            r["link_bulk_species"] = self.__bulk_species_link_sensors
+        if self.__surface_species_sensors != {}:
+            r["surface_species"] = self.__surface_species_sensors
+
+        return r
+
     def get_attributes(self) -> dict:
         attr = {"nodes": self.__nodes, "links": self.__links,
                 "valves": self.__valves, "pumps": self.__pumps,
@@ -1719,7 +1755,7 @@ class SensorConfig(JsonSerializable):
             f"pump_id_to_idx: {self.__pump_id_to_idx} tank_id_to_idx: {self.__tank_id_to_idx} " +\
             f"valve_id_to_idx: {self.__valve_id_to_idx} " +\
             f"bulkspecies_id_to_idx: {self.__bulkspecies_id_to_idx} " +\
-            f"surfacespecies_id_to_idx: {self.__surfacespecies_id_to_idx}" +\
+            f"surfacespecies_id_to_idx: {self.__surfacespecies_id_to_idx} " +\
             f"pressure_sensors: {self.__pressure_sensors} flow_sensors: {self.__flow_sensors} " +\
             f"demand_sensors: {self.__demand_sensors} " +\
             f"quality_node_sensors: {self.__quality_node_sensors} " +\

epyt_flow/topology.py

@@ -108,7 +108,7 @@ class NetworkTopology(nx.Graph, JsonSerializable):
 
     def convert_units(self, units: int) -> Any:
         """
-        Converts this instance to a :class:`epyt_flow.topology.NetworkTopology` instance
+        Converts this instance to a :class:`~epyt_flow.topology.NetworkTopology` instance
         where everything is measured in given measurement units category
         (US Customary or SI Metric).
 
@@ -124,7 +124,7 @@ class NetworkTopology(nx.Graph, JsonSerializable):
 
         Returns
         -------
-        :class:`epyt_flow.topology.NetworkTopology`
+        :class:`~epyt_flow.topology.NetworkTopology`
             Network topology with the new measurements units.
         """
         if self.__units is None:
@@ -199,6 +199,76 @@ class NetworkTopology(nx.Graph, JsonSerializable):
         """
         return [(link_id, end_points) for link_id, end_points, _ in self.__links]
 
+    def get_all_junctions(self) -> list[str]:
+        """
+        Gets all junctions -- i.e. nodes that are not tanks or reservoirs.
+
+        Returns
+        -------
+        `list[str]`
+            List of all junctions.
+        """
+        r = []
+
+        for node_id in self.get_all_nodes():
+            if self.get_node_info(node_id)["type"] == "JUNCTION":
+                r.append(node_id)
+
+        return r
+
+    def get_all_tanks(self) -> list[str]:
+        """
+        Gets all tanks -- i.e. nodes that are not junctions or reservoirs.
+
+        Returns
+        -------
+        `list[str]`
+            List of all tanks.
+        """
+        r = []
+
+        for node_id in self.get_all_nodes():
+            if self.get_node_info(node_id)["type"] == "TANK":
+                r.append(node_id)
+
+        return r
+
+    def get_all_reservoirs(self) -> list[str]:
+        """
+        Gets all reservoirs -- i.e. nodes that are not junctions or tanks.
+
+        Returns
+        -------
+        `list[str]`
+            List of all reservoirs.
+        """
+        r = []
+
+        for node_id in self.get_all_nodes():
+            if self.get_node_info(node_id)["type"] == "RESERVOIR":
+                r.append(node_id)
+
+        return r
+
+    def get_all_pipes(self) -> list[tuple[str, tuple[str, str]]]:
+        """
+        Gets all pipes -- i.e. links that not valves or pumps.
+
+        Returns
+        -------
+        `list[tuple[str, tuple[str, str]]]`
+            List of all pipes -- (link ID, (left node ID, right node ID)).
+        """
+        r = []
+
+        for link_id, link_nodes in self.get_all_links():
+            link_info = self.get_link_info(link_id)
+
+            if link_info["type"] == "PIPE":
+                r.append((link_id, link_nodes))
+
+        return r
+
     def get_all_pumps(self) -> list[str]:
         """
         Gets the IDs of all pumps.

epyt_flow/utils.py

@@ -153,8 +153,10 @@ def plot_timeseries_data(data: np.ndarray, labels: list[str] = None, x_axis_labe
 
 
 def plot_timeseries_prediction(y: np.ndarray, y_pred: np.ndarray,
-                               confidence_interval: np.ndarray = None, show: bool = True,
-                               ax: matplotlib.axes.Axes = None) -> matplotlib.axes.Axes:
+                               confidence_interval: np.ndarray = None,
+                               x_axis_label: str = None, y_axis_label: str = None,
+                               show: bool = True, ax: matplotlib.axes.Axes = None
+                               ) -> matplotlib.axes.Axes:
     """
     Plots the prediction (e.g. forecast) of *single* time series together with the
     ground truth time series. In addition, confidence intervals can be plotted as well.
@@ -169,6 +171,14 @@ def plot_timeseries_prediction(y: np.ndarray, y_pred: np.ndarray,
         Confidence interval (upper and lower value) for each prediction in `y_pred`.
         If not None, the confidence interval is plotted as well.
 
+        The default is None.
+    x_axis_label : `str`, optional
+        X axis label.
+
+        The default is None.
+    y_axis_label : `str`, optional
+        Y axis label.
+
         The default is None.
     show : `bool`, optional
         If True, the plot/figure is shown in a window.
@@ -198,6 +208,14 @@ def plot_timeseries_prediction(y: np.ndarray, y_pred: np.ndarray,
         raise ValueError("'y_pred' must be a 1d array")
     if len(y.shape) != 1:
         raise ValueError("'y' must be a 1d array")
+    if x_axis_label is not None:
+        if not isinstance(x_axis_label, str):
+            raise TypeError("'x_axis_label' must be an instance of 'str' " +
+                            f"but not of '{type(x_axis_label)}'")
+    if y_axis_label is not None:
+        if not isinstance(y_axis_label, str):
+            raise TypeError("'y_axis_label' must be an instance of 'str' " +
+                            f"but not of '{type(y_axis_label)}'")
     if not isinstance(show, bool):
         raise TypeError(f"'show' must be an instance of 'bool' but not of '{type(show)}'")
     if ax is not None:
@@ -218,6 +236,11 @@ def plot_timeseries_prediction(y: np.ndarray, y_pred: np.ndarray,
     ax.plot(y_pred, ".-", label="Prediction")
     ax.legend()
 
+    if x_axis_label is not None:
+        ax.set_xlabel(x_axis_label)
+    if y_axis_label is not None:
+        ax.set_ylabel(y_axis_label)
+
     if show is True and fig is not None:
         plt.show()
 

{epyt_flow-0.4.0.dist-info → epyt_flow-0.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: epyt-flow
-Version: 0.4.0
+Version: 0.5.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: MIT License

{epyt_flow-0.4.0.dist-info → epyt_flow-0.5.0.dist-info}/RECORD

@@ -1,9 +1,9 @@
-epyt_flow/VERSION,sha256=QLjrQACpE6d5EJBTXykdPTaYdBYqie88nj1OiHobnnk,6
+epyt_flow/VERSION,sha256=oK1QZAE5pST4ZZEVcUW_HUZ06pwGW_6iFVjw97BEMMg,6
 epyt_flow/__init__.py,sha256=KNDiPWiHdB9a5ZF1ipjA1uoq61TwU2ThjaStpvSLBtY,1742
 epyt_flow/metrics.py,sha256=kvt42pzZrUR9PSlCyK4uq5kj6UlYHkt7OcCjLnI1RQE,12883
 epyt_flow/serialization.py,sha256=nBcwc3aMUbHF0zW8Nvpc49kKeLPh75blc3gzjKDR1ok,12893
-epyt_flow/topology.py,sha256=GLB2fIgCds9FiMbqoIJUhUTUw3aInt0iCCGPLX3DArQ,21650
-epyt_flow/utils.py,sha256=sWYGwPTQpDainI8s9N3AJ1zyJ1W2i-2lpTM_BbWNyvo,11507
+epyt_flow/topology.py,sha256=yKIspoX4uoo9rAeVR5eWJ6D91QNozHzvzjiry9bFkNI,23424
+epyt_flow/utils.py,sha256=AB2MuknQ_16UE-URQe1WShIS7dmSyFwZYVHxMVT539k,12379
 epyt_flow/EPANET/compile_linux.sh,sha256=wcrDyiB8NkivmaC-X9FI2WxhY3IJqDLiyIbVTv2XEPY,489
 epyt_flow/EPANET/compile_macos.sh,sha256=1K33-bPdgr01EIf87YUvmOFHXyOkBWI6mKXQ8x1Hzmo,504
 epyt_flow/EPANET/EPANET/SRC_engines/AUTHORS,sha256=yie5yAsEEPY0984PmkSRUdqEU9rVvRSGGWmjxdwCYMU,925
@@ -113,8 +113,8 @@ epyt_flow/simulation/__init__.py,sha256=VGGJqJRUoXZjKJ0-m6KPp3JQqD_1TFW0pofLgkwZ
 epyt_flow/simulation/parallel_simulation.py,sha256=VmC7xemjxRB_N0fx1AAQ7ux82tnyTi7jk7jfFpeg7gM,6523
 epyt_flow/simulation/scenario_config.py,sha256=_Zs0EPyfet0mTLpAt-oMN3k7jCW3x7_VbOQHpHVntrA,26597
 epyt_flow/simulation/scenario_simulator.py,sha256=1amMxO-PVHBU_AN6K9Ga6xzFmpaX2ZZnhwkirtj6IgY,93036
-epyt_flow/simulation/scenario_visualizer.py,sha256=2gr1o731VLlhA8wQKgrLT94M43FsBNKjG_eucZPHy9A,2186
-epyt_flow/simulation/sensor_config.py,sha256=9pUzvRm4HSF8zZ-Hu4pdpxzTjpNSdNmDvcPhRaRFNAI,80175
+epyt_flow/simulation/scenario_visualizer.py,sha256=fpj67zl69q-byg7Oxocqhmu1S3P7B3ROCkSYzWyM--0,2187
+epyt_flow/simulation/sensor_config.py,sha256=MGeerEnLhyFLE6XA2p-X9Swd4k0o0T7QboeGuTUFq7I,81584
 epyt_flow/simulation/events/__init__.py,sha256=tIdqzs7_Cus4X2kbZG4Jl2zs-zsk_4rnajFOCvL0zlI,185
 epyt_flow/simulation/events/actuator_events.py,sha256=2_MPYbYO9As6fMkm5Oy9pjSB9kCvFuKpGu8ykYDAydg,7903
 epyt_flow/simulation/events/event.py,sha256=kARPV20XCAl6zxnJwI9U7ICtZUPACO_rgAmtHm1mGCs,2603
@@ -125,15 +125,15 @@ epyt_flow/simulation/events/sensor_reading_event.py,sha256=rQ-CmdpSUyZzDFYwNUGH2
 epyt_flow/simulation/events/system_event.py,sha256=0KI2iaAaOyC9Y-FIfFVazeKT_4ORQRp26gWyMBUu_3c,2396
 epyt_flow/simulation/scada/__init__.py,sha256=ZFAxJVqwEVsgiyFilFetnb13gPhZg1JEOPWYvKIJT4c,90
 epyt_flow/simulation/scada/advanced_control.py,sha256=Enox02ggt36HdFLX7ZNxgxuqsTEeu9AACHrzU8CXGrg,4489
-epyt_flow/simulation/scada/scada_data.py,sha256=NfGDGrQ7HIXTcShUaGeCALTvGmM5LAJW0Bgmk0H4UQg,104867
+epyt_flow/simulation/scada/scada_data.py,sha256=WaFSppBHvJOwSyLYNs9Pu2GngSzWsfkpqPfBQoeiEcU,105101
 epyt_flow/simulation/scada/scada_data_export.py,sha256=0BwDgV-5qZx17wIyWQ8Nl2TPgho3mBI49027RDq8sDA,11217
 epyt_flow/uncertainty/__init__.py,sha256=ZRjuJL9rDpWVSdPwObPxFpEmMTcgAl3VmPOsS6cIyGg,89
 epyt_flow/uncertainty/model_uncertainty.py,sha256=-2QT2AffZerKZyZ_w_mmeqYpfBALyPDvV61sCrvcK1o,13966
 epyt_flow/uncertainty/sensor_noise.py,sha256=zJVULxnxVPSSqc6UW0iwZ9O-HGf9dn4CwScPqf4yCY0,2324
 epyt_flow/uncertainty/uncertainties.py,sha256=X-o7GZUC0HELtzpoXIAJaAeYOw35N05TuRoSmStcCpI,17669
 epyt_flow/uncertainty/utils.py,sha256=gq66c9-QMOxOqI6wgWLyFxjVV0fbG0_8Yzd6mQjNYNo,5315
-epyt_flow-0.4.0.dist-info/LICENSE,sha256=-4hYIY2BLmCkdOv2_PehEwlnMKTCes8_oyIUXjKtkug,1076
-epyt_flow-0.4.0.dist-info/METADATA,sha256=QVUFiy7LV7VYckKinh3wvbaErIHhTA5oBs-vZhWRCF8,7087
-epyt_flow-0.4.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-epyt_flow-0.4.0.dist-info/top_level.txt,sha256=Wh_kd7TRL8ownCw3Y3dxx-9C0iTSk6wNauv_NX9JcrY,10
-epyt_flow-0.4.0.dist-info/RECORD,,
+epyt_flow-0.5.0.dist-info/LICENSE,sha256=-4hYIY2BLmCkdOv2_PehEwlnMKTCes8_oyIUXjKtkug,1076
+epyt_flow-0.5.0.dist-info/METADATA,sha256=a7kEbUctgxuMBJ06GNrwJnAlr_arMtcxHg-TZzSiD8M,7087
+epyt_flow-0.5.0.dist-info/WHEEL,sha256=mguMlWGMX-VHnMpKOjjQidIo1ssRlCFu4a4mBpz1s2M,91
+epyt_flow-0.5.0.dist-info/top_level.txt,sha256=Wh_kd7TRL8ownCw3Y3dxx-9C0iTSk6wNauv_NX9JcrY,10
+epyt_flow-0.5.0.dist-info/RECORD,,

{epyt_flow-0.4.0.dist-info → epyt_flow-0.5.0.dist-info}/WHEEL

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