epyt-flow 0.8.1__py3-none-any.whl → 0.10.0__py3-none-any.whl

epyt_flow/simulation/scenario_visualizer.py

@@ -147,7 +147,7 @@ class ScenarioVisualizer:
 
         Parameters
         ----------
-        scenario : :class:`epyt_flow.simulation.scenario_simulator.ScenarioSimulator`
+        scenario : :class:`~epyt_flow.simulation.scenario_simulator.ScenarioSimulator`
             An instance of the `ScenarioSimulator` class, used to simulate and
             retrieve the system topology.
 
@@ -155,7 +155,7 @@ class ScenarioVisualizer:
         ------
         TypeError
             If `scenario` is not an instance of
-            :class:`epyt_flow.simulation.scenario_simulator.ScenarioSimulator`.
+            :class:`~epyt_flow.simulation.scenario_simulator.ScenarioSimulator`.
 
         """
         if not isinstance(scenario, ScenarioSimulator):
@@ -303,7 +303,7 @@ class ScenarioVisualizer:
 
         Parameters
         ----------
-        scada_data : :class:`~epyt_flow.scada.scada_data.ScadaData`, optional
+        scada_data : :class:`~epyt_flow.simulation.scada.scada_data.ScadaData`, optional
             The SCADA data object to retrieve link data from. If `None`, a
             simulation is run to generate the SCADA data. Default is `None`.
         parameter : `str`, optional
@@ -644,7 +644,7 @@ class ScenarioVisualizer:
 
         Parameters
         ----------
-        scada_data : :class:`~epyt_flow.scada.scad_data.ScadaData`, optional
+        scada_data : :class:`~epyt_flow.simulation.scada.scada_data.ScadaData`, optional
             The SCADA data object containing node data. If `None`, a simulation
             will be run to generate SCADA data. Default is `None`.
         parameter : `str`, optional
@@ -761,7 +761,7 @@ class ScenarioVisualizer:
 
         Parameters
         ----------
-        scada_data : :class:`~epyt_flow.scada.scada_data.ScadaData`, optional
+        scada_data : :class:`~epyt_flow.simulation.scada.scada_data.ScadaData`, optional
             The SCADA data object. If `None`, the method will run a simulation.
             Default is `None`.
         parameter : `str`, optional
@@ -861,7 +861,7 @@ class ScenarioVisualizer:
 
         Parameters
         ----------
-        scada_data : :class:`~epyt_flow.scada.scada_data.ScadaData`, optional
+        scada_data : :class:`~epyt_flow.simulation.scada.scada_data.ScadaData`, optional
             The SCADA data object containing the pump data. If `None`, a
             simulation will be run to generate SCADA data. Default is `None`.
         parameter : `str`, optional
@@ -971,7 +971,7 @@ class ScenarioVisualizer:
 
         Parameters
         ----------
-        scada_data : :class:`~epyt_flow.scada.scada_data.ScadaData`, optional
+        scada_data : :class:`~epyt_flow.simulation.scada.scada_data.ScadaData`, optional
             The SCADA data object containing tank volume data.
             If `None`, a simulation will be run to generate it.
             Default is `None`.
@@ -1066,7 +1066,7 @@ class ScenarioVisualizer:
 
         Parameters
         ----------
-        scada_data : :class:`~epyt_flow.scada.scada_data.ScadaData`, optional
+        scada_data : :class:`~epyt_flow.simulation.scada.scada_data.ScadaData`, optional
             The SCADA data object containing valve state data. If `None`, a
             simulation is run to generate SCADA data. Default is `None`.
         statistic : `str`, optional
@@ -1162,7 +1162,7 @@ class ScenarioVisualizer:
 
         Parameters
         ----------
-        scada_data : :class:`~epyt_flow.scada.scada_data.ScadaData`, optional
+        scada_data : :class:`~epyt_flow.simulation.scada.scada_data.ScadaData`, optional
             The SCADA data object. If `None`, a simulation will be run to
             generate it. Default is `None`.
         parameter : `str`, optional

epyt_flow/simulation/sensor_config.py

@@ -2,7 +2,6 @@
 Module provides a class for implementing sensor configurations.
 """
 from copy import deepcopy
-import warnings
 import itertools
 import numpy as np
 import epyt
@@ -465,7 +464,7 @@ class SensorConfig(JsonSerializable):
     """
     def __init__(self, nodes: list[str], links: list[str], valves: list[str], pumps: list[str],
                  tanks: list[str], bulk_species: list[str], surface_species: list[str],
-                 flow_unit: int = None,
+                 flow_unit: int,
                  pressure_sensors: list[str] = [],
                  flow_sensors: list[str] = [],
                  demand_sensors: list[str] = [],
@@ -685,16 +684,11 @@ class SensorConfig(JsonSerializable):
             if any(s not in surface_species for s in surfacespecies_id_to_idx.keys()):
                 raise ValueError("Unknown surface species ID in 'surfacespecies_id_to_idx'")
 
-        if flow_unit is not None:
-            if not isinstance(flow_unit, int):
-                raise TypeError("'flow_unit' must be a an instance of 'int' " +
-                                f"but not of '{type(flow_unit)}'")
-            if flow_unit not in range(10):
-                raise ValueError("Invalid value of 'flow_unit'")
-        else:
-            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)
+        if not isinstance(flow_unit, int):
+            raise TypeError("'flow_unit' must be a an instance of 'int' " +
+                            f"but not of '{type(flow_unit)}'")
+        if flow_unit not in range(10):
+            raise ValueError("Invalid value of 'flow_unit'")
 
         if quality_unit is not None:
             if not isinstance(quality_unit, int):
@@ -1282,6 +1276,22 @@ class SensorConfig(JsonSerializable):
         """
         return self.__links.copy()
 
+    @property
+    def junctions(self) -> list[str]:
+        """
+        Returns all junction IDs.
+
+        Returns
+        -------
+        `list[str]`
+            All juncitons IDs.
+        """
+        junctions = self.nodes
+        for tank_id in self.tanks:
+            junctions.remove(tank_id)
+
+        return junctions
+
     @property
     def valves(self) -> list[str]:
         """
@@ -1781,12 +1791,12 @@ class SensorConfig(JsonSerializable):
     @property
     def sensors_id_to_idx(self) -> dict:
         """
-        Gets a mapping of sensor IDs to indices in the final Numpy array returned by `get_data()`.
+        Gets a mapping of sensor IDs to indices in the final `Numpy array <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_ returned by `get_data()`.
 
         Returns
         -------
         `dict`
-            Mapping of sensor IDs to indices in the final Numpy array.
+            Mapping of sensor IDs to indices in the final `Numpy array <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_.
         """
         return deepcopy(self.__sensors_id_to_idx)
 
@@ -1987,39 +1997,39 @@ class SensorConfig(JsonSerializable):
 
         Parameters
         ----------
-        pressures : `numpy.ndarray`
+        pressures : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             Pressure values at all nodes.
-        flows : `numpy.ndarray`
+        flows : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             Flow values at all links/pipes.
-        demands : `numpy.ndarray`
+        demands : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             Demand values at all nodes.
-        nodes_quality : `numpy.ndarray`
+        nodes_quality : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             Quality values at all nodes.
-        links_quality : `numpy.ndarray`
+        links_quality : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             Quality values at all links/pipes.
-        pumps_state : `numpy.ndarray`
+        pumps_state : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             States of all pumps.
-        pumps_efficiency : `numpy.ndarray`
+        pumps_efficiency : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             Efficiency of all pumps.
-        pumps_energyconsumption : `numpy.ndarray`
+        pumps_energyconsumption : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             Energy consumption of all pumps.
-        valves_state : `numpy.ndarray`
+        valves_state : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             States of all valves.
-        tanks_volume : `numpy.ndarray`
+        tanks_volume : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             Water volume in all tanks.
-        bulk_species_node_concentrations : `numpy.ndarray`
+        bulk_species_node_concentrations : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             Bulk species concentrations at all nodes.
 
             Expect a three-dimensional array: First dimension denotes time,
             second dimension corresponds to species ID,
             and third dimension contains the concentration.
-        bulk_species_link_concentrations : `numpy.ndarray`
+        bulk_species_link_concentrations : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             Bulk species concentrations at all links/pipes.
 
             Expect a three-dimensional array: First dimension denotes time,
             second dimension corresponds to species ID,
             and third dimension contains the concentration.
-        surface_species_concentrations : `numpy.ndarray`
+        surface_species_concentrations : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             Surface species concentrations at all links/pipes.
 
             Expect a three-dimensional array: First dimension denotes time,
@@ -2028,7 +2038,7 @@ class SensorConfig(JsonSerializable):
 
         Returns
         -------
-        `numpy.ndarray`
+        `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             Sensor readings.
         """
         data = []

epyt_flow/topology.py

@@ -552,7 +552,7 @@ class NetworkTopology(nx.Graph, JsonSerializable):
         Returns
         -------
         `dict`
-            Network topology as a dictionary of `geopandas.GeoDataFrames` instances.
+            Network topology as a dictionary of `geopandas.GeoDataFrames <https://geopandas.org/en/stable/docs/reference/api/geopandas.GeoDataFrame.html>`_ instances.
             If a quantity does not exist, the data frame will be None.
         """
         gis = {"nodes": None, "links": None,
@@ -629,7 +629,7 @@ class NetworkTopology(nx.Graph, JsonSerializable):
 
         Returns
         -------
-        `scipy.bsr_array`
+        `scipy.bsr_array <https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.bsr_array.html>`_
             Adjacency matrix as a sparse array.
         """
         nodes_id = [node_id for node_id, _ in self.__nodes]