epyt-flow 0.7.2__py3-none-any.whl → 0.8.0__py3-none-any.whl

epyt_flow/simulation/sensor_config.py

@@ -33,6 +33,7 @@ MASS_UNIT_UG = 5
 MASS_UNIT_MOL = 6
 MASS_UNIT_MMOL = 7
 TIME_UNIT_HRS = 8
+MASS_UNIT_CUSTOM = 9
 
 
 def areaunit_to_id(unit_desc: str) -> int:
@@ -68,10 +69,15 @@ def massunit_to_id(unit_desc: str) -> int:
     `int`
         Corresponding mass unit ID.
     """
-    return {"MG": MASS_UNIT_MG,
-            "UG": MASS_UNIT_UG,
-            "MOL": MASS_UNIT_MOL,
-            "MMOL": MASS_UNIT_MMOL}[unit_desc]
+    mass_unit_dict = {"MG": MASS_UNIT_MG,
+                      "UG": MASS_UNIT_UG,
+                      "MOL": MASS_UNIT_MOL,
+                      "MMOL": MASS_UNIT_MMOL}
+
+    if unit_desc in mass_unit_dict:
+        return mass_unit_dict[unit_desc]
+    else:
+        return MASS_UNIT_CUSTOM
 
 
 def qualityunit_to_id(unit_desc: str) -> int:
@@ -116,10 +122,11 @@ def massunit_to_str(unit_id: int) -> str:
 
         Must be one of the following constant:
 
-            - MASS_UNIT_MG   = 4
-            - MASS_UNIT_UG   = 5
-            - MASS_UNIT_MOL  = 6
-            - MASS_UNIT_MMOL = 7
+            - MASS_UNIT_MG     = 4
+            - MASS_UNIT_UG     = 5
+            - MASS_UNIT_MOL    = 6
+            - MASS_UNIT_MMOL   = 7
+            - MASS_UNIT_CUSTOM = 9
 
     Returns
     -------
@@ -136,6 +143,8 @@ def massunit_to_str(unit_id: int) -> str:
         return "MOL"
     elif unit_id == MASS_UNIT_MMOL:
         return "MMOL"
+    elif unit_id == MASS_UNIT_CUSTOM:
+        return "CUSTOM UNIT"
     else:
         raise ValueError(f"Unknown mass unit ID '{unit_id}'")
 
@@ -698,7 +707,8 @@ class SensorConfig(JsonSerializable):
             raise ValueError("Inconsistency between 'bulk_species_mass_unit' and 'bulk_species'")
         if any(not isinstance(mass_unit, int) for mass_unit in bulk_species_mass_unit):
             raise TypeError("All items in 'bulk_species_mass_unit' must be an instance of 'int'")
-        if any(mass_unit not in [MASS_UNIT_MG, MASS_UNIT_UG, MASS_UNIT_MOL, MASS_UNIT_MMOL]
+        if any(mass_unit not in [MASS_UNIT_MG, MASS_UNIT_UG, MASS_UNIT_MOL, MASS_UNIT_MMOL,
+                                 MASS_UNIT_CUSTOM]
                for mass_unit in bulk_species_mass_unit):
             raise ValueError("Invalid mass unit in 'bulk_species_mass_unit'")
 
@@ -707,7 +717,8 @@ class SensorConfig(JsonSerializable):
                              "and 'surface_species'")
         if any(not isinstance(mass_unit, int) for mass_unit in surface_species_mass_unit):
             raise TypeError("All items in 'surface_species_mass_unit' must be an instance of 'int'")
-        if any(mass_unit not in [MASS_UNIT_MG, MASS_UNIT_UG, MASS_UNIT_MOL, MASS_UNIT_MMOL]
+        if any(mass_unit not in [MASS_UNIT_MG, MASS_UNIT_UG, MASS_UNIT_MOL, MASS_UNIT_MMOL,
+                                 MASS_UNIT_CUSTOM]
                for mass_unit in surface_species_mass_unit):
             raise ValueError("Invalid mass unit in 'surface_species_mass_unit'")
 

{epyt_flow-0.7.2.dist-info → epyt_flow-0.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: epyt-flow
-Version: 0.7.2
+Version: 0.8.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
@@ -20,17 +20,19 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: epyt >=1.2.0
-Requires-Dist: requests >=2.31.0
-Requires-Dist: scipy >=1.11.4
-Requires-Dist: u-msgpack-python >=2.8.0
-Requires-Dist: networkx >=3.2.1
-Requires-Dist: scikit-learn >=1.4.0
-Requires-Dist: tqdm >=4.66.2
-Requires-Dist: openpyxl >=3.1.2
-Requires-Dist: falcon >=3.1.3
-Requires-Dist: multiprocess >=0.70.16
-Requires-Dist: geopandas >=0.14.4
+Requires-Dist: epyt>=1.2.0
+Requires-Dist: requests>=2.31.0
+Requires-Dist: scipy>=1.11.4
+Requires-Dist: u-msgpack-python>=2.8.0
+Requires-Dist: networkx>=3.2.1
+Requires-Dist: scikit-learn>=1.4.0
+Requires-Dist: tqdm>=4.66.2
+Requires-Dist: openpyxl>=3.1.2
+Requires-Dist: falcon>=3.1.3
+Requires-Dist: multiprocess>=0.70.16
+Requires-Dist: geopandas>=0.14.4
+Requires-Dist: svgpath2mpl>=1.0.0
+Requires-Dist: Deprecated>=1.2.14
 Requires-Dist: psutil
 
 [![pypi](https://img.shields.io/pypi/v/epyt-flow.svg)](https://pypi.org/project/epyt-flow/)
@@ -40,6 +42,7 @@ Requires-Dist: psutil
 [![Documentation Status](https://readthedocs.org/projects/epyt-flow/badge/?version=stable)](https://epyt-flow.readthedocs.io/en/stable/?badge=stable)
 [![Downloads](https://static.pepy.tech/badge/epyt-flow)](https://pepy.tech/project/epyt-flow)
 [![Downloads](https://static.pepy.tech/badge/epyt-flow/month)](https://pepy.tech/project/epyt-flow)
+[![DOI](https://joss.theoj.org/papers/10.21105/joss.07104/status.svg)](https://doi.org/10.21105/joss.07104)
 
 # EPyT-Flow -- EPANET Python Toolkit - Flow
 
@@ -121,7 +124,7 @@ pip install .
 ```python
 from epyt_flow.data.benchmarks import load_leakdb_scenarios
 from epyt_flow.simulation import ScenarioSimulator
-from epyt_flow.utils import to_seconds, plot_timeseries_data
+from epyt_flow.utils import to_seconds
 
 
 if __name__ == "__main__":
@@ -144,16 +147,10 @@ if __name__ == "__main__":
 
         # Print & plot sensor readings over the entire simulation
         print(f"Pressure readings: {scada_data.get_data_pressures()}")
-        plot_timeseries_data(scada_data.get_data_pressures().T,
-                             labels=[f"Node {n_id}" for n_id in
-                                     scada_data.sensor_config.pressure_sensors],
-                             x_axis_label="Time (30min steps)",
-                             y_axis_label="Pressure in $m$")
+        scada_data.plot_pressures()
 
         print(f"Flow readings: {scada_data.get_data_flows()}")
-        plot_timeseries_data(scada_data.get_data_flows().T,
-                             x_axis_label="Time (30min steps)",
-                             y_axis_label="Flow rate in $m^3/h$")
+        scada_data.plot_flows()
 ```
 ### Generated plots
 
@@ -194,15 +191,19 @@ MIT license -- see [LICENSE](LICENSE)
 
 If you use this software, please cite it as follows:
 
-```
-@misc{github:epytflow,
-        author = {André Artelt, Marios S. Kyriakou, Stelios G. Vrachimis, Demetrios G. Eliades, Barbara Hammer, Marios M. Polycarpou},
-        title = {EPyT-Flow -- EPANET Python Toolkit - Flow},
-        year = {2024},
-        publisher = {GitHub},
-        journal = {GitHub repository},
-        howpublished = {\url{https://github.com/WaterFutures/EPyT-Flow}}
-    }
+```bibtex
+@article{Artelt2024,
+    doi = {10.21105/joss.07104},
+    url = {https://doi.org/10.21105/joss.07104},
+    year = {2024},
+    publisher = {The Open Journal},
+    volume = {9},
+    number = {103},
+    pages = {7104},
+    author = {André Artelt and Marios S. Kyriakou and Stelios G. Vrachimis and Demetrios G. Eliades and Barbara Hammer and Marios M. Polycarpou},
+    title = {EPyT-Flow: A Toolkit for Generating Water Distribution Network Data},
+    journal = {Journal of Open Source Software}
+}
 ```
 
 ## How to get Support?

{epyt_flow-0.7.2.dist-info → epyt_flow-0.8.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
-epyt_flow/VERSION,sha256=0BdnGL0hTOhHTAbtYcOVyhE_38Ks3YbZqpkztA2bVh4,6
+epyt_flow/VERSION,sha256=pmeA2iMQO-rxJDK0GFCJZrMaKjp4f5RopbbNqoZnwe8,6
 epyt_flow/__init__.py,sha256=KNDiPWiHdB9a5ZF1ipjA1uoq61TwU2ThjaStpvSLBtY,1742
 epyt_flow/metrics.py,sha256=W-dolnrmWfoanyvg-knoe2QMUtFwV1xODp4D4EwsQ00,14261
-epyt_flow/serialization.py,sha256=ltWcLiTw62s0KG2DSgkQBkn6CCkxy9soDGq_ENohkrI,13998
+epyt_flow/serialization.py,sha256=aT4R0vXQgmHaOJ8cyWc8TjcnyFQzwjcHuNbtc1ggM6Y,14191
 epyt_flow/topology.py,sha256=8gqgJrKxw0zY69sIKo4NxrQAoXHP1Ni00U2DV09vR6g,25275
 epyt_flow/utils.py,sha256=GJDktl7ciUPJxqMg9f2nCnQf6DosNd2mxeKOy7omkik,15196
 epyt_flow/EPANET/compile_linux.sh,sha256=wcrDyiB8NkivmaC-X9FI2WxhY3IJqDLiyIbVTv2XEPY,489
@@ -92,7 +92,7 @@ epyt_flow/data/benchmarks/leakdb_data.py,sha256=FNssgMkC1wqWVlaOrrihr4Od9trEZY7K
 epyt_flow/data/benchmarks/water_usage.py,sha256=FLqjff3pha33oEU9ZM3UGPXn9eJJumsJH8Gdj7YFX3A,4778
 epyt_flow/gym/__init__.py,sha256=KNTDtPTEtHwZ4ehHfj9qGw81Z9acFqPIgMzYUzH5_uM,115
 epyt_flow/gym/control_gyms.py,sha256=xbq1gjUC2i-TR_0jXBxXFM24lo_ykHLqMEEpmXPaGq0,1281
-epyt_flow/gym/scenario_control_env.py,sha256=vOadWpjpdcdwcypu0vy0DBkJZODsXnT1tArGQsmsgoM,6789
+epyt_flow/gym/scenario_control_env.py,sha256=SYev3RjPs4-m74V7gCmYrxtAEVEvE-H8I12eQ2NYRj8,12349
 epyt_flow/models/__init__.py,sha256=be5s08y1Tg66SuNYKGz5GnNMHThnQJo8SWJdT9493Kc,75
 epyt_flow/models/event_detector.py,sha256=idR7byBgloo07XEJEyMIwi49VW4wxJErLQtI-tJXWPs,789
 epyt_flow/models/sensor_interpolation_detector.py,sha256=5MBK9WlliGPonrNApf0j9lp-NjwF0iTwPDXx4yv7Fa0,3624
@@ -111,29 +111,30 @@ epyt_flow/rest_api/scenario/simulation_handlers.py,sha256=oY1Ch6ZQgYT_5WeE1I7tvG
 epyt_flow/rest_api/scenario/uncertainty_handlers.py,sha256=uuu6AP11ZZUp2P3Dnukjg5ZTjyYKljlubg1xLN1GnXY,4048
 epyt_flow/simulation/__init__.py,sha256=VGGJqJRUoXZjKJ0-m6KPp3JQqD_1TFW0pofLgkwZJ8M,164
 epyt_flow/simulation/parallel_simulation.py,sha256=VmC7xemjxRB_N0fx1AAQ7ux82tnyTi7jk7jfFpeg7gM,6523
-epyt_flow/simulation/scenario_config.py,sha256=NyadeCihpR4bpsWVPj7J-1DU2w1CEN0pAo2yh0t8Xkg,26751
-epyt_flow/simulation/scenario_simulator.py,sha256=RnPvgEvEZO2rxXPu3jpBGTCjl7LQ6pnSjjPrRhvsMgY,110315
-epyt_flow/simulation/scenario_visualizer.py,sha256=fpj67zl69q-byg7Oxocqhmu1S3P7B3ROCkSYzWyM--0,2187
-epyt_flow/simulation/sensor_config.py,sha256=1YduJTNpEhbndIxRXGGx9_nNxH45RIA9bSNJQFXRatA,92255
-epyt_flow/simulation/events/__init__.py,sha256=tIdqzs7_Cus4X2kbZG4Jl2zs-zsk_4rnajFOCvL0zlI,185
+epyt_flow/simulation/scenario_config.py,sha256=fpG9vs9a7Wedf03cpIQGfB0SNpJlnYyoO6KFLrB2sJU,27188
+epyt_flow/simulation/scenario_simulator.py,sha256=NYivKsSegRuaMkpgodPx9qX4HJqrWYC-zFy4ix7V92g,114708
+epyt_flow/simulation/scenario_visualizer.py,sha256=U7bT4MGEb0IG2Y_HskqdDNBD_d8drcfoMC7hbL3idM4,59259
+epyt_flow/simulation/sensor_config.py,sha256=ZiTFQpyftLSVXd0p5egBxxHe47vD9af_1Tv7ppJR8Y0,92637
+epyt_flow/simulation/events/__init__.py,sha256=gv8ZcvwjJN0Z5MwRXEOVFRNq4X5NPyyqXIQnhBxszQ0,215
 epyt_flow/simulation/events/actuator_events.py,sha256=2_MPYbYO9As6fMkm5Oy9pjSB9kCvFuKpGu8ykYDAydg,7903
 epyt_flow/simulation/events/event.py,sha256=kARPV20XCAl6zxnJwI9U7ICtZUPACO_rgAmtHm1mGCs,2603
-epyt_flow/simulation/events/leakages.py,sha256=g4asHeB3s7mJekY7WTdmTFb6NsoHov8lEciclS3um0I,15275
+epyt_flow/simulation/events/leakages.py,sha256=EBH8i-9yu9F6MRG-rNFGhesk0sJspQ92Q7tQCghk-aY,17767
+epyt_flow/simulation/events/quality_events.py,sha256=Rp8t7aXZU4jGekdIRB85F9I5qtI4QQk3jX2Trfac5hM,7199
 epyt_flow/simulation/events/sensor_faults.py,sha256=XX6k-GJh9RWZ4x54eGj9um-Ir9Eq41tY_9pRSCeYeqc,8447
 epyt_flow/simulation/events/sensor_reading_attack.py,sha256=bo5VavArN0wD5AHbIXJC9NFGZ7KR1uyWE6tBtwj0k9I,7538
 epyt_flow/simulation/events/sensor_reading_event.py,sha256=rQ-CmdpSUyZzDFYwNUGH2jGoj0oyU-aAb-7E8Oshhqw,6785
-epyt_flow/simulation/events/system_event.py,sha256=0KI2iaAaOyC9Y-FIfFVazeKT_4ORQRp26gWyMBUu_3c,2396
+epyt_flow/simulation/events/system_event.py,sha256=X6YGGjm0FTynL19wGST_BLXimGiotdpWdoEphT3496s,2515
 epyt_flow/simulation/scada/__init__.py,sha256=ZFAxJVqwEVsgiyFilFetnb13gPhZg1JEOPWYvKIJT4c,90
 epyt_flow/simulation/scada/advanced_control.py,sha256=5h7dmSMcNlTE7TMZa8gQVnOCGMf7uZy60r9aOfKDxMc,4487
-epyt_flow/simulation/scada/scada_data.py,sha256=hwXoZafhd8vrB3Rug_bldNmMfiAeZhGK-ZNKDrHhJxg,139708
-epyt_flow/simulation/scada/scada_data_export.py,sha256=ohAn6vB9UEHesLBFg1lUZ6OgsYkJjYI4q3iTb-tL0fU,11501
+epyt_flow/simulation/scada/scada_data.py,sha256=qu5KVP0Gnu4r3M_FbLXJekGjlje77h7Ppcrj_ey4UjU,164106
+epyt_flow/simulation/scada/scada_data_export.py,sha256=iSz2SlpjVpK4jcx3iq6Zu7LbEAp_77fRyba_pkc5Pac,11572
 epyt_flow/uncertainty/__init__.py,sha256=ZRjuJL9rDpWVSdPwObPxFpEmMTcgAl3VmPOsS6cIyGg,89
 epyt_flow/uncertainty/model_uncertainty.py,sha256=SD2sYGqj7K0Ys0Lvak4HsbP18A0SmwsK5Mnys_pZilg,14191
 epyt_flow/uncertainty/sensor_noise.py,sha256=zJVULxnxVPSSqc6UW0iwZ9O-HGf9dn4CwScPqf4yCY0,2324
 epyt_flow/uncertainty/uncertainties.py,sha256=jzaAwv5--HGc-H4-SwB0s-pAnzhhFuc06IXck7rC5l8,17902
 epyt_flow/uncertainty/utils.py,sha256=gq66c9-QMOxOqI6wgWLyFxjVV0fbG0_8Yzd6mQjNYNo,5315
-epyt_flow-0.7.2.dist-info/LICENSE,sha256=-4hYIY2BLmCkdOv2_PehEwlnMKTCes8_oyIUXjKtkug,1076
-epyt_flow-0.7.2.dist-info/METADATA,sha256=gGYWF8hn6KSzLqv0_0ACtwyyfTWI9HdXdPS3HmXCeFE,9420
-epyt_flow-0.7.2.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-epyt_flow-0.7.2.dist-info/top_level.txt,sha256=Wh_kd7TRL8ownCw3Y3dxx-9C0iTSk6wNauv_NX9JcrY,10
-epyt_flow-0.7.2.dist-info/RECORD,,
+epyt_flow-0.8.0.dist-info/LICENSE,sha256=-4hYIY2BLmCkdOv2_PehEwlnMKTCes8_oyIUXjKtkug,1076
+epyt_flow-0.8.0.dist-info/METADATA,sha256=rUMgwUMNclREWRm4XLMi5W74guRZltV-Q2vahIDzLXc,9218
+epyt_flow-0.8.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+epyt_flow-0.8.0.dist-info/top_level.txt,sha256=Wh_kd7TRL8ownCw3Y3dxx-9C0iTSk6wNauv_NX9JcrY,10
+epyt_flow-0.8.0.dist-info/RECORD,,

{epyt_flow-0.7.2.dist-info → epyt_flow-0.8.0.dist-info}/WHEEL

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