epyt-flow 0.1.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

epyt_flow/rest_api/server.py

@@ -4,15 +4,24 @@ This module provides the EPyT-Flow REST API server.
 from wsgiref.simple_server import make_server, WSGIServer
 import falcon
 
-from .scenario_handler import ScenarioManager, ScenarioNewHandler, ScenarioRemoveHandler, \
-    ScenarioGeneralParamsHandler, ScenarioSensorConfigHandler, ScenarioSimulationHandler, \
-    ScenarioTopologyHandler, ScenarioConfigHandler, ScenarioLeakageHandler
-from .scada_data_handler import ScadaDataManager, ScadaDataSensorConfigHandler, \
-    ScadaDataPressuresHandler, ScadaDataDemandsHandler, ScadaDataFlowsHandler, \
-    ScadaDataLinksQualityHandler, ScadaDataNodesQualityHandler, ScadaDataRemoveHandler, \
-    ScadaDataSensorFaultsHandler, ScadaDataNodeBulkSpeciesHandler, \
-    ScadaDataLinkBulkSpeciesHandler, ScadaDataSurfaceSpeciesHandler, ScadaDataTankVolumesHandler, \
-    ScadaDataPumpStatesHandler, ScadaDataValveStatesHandler
+from .scenario.handlers import ScenarioManager, ScenarioNewHandler, \
+    ScenarioRemoveHandler, ScenarioGeneralParamsHandler, ScenarioSensorConfigHandler, \
+    ScenarioExportHandler, ScenarioTopologyHandler, ScenarioConfigHandler, \
+    ScenarioNodeDemandPatternHandler
+from .scenario.uncertainty_handlers import ScenarioModelUncertaintyHandler, \
+    ScenarioSensorUncertaintyHandler
+from .scenario.event_handlers import ScenarioLeakageHandler, ScenarioSensorFaultHandler
+from .scenario.simulation_handlers import ScenarioSimulationHandler, \
+    ScenarioBasicQualitySimulationHandler, ScenarioAdvancedQualitySimulationHandler
+from .scada_data.handlers import ScadaDataManager, ScadaDataSensorConfigHandler, \
+    ScadaDataRemoveHandler, ScadaDataSensorFaultsHandler, ScadaDataConvertUnitsHandler
+from .scada_data.data_handlers import ScadaDataPressuresHandler, ScadaDataDemandsHandler, \
+    ScadaDataFlowsHandler, ScadaDataLinksQualityHandler, ScadaDataNodesQualityHandler, \
+    ScadaDataNodeBulkSpeciesHandler, ScadaDataLinkBulkSpeciesHandler, \
+    ScadaDataSurfaceSpeciesHandler, ScadaDataTankVolumesHandler, ScadaDataPumpStatesHandler, \
+    ScadaDataValveStatesHandler
+from .scada_data.export_handlers import ScadaDataExportHandler, ScadaDataXlsxExportHandler, \
+    ScadaDataMatlabExportHandler, ScadaDataNumpyExportHandler
 
 
 class RestApiService():
@@ -37,6 +46,8 @@ class RestApiService():
                            ScenarioNewHandler(self.scenario_mgr))
         self.app.add_route("/scenario/{scenario_id}",
                            ScenarioRemoveHandler(self.scenario_mgr))
+        self.app.add_route("/scenario/{scenario_id}/export",
+                           ScenarioExportHandler(self.scenario_mgr))
         self.app.add_route("/scenario/{scenario_id}/topology",
                            ScenarioTopologyHandler(self.scenario_mgr))
         self.app.add_route("/scenario/{scenario_id}/scenario_config",
@@ -45,11 +56,27 @@ class RestApiService():
                            ScenarioGeneralParamsHandler(self.scenario_mgr))
         self.app.add_route("/scenario/{scenario_id}/sensor_config",
                            ScenarioSensorConfigHandler(self.scenario_mgr))
-        self.app.add_route("/scenario/{scenario_id}/leakages",
+        self.app.add_route("/scenario/{scenario_id}/uncertainty/model",
+                           ScenarioModelUncertaintyHandler(self.scenario_mgr))
+        self.app.add_route("/scenario/{scenario_id}/uncertainty/sensors",
+                           ScenarioSensorUncertaintyHandler(self.scenario_mgr))
+        self.app.add_route("/scenario/{scenario_id}/events/leakages",
                            ScenarioLeakageHandler(self.scenario_mgr))
+        self.app.add_route("/scenario/{scenario_id}/events/sensor_faults",
+                           ScenarioSensorFaultHandler(self.scenario_mgr))
+        self.app.add_route("/scenario/{scenario_id}/node/{node_id}/demand_pattern",
+                           ScenarioNodeDemandPatternHandler(self.scenario_mgr))
         self.app.add_route("/scenario/{scenario_id}/simulation",
                            ScenarioSimulationHandler(scenario_mgr=self.scenario_mgr,
                                                      scada_data_mgr=self.scada_data_mgr))
+        self.app.add_route("/scenario/{scenario_id}/simulation/advanced_quality",
+                           ScenarioBasicQualitySimulationHandler(scenario_mgr=self.scenario_mgr,
+                                                                 scada_data_mgr=
+                                                                 self.scada_data_mgr))
+        self.app.add_route("/scenario/{scenario_id}/simulation/basic_quality",
+                           ScenarioAdvancedQualitySimulationHandler(scenario_mgr=self.scenario_mgr,
+                                                                    scada_data_mgr=
+                                                                    self.scada_data_mgr))
 
         self.app.add_route("/scada_data/{data_id}",
                            ScadaDataRemoveHandler(self.scada_data_mgr))
@@ -57,28 +84,38 @@ class RestApiService():
                            ScadaDataSensorConfigHandler(self.scada_data_mgr))
         self.app.add_route("/scada_data/{data_id}/sensor_faults",
                            ScadaDataSensorFaultsHandler(self.scada_data_mgr))
-        self.app.add_route("/scada_data/{data_id}/pressures",
+        self.app.add_route("/scada_data/{data_id}/nodes/pressures",
                            ScadaDataPressuresHandler(self.scada_data_mgr))
-        self.app.add_route("/scada_data/{data_id}/flows",
-                           ScadaDataFlowsHandler(self.scada_data_mgr))
-        self.app.add_route("/scada_data/{data_id}/demands",
+        self.app.add_route("/scada_data/{data_id}/nodes/demands",
                            ScadaDataDemandsHandler(self.scada_data_mgr))
+        self.app.add_route("/scada_data/{data_id}/nodes/quality",
+                           ScadaDataNodesQualityHandler(self.scada_data_mgr))
+        self.app.add_route("/scada_data/{data_id}/nodes/bulk_species",
+                           ScadaDataNodeBulkSpeciesHandler(self.scada_data_mgr))
+        self.app.add_route("/scada_data/{data_id}/links/flows",
+                           ScadaDataFlowsHandler(self.scada_data_mgr))
+        self.app.add_route("/scada_data/{data_id}/links/quality",
+                           ScadaDataLinksQualityHandler(self.scada_data_mgr))
+        self.app.add_route("/scada_data/{data_id}/links/bulk_species",
+                           ScadaDataLinkBulkSpeciesHandler(self.scada_data_mgr))
+        self.app.add_route("/scada_data/{data_id}/links/surface_species",
+                           ScadaDataSurfaceSpeciesHandler(self.scada_data_mgr))
         self.app.add_route("/scada_data/{data_id}/pump_states",
                            ScadaDataPumpStatesHandler(self.scada_data_mgr))
         self.app.add_route("/scada_data/{data_id}/valve_states",
                            ScadaDataValveStatesHandler(self.scada_data_mgr))
         self.app.add_route("/scada_data/{data_id}/tank_volumes",
                            ScadaDataTankVolumesHandler(self.scada_data_mgr))
-        self.app.add_route("/scada_data/{data_id}/node_qualities",
-                           ScadaDataNodesQualityHandler(self.scada_data_mgr))
-        self.app.add_route("/scada_data/{data_id}/link_qualities",
-                           ScadaDataLinksQualityHandler(self.scada_data_mgr))
-        self.app.add_route("/scada_data/{data_id}/node_bulk_species",
-                           ScadaDataNodeBulkSpeciesHandler(self.scada_data_mgr))
-        self.app.add_route("/scada_data/{data_id}/link_bulk_species",
-                           ScadaDataLinkBulkSpeciesHandler(self.scada_data_mgr))
-        self.app.add_route("/scada_data/{data_id}/surface_species",
-                           ScadaDataSurfaceSpeciesHandler(self.scada_data_mgr))
+        self.app.add_route("/scada_data/{data_id}/export/xlsx",
+                           ScadaDataXlsxExportHandler(scada_data_mgr=self.scada_data_mgr))
+        self.app.add_route("/scada_data/{data_id}/export/matlab",
+                           ScadaDataMatlabExportHandler(scada_data_mgr=self.scada_data_mgr))
+        self.app.add_route("/scada_data/{data_id}/export/numpy",
+                           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
         -------
@@ -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: