# EPyT-Flow -- EPANET Python Toolkit - Flow
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.
However, it also provides access to low-level functions by [EPANET](https://github.com/USEPA/EPANET2.2)
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.
## 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
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.
### PyPI
```
pip install epyt-flow
```
### Git
Download or clone the repository:
```
git clone https://github.com/WaterFutures/EPyT-Flow.git
cd EPyT-Flow
```
Install all requirements as listed in [REQUIREMENTS.txt](REQUIREMENTS.txt):
```
pip install -r REQUIREMENTS.txt
```
Install the toolbox:
```
pip install .
```
## Quick Example
<a target="_blank" href="https://colab.research.google.com/github/WaterFutures/EPyT-Flow/blob/main/docs/examples/basic_usage.ipynb">
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
</a>
```python
from epyt_flow.data.benchmarks import load_leakdb_scenarios
from epyt_flow.simulation import ScenarioSimulator
from epyt_flow.utils import to_seconds
if __name__ == "__main__":
# Load first Hanoi scenario from LeakDB
network_config, = load_leakdb_scenarios(scenarios_id=["1"], use_net1=False)
# Create scenario
with ScenarioSimulator(scenario_config=network_config) as sim:
# Set simulation duration to two days
sim.set_general_parameters(simulation_duration=to_seconds(days=2))
# Place pressure sensors at nodes "13", "16", "22", and "30"
sim.set_pressure_sensors(sensor_locations=["13", "16", "22", "30"])
# Place a flow sensor at link/pipe "1"
sim.set_flow_sensors(sensor_locations=["1"])
# Run entire simulation
scada_data = sim.run_simulation()
# Show sensor readings over the entire simulation
print(f"Pressure readings: {scada_data.get_data_pressures()}")
print(f"Flow readings: {scada_data.get_data_flows()}")
```
## Documentation
Documentation is available on readthedocs: [https://epytflow.readthedocs.io/en/latest/](https://epytflow.readthedocs.io/en/latest/)
## License
MIT license -- see [LICENSE](LICENSE)
## How to Cite?
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}}
}
```
## How to Contribute?
Contributions (e.g. creating issues, pull-requests, etc.) are welcome -- please make sure to read the [code of conduct](CODE_OF_CONDUCT.md) and follow the [developers' guidelines](DEVELOPERS.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "epyt-flow",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "epanet, water, networks, hydraulics, quality, simulations",
"author": null,
"author_email": "Andr\u00e9 Artelt <aartelt@techfak.uni-bielefeld.de>, \"Marios S. Kyriakou\" <kiriakou.marios@ucy.ac.cy>, \"Stelios G. Vrachimis\" <vrachimis.stelios@ucy.ac.cy>",
"download_url": "https://files.pythonhosted.org/packages/76/42/87d57053be3f955ac2fc4edf9ee4da0bb49c15bd4cd3fae448191918e78e/epyt_flow-0.1.0.tar.gz",
"platform": null,
"description": "# EPyT-Flow -- EPANET Python Toolkit - Flow\n\nEPyT-Flow is a Python package building on top of [EPyT](https://github.com/OpenWaterAnalytics/EPyT) \nfor providing easy access to water distribution network simulations.\nIt aims to provide a high-level interface for the easy generation of hydraulic and water quality scenario data.\nHowever, it also provides access to low-level functions by [EPANET](https://github.com/USEPA/EPANET2.2) \nand [EPANET-MSX](https://github.com/USEPA/EPANETMSX/).\n\nEPyT-Flow provides easy access to popular benchmark data sets for event detection and localization.\nFurthermore, it also provides an environment for developing and testing control algorithms.\n\n\n\n## Installation\n\nEPyT-Flow supports Python 3.9 - 3.12\n\nNote that [EPANET and EPANET-MSX sources](epyt_flow/EPANET/) are compiled and overrite the binaries\nshipped by EPyT IF EPyT-Flow is installed on a Linux system. By this we not only aim to achieve\na better performance of the simulations but also avoid any compatibility problems of pre-compiled binaries.\n\n### PyPI\n\n```\npip install epyt-flow\n```\n\n### Git\nDownload or clone the repository:\n```\ngit clone https://github.com/WaterFutures/EPyT-Flow.git\ncd EPyT-Flow\n```\n\nInstall all requirements as listed in [REQUIREMENTS.txt](REQUIREMENTS.txt):\n```\npip install -r REQUIREMENTS.txt\n```\n\nInstall the toolbox:\n```\npip install .\n```\n\n## Quick Example\n\n<a target=\"_blank\" href=\"https://colab.research.google.com/github/WaterFutures/EPyT-Flow/blob/main/docs/examples/basic_usage.ipynb\">\n<img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/>\n</a>\n\n```python\nfrom epyt_flow.data.benchmarks import load_leakdb_scenarios\nfrom epyt_flow.simulation import ScenarioSimulator\nfrom epyt_flow.utils import to_seconds\n\n\nif __name__ == \"__main__\":\n # Load first Hanoi scenario from LeakDB\n network_config, = load_leakdb_scenarios(scenarios_id=[\"1\"], use_net1=False)\n\n # Create scenario\n with ScenarioSimulator(scenario_config=network_config) as sim:\n # Set simulation duration to two days\n sim.set_general_parameters(simulation_duration=to_seconds(days=2))\n\n # Place pressure sensors at nodes \"13\", \"16\", \"22\", and \"30\"\n sim.set_pressure_sensors(sensor_locations=[\"13\", \"16\", \"22\", \"30\"])\n\n # Place a flow sensor at link/pipe \"1\"\n sim.set_flow_sensors(sensor_locations=[\"1\"])\n\n # Run entire simulation\n scada_data = sim.run_simulation()\n\n # Show sensor readings over the entire simulation\n print(f\"Pressure readings: {scada_data.get_data_pressures()}\")\n print(f\"Flow readings: {scada_data.get_data_flows()}\")\n```\n\n## Documentation\n\nDocumentation is available on readthedocs: [https://epytflow.readthedocs.io/en/latest/](https://epytflow.readthedocs.io/en/latest/)\n\n## License\n\nMIT license -- see [LICENSE](LICENSE)\n\n## How to Cite?\n\nIf you use this software, please cite it as follows:\n\n```\n@misc{github:epytflow,\n author = {Andr\u00e9 Artelt, Marios S. Kyriakou, Stelios G. Vrachimis, Demetrios G. Eliades, Barbara Hammer, Marios M. Polycarpou},\n title = {EPyT-Flow -- EPANET Python Toolkit - Flow},\n year = {2024},\n publisher = {GitHub},\n journal = {GitHub repository},\n howpublished = {\\url{https://github.com/WaterFutures/EPyT-Flow}}\n }\n```\n\n## How to Contribute?\n\nContributions (e.g. creating issues, pull-requests, etc.) are welcome -- please make sure to read the [code of conduct](CODE_OF_CONDUCT.md) and follow the [developers' guidelines](DEVELOPERS.md).\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "EPyT-Flow -- EPANET Python Toolkit - Flow",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://epytflow.readthedocs.io/en/latest/",
"Homepage": "https://github.com/WaterFutures/EPyT-Flow",
"Issues": "https://github.com/WaterFutures/EPyT-Flow/issues",
"Repository": "https://github.com/WaterFutures/EPyT-Flow.git"
},
"split_keywords": [
"epanet",
" water",
" networks",
" hydraulics",
" quality",
" simulations"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6b85b0adf3a33424e31fa50a805927bfaef4819007bcd7c2fdd9df5ba504e604",
"md5": "418e7c5f625ac1f0812da04d68b9e67d",
"sha256": "22f3383ff20bd702241217a8f8f5d06248df01608bac32e452822a1fe99a7fb8"
},
"downloads": -1,
"filename": "epyt_flow-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "418e7c5f625ac1f0812da04d68b9e67d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 464915,
"upload_time": "2024-05-10T06:03:13",
"upload_time_iso_8601": "2024-05-10T06:03:13.583614Z",
"url": "https://files.pythonhosted.org/packages/6b/85/b0adf3a33424e31fa50a805927bfaef4819007bcd7c2fdd9df5ba504e604/epyt_flow-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "764287d57053be3f955ac2fc4edf9ee4da0bb49c15bd4cd3fae448191918e78e",
"md5": "f1977f56e77ce7d512fed2199ef285d7",
"sha256": "b0b03f8fd77c88c7658e4c955a57d5f43ecfe575548e2b9a6b0d0d3837935bcf"
},
"downloads": -1,
"filename": "epyt_flow-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "f1977f56e77ce7d512fed2199ef285d7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 406921,
"upload_time": "2024-05-10T06:03:16",
"upload_time_iso_8601": "2024-05-10T06:03:16.727507Z",
"url": "https://files.pythonhosted.org/packages/76/42/87d57053be3f955ac2fc4edf9ee4da0bb49c15bd4cd3fae448191918e78e/epyt_flow-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-10 06:03:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "WaterFutures",
"github_project": "EPyT-Flow",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "epyt-flow"
}
JSON
