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

epyt_flow/utils.py

@@ -9,6 +9,7 @@ from pathlib import Path
 import requests
 from tqdm import tqdm
 import numpy as np
+import matplotlib
 import matplotlib.pyplot as plt
 
 
@@ -67,7 +68,8 @@ def volume_to_level(tank_volume: float, tank_diameter: float) -> float:
 
 
 def plot_timeseries_data(data: np.ndarray, labels: list[str] = None, x_axis_label: str = None,
-                         y_axis_label: str = None, show: bool = True) -> None:
+                         y_axis_label: str = None, show: bool = True,
+                         ax: matplotlib.axes.Axes = None) -> matplotlib.axes.Axes:
     """
     Plots a single or multiple time series.
 
@@ -91,7 +93,18 @@ def plot_timeseries_data(data: np.ndarray, labels: list[str] = None, x_axis_labe
     show : `bool`, optional
         If True, the plot/figure is shown in a window.
 
+        Only considered when 'ax' is None.
+
         The default is True.
+    ax : `matplotlib.axes.Axes`, optional
+        If not None, 'ax' is used for plotting.
+
+        The default is None.
+
+    Returns
+    -------
+    `matplotlib.axes.Axes`
+        Plot.
     """
     if not isinstance(data, np.ndarray):
         raise TypeError(f"'data' must be an instance of 'numpy.ndarray' but not of '{type(data)}'")
@@ -111,28 +124,37 @@ def plot_timeseries_data(data: np.ndarray, labels: list[str] = None, x_axis_labe
                             f"but not of '{type(y_axis_label)}'")
     if not isinstance(show, bool):
         raise TypeError(f"'show' must be an instance of 'bool' but not of '{type(show)}'")
+    if ax is not None:
+        if not isinstance(ax, matplotlib.axes.Axes):
+            raise TypeError("ax' must be an instance of 'matplotlib.axes.Axes'" +
+                            f"but not of '{type(ax)}'")
 
-    plt.figure()
+    fig = None
+    if ax is None:
+        fig, ax = plt.subplots()
 
     labels = labels if labels is not None else [None] * data.shape[0]
 
     for i in range(data.shape[0]):
-        plt.plot(data[i, :], ".-", label=labels[i])
+        ax.plot(data[i, :], ".-", label=labels[i])
 
     if not any(label is None for label in labels):
-        plt.legend()
+        ax.legend()
 
     if x_axis_label is not None:
-        plt.xlabel(x_axis_label)
+        ax.set_xlabel(x_axis_label)
     if y_axis_label is not None:
-        plt.ylabel(y_axis_label)
+        ax.set_ylabel(y_axis_label)
 
-    if show is True:
+    if show is True and fig is not None:
         plt.show()
 
+    return ax
+
 
 def plot_timeseries_prediction(y: np.ndarray, y_pred: np.ndarray,
-                               confidence_interval: np.ndarray = None, show: bool = True) -> None:
+                               confidence_interval: np.ndarray = None, show: bool = True,
+                               ax: matplotlib.axes.Axes = None) -> matplotlib.axes.Axes:
     """
     Plots the prediction (e.g. forecast) of *single* time series together with the
     ground truth time series. In addition, confidence intervals can be plotted as well.
@@ -151,7 +173,18 @@ def plot_timeseries_prediction(y: np.ndarray, y_pred: np.ndarray,
     show : `bool`, optional
         If True, the plot/figure is shown in a window.
 
+        Only considered when 'ax' is None.
+
         The default is True.
+    ax : `matplotlib.axes.Axes`, optional
+        If not None, 'axes' is used for plotting.
+
+        The default is None.
+
+    Returns
+    -------
+    `matplotlib.axes.Axes`
+        Plot.
     """
     if not isinstance(y_pred, np.ndarray):
         raise TypeError("'y_pred' must be an instance of 'numpy.ndarray' " +
@@ -167,21 +200,29 @@ def plot_timeseries_prediction(y: np.ndarray, y_pred: np.ndarray,
         raise ValueError("'y' must be a 1d array")
     if not isinstance(show, bool):
         raise TypeError(f"'show' must be an instance of 'bool' but not of '{type(show)}'")
+    if ax is not None:
+        if not isinstance(ax, matplotlib.axes.Axes):
+            raise TypeError("ax' must be an instance of 'matplotlib.axes.Axes'" +
+                            f"but not of '{type(ax)}'")
 
-    plt.figure()
+    fig = None
+    if ax is None:
+        fig, ax = plt.subplots()
 
     if confidence_interval is not None:
-        plt.fill_between(range(len(y_pred)),
-                         y_pred - confidence_interval[0],
-                         y_pred + confidence_interval[1],
-                         alpha=0.5)
-    plt.plot(y_pred, ".-", label="Prediction")
-    plt.plot(y, ".-", label="Ground truth")
-    plt.legend()
-
-    if show is True:
+        ax.fill_between(range(len(y_pred)),
+                        y_pred - confidence_interval[0],
+                        y_pred + confidence_interval[1],
+                        alpha=0.5)
+    ax.plot(y_pred, ".-", label="Prediction")
+    ax.plot(y, ".-", label="Ground truth")
+    ax.legend()
+
+    if show is True and fig is not None:
         plt.show()
 
+    return ax
+
 
 def download_if_necessary(download_path: str, url: str, verbose: bool = True) -> None:
     """
@@ -234,6 +275,22 @@ def create_path_if_not_exist(path_in: str) -> None:
     Path(path_in).mkdir(parents=True, exist_ok=True)
 
 
+def pack_zip_archive(f_in: list[str], f_out: str) -> None:
+    """
+    Compresses a given list of files into a .zip archive.
+
+    Parameters
+    ----------
+    f_in : `list[str]`
+        List of files to be compressed into the .zip archive.
+    f_out : `str`
+        Path to the final .zip file.
+    """
+    with zipfile.ZipFile(f_out, "w") as f_zip_out:
+        for f_cur_in in f_in:
+            f_zip_out.write(f_cur_in, compress_type=zipfile.ZIP_DEFLATED)
+
+
 def unpack_zip_archive(f_in: str, folder_out: str) -> None:
     """
     Unpacks a .zip archive.

{epyt_flow-0.1.0.dist-info → epyt_flow-0.2.0.dist-info}/METADATA

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: epyt-flow
-Version: 0.1.0
+Version: 0.2.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
 Project-URL: Homepage, https://github.com/WaterFutures/EPyT-Flow
-Project-URL: Documentation, https://epytflow.readthedocs.io/en/latest/
+Project-URL: Documentation, https://epyt-flow.readthedocs.io/en/latest/
 Project-URL: Repository, https://github.com/WaterFutures/EPyT-Flow.git
 Project-URL: Issues, https://github.com/WaterFutures/EPyT-Flow/issues
 Keywords: epanet,water,networks,hydraulics,quality,simulations
@@ -20,7 +20,7 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: epyt >=1.1.3
+Requires-Dist: epyt >=1.1.6
 Requires-Dist: requests >=2.31.0
 Requires-Dist: scipy >=1.11.4
 Requires-Dist: u-msgpack-python >=2.8.0
@@ -32,6 +32,13 @@ 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/)
+[![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)
+[![Downloads](https://static.pepy.tech/badge/epyt-flow/month)](https://pepy.tech/project/epyt-flow)
+
 # EPyT-Flow -- EPANET Python Toolkit - Flow
 
 EPyT-Flow is a Python package building on top of [EPyT](https://github.com/OpenWaterAnalytics/EPyT) 
@@ -45,11 +52,28 @@ Furthermore, it also provides an environment for developing and testing control
 
 ![](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 overrite the binaries
+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.
 
@@ -113,7 +137,7 @@ if __name__ == "__main__":
 
 ## Documentation
 
-Documentation is available on readthedocs: [https://epytflow.readthedocs.io/en/latest/](https://epytflow.readthedocs.io/en/latest/)
+Documentation is available on readthedocs:[https://epyt-flow.readthedocs.io/en/latest/](https://epyt-flow.readthedocs.io/en/stable)
 
 ## License
 

{epyt_flow-0.1.0.dist-info → epyt_flow-0.2.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
-epyt_flow/VERSION,sha256=6d2FB_S_DG9CRY5BrqgzrQvT9hJycjNe7pv01YVB7Wc,6
-epyt_flow/__init__.py,sha256=jn9If-KyB0-XPSq8iT2_d1oORIs-A7kBojXVk3DzOHU,872
+epyt_flow/VERSION,sha256=H5MN0fEzwfl6lP46y42zQ3LPTAH_2ys_9Mpy-UlBIek,6
+epyt_flow/__init__.py,sha256=0xHKMfJ1mmAcaFVcg723MH0fps8q-7ELCRBaUkX0o8k,1456
 epyt_flow/metrics.py,sha256=kvt42pzZrUR9PSlCyK4uq5kj6UlYHkt7OcCjLnI1RQE,12883
 epyt_flow/serialization.py,sha256=nBcwc3aMUbHF0zW8Nvpc49kKeLPh75blc3gzjKDR1ok,12893
-epyt_flow/topology.py,sha256=MwGH-qz5bulilXcT6u-Gyize38eLvYAOyOmqMG1ID3E,9795
-epyt_flow/utils.py,sha256=06hh8l-g-qQuhThWjAfrjKlr7S3MmFiK34kOnqM7ZsM,9817
-epyt_flow/EPANET/compile.sh,sha256=fA4Y5lYNr1pWKTbCkNa1rk_OOCd4_IJpLknOvlOoTYg,453
+epyt_flow/topology.py,sha256=ou5TMr-PCE7EbiyS2awp0MuC5v6-4Zw5AI63NApnZ_A,10961
+epyt_flow/utils.py,sha256=-1DFDpST_J86AB6pd2ufe_QQ06_tvQqB-5wD8DXacaU,11507
+epyt_flow/EPANET/compile_linux.sh,sha256=wcrDyiB8NkivmaC-X9FI2WxhY3IJqDLiyIbVTv2XEPY,489
 epyt_flow/EPANET/EPANET/SRC_engines/AUTHORS,sha256=yie5yAsEEPY0984PmkSRUdqEU9rVvRSGGWmjxdwCYMU,925
 epyt_flow/EPANET/EPANET/SRC_engines/LICENSE,sha256=8SIIcPPO-ga2HotvptcK3uRccZOEGCeUOIU0Asiq7CU,1070
 epyt_flow/EPANET/EPANET/SRC_engines/Readme_SRC_Engines.txt,sha256=7LWHGbghkYJb18wkIskUzYswRq0ZTMu_m6nV0IfvCOs,1005
@@ -98,15 +98,22 @@ epyt_flow/models/sensor_interpolation_detector.py,sha256=5MBK9WlliGPonrNApf0j9lp
 epyt_flow/rest_api/__init__.py,sha256=4HilmXhdh6H56UHJBB2WUSULlEBUDnI1FPTP11ft3HE,126
 epyt_flow/rest_api/base_handler.py,sha256=Te70M40_oGCAE9zK2EdcUbQZQi7ti5_bGpxvublKvB0,1886
 epyt_flow/rest_api/res_manager.py,sha256=j6-3FUBZNLKM9bCsIDZzSytfDYJbDLRwjn1mIPstTqI,2342
-epyt_flow/rest_api/scada_data_handler.py,sha256=hF1WZ1M8LUnULcaSIVh-F3qwEX4LNHX4FMOc3k_u4lU,16115
-epyt_flow/rest_api/scenario_handler.py,sha256=N6cBNWf9ehucVTzJOOr4yDL2QLJDZtI8jrfmhXmlJHM,11471
-epyt_flow/rest_api/server.py,sha256=C9fmVdA425hfLr-KuA1rIfC1XUy_McZ4CYs0P4gLha4,4928
+epyt_flow/rest_api/server.py,sha256=EeywjhHkqk0PU1vaDTBC1dy6ROROg9sOmRCdp4bphks,7589
+epyt_flow/rest_api/scada_data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+epyt_flow/rest_api/scada_data/data_handlers.py,sha256=VpOQq_jb2d7CuZbPQ1lKfb5dd5UAkBp7H0mEtlDJMzo,10938
+epyt_flow/rest_api/scada_data/export_handlers.py,sha256=m5gM1u7z-KFZ5SCSS0f2Fs6PpAT8FX3FvCS2mp7DmTA,4450
+epyt_flow/rest_api/scada_data/handlers.py,sha256=zX-0kgCwp4F3gQ1oSd4vvNjbc4lJUBvbm3icUlvI1Ls,5391
+epyt_flow/rest_api/scenario/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+epyt_flow/rest_api/scenario/event_handlers.py,sha256=oIqbXWQVqJp0MzE9V4UhGF4fXPF03oWbKEyLhC6g_Ko,3842
+epyt_flow/rest_api/scenario/handlers.py,sha256=bDqMa-jM4hOMVqs0XvQJtHbQDZx9FP40GiEGwW38fGk,12353
+epyt_flow/rest_api/scenario/simulation_handlers.py,sha256=oY1Ch6ZQgYT_5WeE1I7tvGqpDKlT664GHLdmcVKP7ek,5905
+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=mMevycgtnMjV2FDq50WS4HjAdcOlI72Aj6FBX4HZDtc,6508
-epyt_flow/simulation/scenario_config.py,sha256=vkAslXsnJIPZnaSDxe6gUhVuPUm58qwgXTkprmI4fq0,27168
-epyt_flow/simulation/scenario_simulator.py,sha256=nuepi82IidgsyLFCKCDNliCmSBgPqKqYmgTIWrt0XW4,80517
+epyt_flow/simulation/scenario_config.py,sha256=6FUo49qUtWgM0nRJ10-v08Iq9t7pHiYpWW2rtl_1558,26531
+epyt_flow/simulation/scenario_simulator.py,sha256=XAo2f_qV-oaRZ4ysEDUmvL7pWi8BN3a6W_x3P4T-5BI,91659
 epyt_flow/simulation/scenario_visualizer.py,sha256=2gr1o731VLlhA8wQKgrLT94M43FsBNKjG_eucZPHy9A,2186
-epyt_flow/simulation/sensor_config.py,sha256=pCxlkrj-y1Q9TqWAerPctdWvPHWYeWJh0sVLuXoFIDM,58161
+epyt_flow/simulation/sensor_config.py,sha256=qvDK1nYpoDa_k4ahQNV7gkAlKw7y58s_Dn0gCQl-IFQ,71015
 epyt_flow/simulation/events/__init__.py,sha256=tIdqzs7_Cus4X2kbZG4Jl2zs-zsk_4rnajFOCvL0zlI,185
 epyt_flow/simulation/events/actuator_events.py,sha256=2_MPYbYO9As6fMkm5Oy9pjSB9kCvFuKpGu8ykYDAydg,7903
 epyt_flow/simulation/events/event.py,sha256=kARPV20XCAl6zxnJwI9U7ICtZUPACO_rgAmtHm1mGCs,2603
@@ -117,15 +124,15 @@ epyt_flow/simulation/events/sensor_reading_event.py,sha256=rQ-CmdpSUyZzDFYwNUGH2
 epyt_flow/simulation/events/system_event.py,sha256=0KI2iaAaOyC9Y-FIfFVazeKT_4ORQRp26gWyMBUu_3c,2396
 epyt_flow/simulation/scada/__init__.py,sha256=ZFAxJVqwEVsgiyFilFetnb13gPhZg1JEOPWYvKIJT4c,90
 epyt_flow/simulation/scada/advanced_control.py,sha256=Enox02ggt36HdFLX7ZNxgxuqsTEeu9AACHrzU8CXGrg,4489
-epyt_flow/simulation/scada/scada_data.py,sha256=n0tNtVlOBFO7S5y4VvUrg37CD8ApiGsn1o4swnDQYtg,76694
-epyt_flow/simulation/scada/scada_data_export.py,sha256=zDWtDIpkKCwgVxj1FcAcsgXBVu3u5_KlElRaORQ9vJo,9860
+epyt_flow/simulation/scada/scada_data.py,sha256=oNUT10QRd-iTkMG8GMF4PeI0n32eb1-ncId02GWLHhA,76710
+epyt_flow/simulation/scada/scada_data_export.py,sha256=I2ZIsDo5PK-xInTtftmma9c-KfdCWmAP1N_tk2yaNRE,9431
 epyt_flow/uncertainty/__init__.py,sha256=ZRjuJL9rDpWVSdPwObPxFpEmMTcgAl3VmPOsS6cIyGg,89
 epyt_flow/uncertainty/model_uncertainty.py,sha256=DAgyfvdTQvOVMyduuPIpPB_8e3GIMNpehu6kh0jFg0s,13592
 epyt_flow/uncertainty/sensor_noise.py,sha256=zJVULxnxVPSSqc6UW0iwZ9O-HGf9dn4CwScPqf4yCY0,2324
 epyt_flow/uncertainty/uncertainties.py,sha256=X-o7GZUC0HELtzpoXIAJaAeYOw35N05TuRoSmStcCpI,17669
 epyt_flow/uncertainty/utils.py,sha256=gq66c9-QMOxOqI6wgWLyFxjVV0fbG0_8Yzd6mQjNYNo,5315
-epyt_flow-0.1.0.dist-info/LICENSE,sha256=-4hYIY2BLmCkdOv2_PehEwlnMKTCes8_oyIUXjKtkug,1076
-epyt_flow-0.1.0.dist-info/METADATA,sha256=HrTB03cTXnAp8rNwwwiqGYuV-v6GUvBFFbYPSAqIRe0,5103
-epyt_flow-0.1.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-epyt_flow-0.1.0.dist-info/top_level.txt,sha256=Wh_kd7TRL8ownCw3Y3dxx-9C0iTSk6wNauv_NX9JcrY,10
-epyt_flow-0.1.0.dist-info/RECORD,,
+epyt_flow-0.2.0.dist-info/LICENSE,sha256=-4hYIY2BLmCkdOv2_PehEwlnMKTCes8_oyIUXjKtkug,1076
+epyt_flow-0.2.0.dist-info/METADATA,sha256=ysOkPkLty2m6glBTDJawg-drJN1Ei1BJb3kX4td7mJo,6619
+epyt_flow-0.2.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+epyt_flow-0.2.0.dist-info/top_level.txt,sha256=Wh_kd7TRL8ownCw3Y3dxx-9C0iTSk6wNauv_NX9JcrY,10
+epyt_flow-0.2.0.dist-info/RECORD,,

epyt_flow/EPANET/compile.sh

@@ -1,4 +0,0 @@
-#!/bin/bash
-mkdir -p "../customlibs/"
-gcc -w -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 -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