epyt-flow 0.1.1__tar.gz → 0.3.0__tar.gz

epyt_flow-0.3.0/CITATION.cff

@@ -0,0 +1,37 @@
+cff-version: 1.2.0
+authors:
+  - family-names: Artelt
+    given-names: André
+    orcid: "https://orcid.org/0000-0002-2426-3126"
+  - family-names: Kyriakou
+    given-names: Marios S.
+    orcid: "https://orcid.org/0000-0002-2324-8661"
+  - family-names: Demetriades
+    given-names: Marios
+    orcid: "https://orcid.org/0000-0001-7775-4319"
+  - family-names: Vrachimis
+    given-names: Stelios G.
+    orcid: "https://orcid.org/0000-0001-8862-5205"
+  - family-names: Eliades
+    given-names: Demetrios G.
+    orcid: "https://orcid.org/0000-0001-6184-6366"
+  - family-names: Hammer
+    given-names: Barbara
+    orcid: "https://orcid.org/0000-0002-0935-5591"
+  - family-names: Polycarpou
+    given-names: Marios M.
+    orcid: "https://orcid.org/0000-0001-6495-9171"
+contact:
+  - family-names: Artelt
+    given-names: André
+    orcid: "https://orcid.org/0000-0002-2426-3126"
+message: "If you use this software, please cite it using these metadata."
+title: "EPyT-Flow -- EPANET Python Toolkit - Flow"
+keywords:
+  - python
+  - simulation
+  - water
+  - epanet
+  - epanet-python-toolkit
+license: MIT
+repository-code: "https://github.com/WaterFutures/EPyT-Flow"

{epyt_flow-0.1.1/epyt_flow.egg-info → epyt_flow-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: epyt-flow
-Version: 0.1.1
+Version: 0.3.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
@@ -32,8 +32,9 @@ Requires-Dist: falcon>=3.1.3
 Requires-Dist: multiprocess>=0.70.16
 Requires-Dist: psutil
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![pypi](https://img.shields.io/pypi/v/epyt-flow.svg)](https://pypi.org/project/epyt-flow/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/epyt-flow)
 [![build](https://github.com/WaterFutures/EPyT-Flow/actions/workflows/build_tests.yml/badge.svg)](https://github.com/WaterFutures/EPyT-Flow/actions/workflows/build_tests.yml)
 [![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)
@@ -41,6 +42,8 @@ Requires-Dist: psutil
 
 # EPyT-Flow -- EPANET Python Toolkit - Flow
 
+<img src="https://github.com/WaterFutures/EPyT-Flow/blob/main/docs/_static/net1_plot.png?raw=true" align="right" height="230px"/>
+
 EPyT-Flow is a Python package building on top of [EPyT](https://github.com/OpenWaterAnalytics/EPyT) 
 for providing easy access to water distribution network simulations.
 It aims to provide a high-level interface for the easy generation of hydraulic and water quality scenario data.
@@ -50,15 +53,40 @@ and [EPANET-MSX](https://github.com/USEPA/EPANETMSX/).
 EPyT-Flow provides easy access to popular benchmark data sets for event detection and localization.
 Furthermore, it also provides an environment for developing and testing control algorithms.
 
-![](https://github.com/WaterFutures/EPyT-Flow/blob/main/docs/_static/net1_plot.png?raw=true)
+
+## Unique Features
+
+Unique features of EPyT-Flow that make it superior to other (Python) toolboxes are the following:
+
+- High-performance hydraulic and (advanced) water quality simulation
+- High- and low-level interface
+- Object-orientated design that is easy to extend and customize
+- Sensor configurations
+- Wide variety of pre-defined events (e.g. leakages, sensor faults, actuator events, cyber-attacks, etc.)
+- Wide variety of pre-defined types of uncertainties (e.g. model uncertainties)
+- Step-wise simulation and environment for training and evaluating control strategies
+- Serialization module for easy exchange of data and (scenario) configurations
+- REST API to make EPyT-Flow accessible in other applications
+- Access to many WDNs and popular benchmarks (incl. their evaluation)
+
 
 ## Installation
 
 EPyT-Flow supports Python 3.9 - 3.12
 
 Note that [EPANET and EPANET-MSX sources](epyt_flow/EPANET/) are compiled and overwrite the binaries
-shipped by EPyT IF EPyT-Flow is installed on a Linux system. By this we not only aim to achieve
-a better performance of the simulations but also avoid any compatibility problems of pre-compiled binaries.
+shipped by EPyT **IF** EPyT-Flow is installed on a Unix system and the *gcc* compiler is available.
+By this, we not only aim to achieve a better performance of the simulations but also avoid any
+compatibility issues of pre-compiled binaries.
+
+#### Prerequisites for macOS users
+The "true" *gcc* compiler (version 12) is needed which is not the
+*clang* compiler that is shipped with Xcode and is linked to gcc!
+
+The correct version of the "true" *gcc* can be installed via [brew](https://brew.sh/):
+```
+brew install gcc@12
+```
 
 ### PyPI
 

{epyt_flow-0.1.1 → epyt_flow-0.3.0}/README.md

@@ -1,5 +1,6 @@
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![pypi](https://img.shields.io/pypi/v/epyt-flow.svg)](https://pypi.org/project/epyt-flow/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/epyt-flow)
 [![build](https://github.com/WaterFutures/EPyT-Flow/actions/workflows/build_tests.yml/badge.svg)](https://github.com/WaterFutures/EPyT-Flow/actions/workflows/build_tests.yml)
 [![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)
@@ -7,6 +8,8 @@
 
 # EPyT-Flow -- EPANET Python Toolkit - Flow
 
+<img src="https://github.com/WaterFutures/EPyT-Flow/blob/main/docs/_static/net1_plot.png?raw=true" align="right" height="230px"/>
+
 EPyT-Flow is a Python package building on top of [EPyT](https://github.com/OpenWaterAnalytics/EPyT) 
 for providing easy access to water distribution network simulations.
 It aims to provide a high-level interface for the easy generation of hydraulic and water quality scenario data.
@@ -16,15 +19,40 @@ and [EPANET-MSX](https://github.com/USEPA/EPANETMSX/).
 EPyT-Flow provides easy access to popular benchmark data sets for event detection and localization.
 Furthermore, it also provides an environment for developing and testing control algorithms.
 
-![](https://github.com/WaterFutures/EPyT-Flow/blob/main/docs/_static/net1_plot.png?raw=true)
+
+## Unique Features
+
+Unique features of EPyT-Flow that make it superior to other (Python) toolboxes are the following:
+
+- High-performance hydraulic and (advanced) water quality simulation
+- High- and low-level interface
+- Object-orientated design that is easy to extend and customize
+- Sensor configurations
+- Wide variety of pre-defined events (e.g. leakages, sensor faults, actuator events, cyber-attacks, etc.)
+- Wide variety of pre-defined types of uncertainties (e.g. model uncertainties)
+- Step-wise simulation and environment for training and evaluating control strategies
+- Serialization module for easy exchange of data and (scenario) configurations
+- REST API to make EPyT-Flow accessible in other applications
+- Access to many WDNs and popular benchmarks (incl. their evaluation)
+
 
 ## Installation
 
 EPyT-Flow supports Python 3.9 - 3.12
 
 Note that [EPANET and EPANET-MSX sources](epyt_flow/EPANET/) are compiled and overwrite the binaries
-shipped by EPyT IF EPyT-Flow is installed on a Linux system. By this we not only aim to achieve
-a better performance of the simulations but also avoid any compatibility problems of pre-compiled binaries.
+shipped by EPyT **IF** EPyT-Flow is installed on a Unix system and the *gcc* compiler is available.
+By this, we not only aim to achieve a better performance of the simulations but also avoid any
+compatibility issues of pre-compiled binaries.
+
+#### Prerequisites for macOS users
+The "true" *gcc* compiler (version 12) is needed which is not the
+*clang* compiler that is shipped with Xcode and is linked to gcc!
+
+The correct version of the "true" *gcc* can be installed via [brew](https://brew.sh/):
+```
+brew install gcc@12
+```
 
 ### PyPI
 

epyt_flow-0.3.0/epyt_flow/EPANET/compile_linux.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+mkdir -p "../customlibs/"
+gcc -w -O3 -march=native -shared -Wl,-soname,libepanet2_2.so -fPIC -o "../customlibs/libepanet2_2.so" EPANET/SRC_engines/*.c -IEPANET/SRC_engines/include -lc -lm -pthread
+gcc -w -O3 -march=native -fPIC -shared -Wl,-soname,libepanetmsx2_2_0.so -o "../customlibs/libepanetmsx2_2_0.so" -fopenmp -Depanetmsx_EXPORTS -IEPANET-MSX/Src/include -IEPANET/SRC_engines/include EPANET-MSX/Src/*.c -Wl,-rpath=. "../customlibs/libepanet2_2.so" -lm -lgomp -lpthread

epyt_flow-0.3.0/epyt_flow/EPANET/compile_macos.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+mkdir -p "../customlibs/"
+gcc-12 -w -O3 -march=native -dynamiclib -fPIC -install_name libepanet2_2.dylib -o "../customlibs/libepanet2_2.dylib" EPANET/SRC_engines/*.c -IEPANET/SRC_engines/include -lc -lm -pthread
+gcc-12 -w -O3 -march=native -dynamiclib -fPIC -install_name libepanetmsx2_2_0.dylib -o "../customlibs/libepanetmsx2_2_0.dylib" -fopenmp -Depanetmsx_EXPORTS -IEPANET-MSX/Src/include -IEPANET/SRC_engines/include EPANET-MSX/Src/*.c -L'../customlibs' -lepanet2_2 -lm -lgomp -lpthread

epyt_flow-0.3.0/epyt_flow/VERSION

@@ -0,0 +1 @@
+0.3.0

epyt_flow-0.3.0/epyt_flow/__init__.py

@@ -0,0 +1,41 @@
+import subprocess
+import warnings
+import shutil
+import sys
+import os
+
+with open(os.path.join(os.path.dirname(__file__), 'VERSION'), encoding="utf-8") as f:
+    VERSION = f.read().strip()
+
+
+def compile_libraries_unix(lib_epanet_name: str, compile_script_name: str,
+                           gcc_name: str = "gcc") -> None:
+    """Compile EPANET and EPANET-MSX libraries if needed."""
+    path_to_custom_libs = os.path.join(os.path.dirname(__file__), "customlibs")
+    path_to_lib_epanet = os.path.join(path_to_custom_libs, lib_epanet_name)
+    path_to_epanet = os.path.join(os.path.dirname(__file__), "EPANET")
+
+    update = False
+    if os.path.isfile(path_to_lib_epanet):
+        if os.path.getmtime(__file__) > os.path.getmtime(path_to_lib_epanet):
+            update = True
+
+    if not os.path.isfile(path_to_lib_epanet) or update:
+        if shutil.which(gcc_name) is not None:
+            print("Compiling EPANET and EPANET-MSX...")
+            try:
+                subprocess.check_call(f"cd \"{path_to_epanet}\"; bash {compile_script_name}",
+                                      shell=True)
+                print("Done")
+            except subprocess.CalledProcessError as ex:
+                print(f"Compilation failed\n{ex}")
+                warnings.warn("Falling back to pre-compiled library shipped by EPyT.")
+        else:
+            warnings.warn("GCC is not available to compile the required libraries.\n" +
+                          "Falling back to pre-compiled library shipped by EPyT.")
+
+
+if sys.platform.startswith("linux"):
+    compile_libraries_unix("libepanet2_2.so", "compile_linux.sh")
+elif sys.platform.startswith("darwin"):
+    compile_libraries_unix("libepanet2_2.dylib", "compile_macos.sh", gcc_name="gcc-12")

{epyt_flow-0.1.1 → epyt_flow-0.3.0}/epyt_flow/data/benchmarks/leakdb.py

@@ -475,12 +475,10 @@ def load_scenarios(scenarios_id: list[int], use_net1: bool = True,
                                   (int(week_year_pat.shape[0]), int(week_year_pat.shape[1])))
 
         # Create demand
-        if use_net1 is True:
-            base = 1
-        else:
-            base = 0.3  # Avoid negative pressure in Hanoi
+        base = 1
         variation = 0.75 + np.random.normal(0, 0.07)  # from 0 to 1
         dem = base * (year_offset+1) * (week_year_pat*variation+1) * (random+1)
+
         dem = dem.tolist()
         dem_final = []
         for d in dem:
@@ -508,6 +506,7 @@ def load_scenarios(scenarios_id: list[int], use_net1: bool = True,
                 wdn.epanet_api.setTimeHydraulicStep(general_params["hydraulic_time_step"])
                 wdn.epanet_api.setTimeSimulationDuration(general_params["simulation_duration"])
                 wdn.epanet_api.setTimePatternStep(general_params["hydraulic_time_step"])
+                wdn.epanet_api.setFlowUnitsCMH()
 
                 wdn.epanet_api.deletePatternsAll()
 
@@ -542,14 +541,10 @@ def load_scenarios(scenarios_id: list[int], use_net1: bool = True,
             upper = data + z
             return lower + np.random.uniform() * (upper - lower)
 
-    model_uncertainty = ModelUncertainty(pipe_length_uncertainty=MyUniformUncertainty(low=0,
-                                                                                      high=0.25),
-                                         pipe_diameter_uncertainty=MyUniformUncertainty(low=0,
-                                                                                        high=0.25),
-                                         pipe_roughness_uncertainty=MyUniformUncertainty(low=0,
-                                                                                         high=0.25),
-                                         demand_base_uncertainty=MyUniformUncertainty(low=0,
-                                                                                      high=0.25))
+    my_uncertainties = {"pipe_length_uncertainty": MyUniformUncertainty(low=0, high=0.25),
+                        "pipe_roughness_uncertainty": MyUniformUncertainty(low=0, high=0.25),
+                        "demand_base_uncertainty": MyUniformUncertainty(low=0, high=0.25)}
+    model_uncertainty = ModelUncertainty(**my_uncertainties)
 
     # Create sensor config (place pressure and flow sensors everywhere)
     sensor_config = network_config.sensor_config