EPyT-Flow

Provides easy access to water distribution network simulations with a high level interface for generation of hydraulic and water quality scenario data.
https://github.com/waterfutures/epyt-flow

Category: Natural Resources
Sub Category: Water Supply and Quality

Keywords

epanet epanet-python-toolkit hydraulics python simulation water water-distribution-networks

Keywords from Contributors

water

Last synced: about 15 hours ago
JSON representation

Repository metadata

A Python package designed for the easy generation of hydraulic and water quality scenario data of water distribution networks.

• Host: GitHub
• URL: https://github.com/waterfutures/epyt-flow
• Owner: WaterFutures
• License: mit
• Created: 2024-01-04T14:07:18.000Z (over 1 year ago)
• Default Branch: dev
• Last Pushed: 2025-04-21T16:09:51.000Z (6 days ago)
• Last Synced: 2025-04-21T21:37:57.901Z (6 days ago)
• Topics: epanet, epanet-python-toolkit, hydraulics, python, simulation, water, water-distribution-networks
• Language: Python
• Homepage: https://epyt-flow.readthedocs.io/en/stable
• Size: 3.61 MB
• Stars: 29
• Watchers: 7
• Forks: 5
• Open Issues: 0
• Releases: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Citation: CITATION.cff

README.md

brew install gcc@12

pip install epyt-flow

git clone https://github.com/WaterFutures/EPyT-Flow.git
cd EPyT-Flow

pip install -r REQUIREMENTS.txt

pip install .

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()

        # Print & plot sensor readings over the entire simulation
        print(f"Pressure readings: {scada_data.get_data_pressures()}")
        scada_data.plot_pressures()

        print(f"Flow readings: {scada_data.get_data_flows()}")
        scada_data.plot_flows()

@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}
}

Citation (CITATION.cff)

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: 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 our article in the
  Journal of Open Source Software.
preferred-citation:
  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: 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"
  date-published: 2024-11-12
  doi: 10.21105/joss.07104
  issn: 2475-9066
  issue: 103
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 7104
  title: "EPyT-Flow: A Toolkit for Generating Water Distribution Network
    Data"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.07104"
  volume: 9
title: "EPyT-Flow: A Toolkit for Generating Water Distribution Network
  Data"

Owner metadata

• Name: ERC Synergy Grant Water Futures
• Login: WaterFutures
• Email:
• Kind: organization
• Description: Repository for the ERC SyG Water Futures Team
• Website: www.waterfutures.eu
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/149570313?v=4
• Repositories: 1
• Last ynced at: 2024-01-31T13:34:11.822Z
• Profile URL: https://github.com/WaterFutures

GitHub Events

Total

• Create event: 11
• Release event: 10
• Issues event: 8
• Watch event: 12
• Delete event: 1
• Issue comment event: 23
• Push event: 155
• Pull request event: 5
• Fork event: 2

Last Year

• Create event: 11
• Release event: 10
• Issues event: 8
• Watch event: 12
• Delete event: 1
• Issue comment event: 23
• Push event: 155
• Pull request event: 5
• Fork event: 2

Committers metadata

Last synced: 6 days ago

Committer domains:

• ucy.ac.cy: 1
• techfak.de: 1

Issue and Pull Request metadata

Last synced: 1 day ago

Package metadata

• Total packages: 1
• Total downloads:
  • pypi: 540 last-month
• Total dependent packages: 0
• Total dependent repositories: 0
• Total versions: 17
• Total maintainers: 2

Dependencies

Score: 11.048856192546012