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

epyt_flow/rest_api/base_handler.py

@@ -11,6 +11,20 @@ class BaseHandler():
     """
     Base class for all REST API handlers.
     """
+    def send_error(self, resp: falcon.Response, error_msg: str) -> None:
+        """
+        Sends an error message back.
+
+        Parameters
+        ----------
+        resp : `falcon.Response`
+            Response instance.
+        error_msg : `str`
+            Error message.
+        """
+        resp.status = falcon.HTTP_BAD_REQUEST
+        resp.data = error_msg.encode()
+
     def send_invalid_resource_id_error(self, resp: falcon.Response) -> None:
         """
         Sends an error that th given resource ID (e.g. scenario ID, or SCADA data ID) is invalid.

epyt_flow/rest_api/scada_data/handlers.py

@@ -165,3 +165,45 @@ class ScadaDataSensorFaultsHandler(ScadaDataBaseHandler):
         except Exception as ex:
             warnings.warn(str(ex))
             resp.status = falcon.HTTP_INTERNAL_SERVER_ERROR
+
+
+class ScadaDataConvertUnitsHandler(ScadaDataBaseHandler):
+    """
+    Class for handling POST requests concerning unit conversion of a
+    given SCADA data instance.
+    """
+    def on_post(self, req: falcon.Request, resp: falcon.Response, data_id: str) -> None:
+        """
+        Converts the units of a given SCADA data instance and returns a new SCADA data instance.
+
+        Parameters
+        ----------
+        req : `falcon.Request`
+            Request instance.
+        resp : `falcon.Response`
+            Response instance.
+        data_id : `str`
+            UUID of the SCADA data.
+        """
+        try:
+            if self.scada_data_mgr.validate_uuid(data_id) is False:
+                self.send_invalid_resource_id_error(resp)
+                return
+
+            new_units = self.load_json_data_from_request(req)
+            if not isinstance(new_units, dict):
+                self.send_json_parsing_error(resp)
+                return
+
+            my_scada_data = self.scada_data_mgr.get(data_id)
+            try:
+                scada_data_new = my_scada_data.convert_units(**new_units)
+            except Exception as ex:
+                self.send_error(resp, str(ex))
+                return
+
+            new_scada_data_id = self.scada_data_mgr.create_new_item(scada_data_new)
+            self.send_json_response(resp, {"data_id": new_scada_data_id})
+        except Exception as ex:
+            warnings.warn(str(ex))
+            resp.status = falcon.HTTP_INTERNAL_SERVER_ERROR

epyt_flow/rest_api/server.py

@@ -14,7 +14,7 @@ from .scenario.event_handlers import ScenarioLeakageHandler, ScenarioSensorFault
 from .scenario.simulation_handlers import ScenarioSimulationHandler, \
     ScenarioBasicQualitySimulationHandler, ScenarioAdvancedQualitySimulationHandler
 from .scada_data.handlers import ScadaDataManager, ScadaDataSensorConfigHandler, \
-    ScadaDataRemoveHandler, ScadaDataSensorFaultsHandler
+    ScadaDataRemoveHandler, ScadaDataSensorFaultsHandler, ScadaDataConvertUnitsHandler
 from .scada_data.data_handlers import ScadaDataPressuresHandler, ScadaDataDemandsHandler, \
     ScadaDataFlowsHandler, ScadaDataLinksQualityHandler, ScadaDataNodesQualityHandler, \
     ScadaDataNodeBulkSpeciesHandler, ScadaDataLinkBulkSpeciesHandler, \
@@ -114,6 +114,8 @@ class RestApiService():
                            ScadaDataNumpyExportHandler(scada_data_mgr=self.scada_data_mgr))
         self.app.add_route("/scada_data/{data_id}/export",
                            ScadaDataExportHandler(scada_data_mgr=self.scada_data_mgr))
+        self.app.add_route("/scada_data/{data_id}/convert_units",
+                           ScadaDataConvertUnitsHandler(scada_data_mgr=self.scada_data_mgr))
 
     @property
     def port(self) -> int:

epyt_flow/simulation/events/leakages.py

@@ -5,6 +5,7 @@ from copy import deepcopy
 import math
 import numpy as np
 import epyt
+from epyt.epanet import ToolkitConstants
 
 from .system_event import SystemEvent
 from ...serialization import serializable, JsonSerializable, \
@@ -23,14 +24,14 @@ class Leakage(SystemEvent, JsonSerializable):
         Note that if the leak is placed at a node, then 'link_id' must be None and the
         ID of the node must be set in 'node_id'
     diameter : `float`, optional
-        Diameter of this leak.
+        Diameter of this leak in either *foot* or *meter* (depending on the used flow units).
 
         Alternatively, 'area' can be used for specifying the size of this leakage --
         in this case, 'diameter' must be set to 'None'.
 
         The default is None.
     area : `float`, optional
-        Area of this leak.
+        Area of this leak in either *foot^2* or *meter^2* (depending on the used flow units).
 
         Alternatively, 'diameter' can be used for specifying the size of this leakage --
         in this case, 'area' must be set to 'None'.
@@ -124,19 +125,21 @@ class Leakage(SystemEvent, JsonSerializable):
     @property
     def diameter(self) -> float:
         """
-        Gets the diameter of the leak.
+        Gets the diameter of the leak in either *foot* or *meter*
+        (depending on the sued flow units).
 
         Returns
         -------
         `float`
-            Diameter of the leak.
+            Diameter (*foot* or *meter*) of the leak.
         """
         return self.__diameter
 
     @property
     def area(self) -> float:
         """
-        Gets the area of the leak.
+        Gets the area of the leak in either *foot^2* or *meter^2*
+        (depending on the sued flow units).
 
         Returns
         -------
@@ -179,7 +182,7 @@ class Leakage(SystemEvent, JsonSerializable):
             raise TypeError(f"Can not compare 'Leakage' instance with '{type(other)}' instance")
 
         return super().__eq__(other) and self.__link_id == other.link_id \
-            and self.__diameter == other.diameter and self.__profile == other.profile \
+            and self.__diameter == other.diameter and np.all(self.__profile == other.profile) \
             and self.__node_id == other.node_id and self.area == other.area
 
     def __str__(self) -> str:
@@ -190,46 +193,53 @@ class Leakage(SystemEvent, JsonSerializable):
         """
         Computes the leak area given the diameter.
 
+        leak_area = pi * (diameter * .5)^2
+
         Parameters
         ----------
         diameter : `float`
-            Diameter (m) of the leak.
+            Diameter (*foot* or *meter*) of the leak.
 
         Returns
         -------
         `float`
-            Leak area in mm^2.
+            Leak area in *foot^2* or *meter^2*.
         """
-        return (np.pi * (diameter / 2) ** 2) * 10000.
+        return np.pi * (diameter / 2) ** 2
 
-    def compute_leak_emitter_coefficient(self, area: float, discharge_coef: float = .75,
-                                         g: float = 9.80665) -> float:
+    def compute_leak_emitter_coefficient(self, area: float, discharge_coef: float = .75) -> float:
         """
         Computes the leak emitter coefficient.
 
-        emitter_coef = discharge_coef * area * sqrt(2*g)   where g = 9.8, discharge_coef = .75
+        emitter_coef = discharge_coef * area * sqrt(2*g)
+        where g is the gravitational constant, and discharge_coef = .75
 
         leak_demand = emitter_coef * pressure^alpha       where alpha = .5
 
         Parameters
         ----------
         area : `float`
-            Leak area (mm^2) as computed in
-            :func:`epyt_flow.simulation.events.leakages.Leakage.compute_leak_area`.
+            Leak area (foot^2 or meter^2) as computed in
+            :func:`~epyt_flow.simulation.events.leakages.Leakage.compute_leak_area`.
         discharge_coef : `float`, optional
             Discharge coefficient.
 
             The default is set to 0.75
-        g : `float`, optional
-            Gravitational constant. Do not change this!
-
-            The default is 9.8
 
         Returns
         -------
         `float`
             Leak emitter coefficient.
         """
+        flow_unit = self._epanet_api.api.ENgetflowunits()
+        if flow_unit == ToolkitConstants.EN_CMH:
+            g = 127137600   # m/h^2
+        elif flow_unit == ToolkitConstants.EN_CFS:
+            g = 32.17405    # feet/s^2
+        else:
+            raise ValueError("Leakages are only implemented for the following flow units:\n" +
+                             " EN_CMH (cubic foot/sec)\n EN_CFS (cubic meter/hr)")
+
         return discharge_coef * area * np.sqrt(2. * g)
 
     def init(self, epanet_api: epyt.epanet) -> None:

epyt_flow/simulation/parallel_simulation.py

@@ -1,7 +1,7 @@
 """
 Module provides functions for simulating several scenarios in parallel.
 """
-from typing import Callable
+from typing import Callable, Any
 import os
 import warnings
 from multiprocess import Pool, cpu_count
@@ -38,9 +38,9 @@ def callback_save_to_file(folder_out: str = "") -> Callable[[ScadaData, Scenario
 
 
 def _run_scenario_simulation(scenario_config: ScenarioConfig, scenario_idx: int,
-                             callback: Callable[[ScadaData, ScenarioConfig, int], None]) -> None:
+                             callback: Callable[[ScadaData, ScenarioConfig, int], Any]) -> Any:
     with ScenarioSimulator(scenario_config=scenario_config) as sim:
-        callback(sim.run_simulation(), scenario_config, scenario_idx)
+        return callback(sim.run_simulation(), scenario_config, scenario_idx)
 
 
 class ParallelScenarioSimulation():
@@ -50,8 +50,8 @@ class ParallelScenarioSimulation():
     @staticmethod
     def run(scenarios: list[ScenarioConfig], n_jobs: int = -1,
             max_working_memory_consumption: int = None,
-            callback: Callable[[ScadaData, ScenarioConfig, int], None] = callback_save_to_file()
-            ) -> None:
+            callback: Callable[[ScadaData, ScenarioConfig, int], Any] = callback_save_to_file()
+            ) -> Any:
         """
         Simulates multiple scenarios in parallel.
 
@@ -76,7 +76,7 @@ class ParallelScenarioSimulation():
 
             The callback gets the simulation results as a
             :class:`~epyt_flow.simulation.scada.scada_data.ScadaData` instance, the scenario
-            configuration as a :class: `epyt_flow.simulation.scenario_config.ScenarioConfig`
+            configuration as a :class:`~epyt_flow.simulation.scenario_config.ScenarioConfig`
             instance, and the index of the scenario in 'scenarios' as arguments.
 
             The default is :func:`~epyt_flow.simulation.parallel_simulation.callback_save_to_file`.
@@ -144,4 +144,4 @@ class ParallelScenarioSimulation():
             scenarios_task.append((scenario, scenario_idx, callback))
 
         with Pool(processes=n_parallel_scenarios, maxtasksperchild=1) as pool:
-            pool.starmap(_run_scenario_simulation, scenarios_task)
+            return pool.starmap(_run_scenario_simulation, scenarios_task)