Data

Tools

Indexes

Applications

Experiments

Open Source Science

water-benchmark-hub

A platform for accessing and sharing Water Distribution Network benchmarks and data sets

https://github.com/waterfutures/waterbenchmarkhub

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 1 DOI reference(s) in README
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.3%) to scientific vocabulary

Keywords

benchmarks data epanet epanet-python-toolkit python simulation water water-distribution-networks
Last synced: 6 months ago · JSON representation ·

Repository

A platform for accessing and sharing Water Distribution Network benchmarks and data sets

Basic Info
Statistics
  • Stars: 13
  • Watchers: 3
  • Forks: 2
  • Open Issues: 0
  • Releases: 5
Topics
benchmarks data epanet epanet-python-toolkit python simulation water water-distribution-networks
Created almost 2 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

WaterBenchmarkHub

pypi License: MIT PyPI - Python Version Documentation Status Downloads Downloads

The WaterBenchmarkHub is a platform for accessing and sharing Water Distribution Network (WDN) benchmarks and data sets. The webpage is available at https://waterfutures.github.io/WaterBenchmarkHub -- see docs/ for details such as source code, etc.

The availability and accessibility of benchmarks are essential for reproducible research as well as for accelerating scientific progress. A benchmark is a verified data set or resource (e.g. a water distribution network) together with an evaluation functions that can evaluate different algorithms/methods under the same criteria.

The WaterBenchmarkHub is also available as a Python package water-benchmark-hub.

Call for Contributions

If you have a benchmark (resource) that is not yet available in the WaterBenchmarkHub, please either create a new issue or read on How to Contribute.

Installation of the Python Package

The Python package supports Python 3.9 - 3.13

PyPI

pip install water-benchmark-hub

Git

Download or clone the repository: git clone https://github.com/WaterFutures/WaterBenchmarkHub.git cd WaterBenchmarkHub

Install all requirements as listed in REQUIREMENTS.txt: pip install -r REQUIREMENTS.txt

Install the benchmark hub: pip install .

Quick Example

```python from waterbenchmarkhub import load

if name == "main": # Load the GECCO Water Quality 2019 benchmark benchmark = load("GECCO-WaterQuality2019")

# Load data set
data = benchmark.load_data(return_X_y=True)

# Show number of samples
X_train, y_train = data["train"]
X_val, y_val = data["validation"]
X_test, y_test = data["test"]
print(X_train.shape, X_val.shape, X_test.shape)

```

Documentation

Documentation is available on readthedocs: https://waterbenchmarkhub.readthedocs.io/en/stable/

License

MIT license -- see LICENSE

How to Cite?

If you use the WaterBenchmarkHub in your research, please cite it as follows:

@article{Artelt_Giese_Vrachimis_Eliades_Polycarpou_Hammer_2025, title={{The WaterBenchmarkHub: A Platform for Benchmarks in Water Distribution Networks}}, DOI={10.15131/SHEF.DATA.29921051.V1}, journal={21st Computing and Control in the Water Industry Conference (CCWI 2025) at the University of Sheffield (1st - 3rd September 2025)}, publisher={The University of Sheffield}, author={Artelt, André and Giese, Katharina and Vrachimis, Stelios G. and Eliades, Demetris G. and Polycarpou, Marios M. and Hammer, Barbara}, year={2025}, url = {https://github.com/WaterFutures/WaterBenchmarkHub} }

How to get Support?

If you come across any bug or need assistance please feel free to open a new issue if none of the existing issues answers your questions.

How to Contribute?

Contributions (e.g. creating issues, pull-requests, etc.) are welcome -- please make sure to read How to Contribute, the code of conduct and follow the developers' guidelines.

Owner

  • Name: ERC Synergy Grant Water Futures
  • Login: WaterFutures
  • Kind: organization

Repository for the ERC SyG Water Futures Team

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: Giese
    given-names: Katharina
  - 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: Polycarpou
    given-names: Marios M.
    orcid: "https://orcid.org/0000-0001-6495-9171"
  - family-names: Hammer
    given-names: Barbara
    orcid: "https://orcid.org/0000-0002-0935-5591"
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: "The WaterBenchmarkHub: A Platform for Benchmarks in Water Distribution Networks"
keywords:
  - python
  - simulation
  - water
  - epanet
  - epanet-python-toolkit
license: MIT
repository-code: "https://github.com/WaterFutures/WaterBenchmarkHub"

GitHub Events

Total
  • Release event: 4
  • Watch event: 9
  • Delete event: 1
  • Issue comment event: 2
  • Push event: 39
  • Pull request event: 3
  • Fork event: 1
  • Create event: 4
Last Year
  • Release event: 4
  • Watch event: 9
  • Delete event: 1
  • Issue comment event: 2
  • Push event: 39
  • Pull request event: 3
  • Fork event: 1
  • Create event: 4

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 8
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 2.0
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 4
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 1.25
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • gieseka (8)
  • kurceliana (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 30 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 5
  • Total maintainers: 1
pypi.org: water-benchmark-hub

WaterBenchmarkHub

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 30 Last month
Rankings
Dependent packages count: 10.2%
Average: 33.8%
Dependent repos count: 57.4%
Maintainers (1)
andreArtelt
Last synced: 6 months ago

Dependencies

pyproject.toml pypi
readthedocs/requirements.txt pypi
  • ipykernel >=6.29.3
  • nbsphinx >=0.9.3
  • sphinx >=7.2.6
  • sphinx-rtd-theme >=2.0.0
setup.py pypi
docs/Gemfile rubygems
  • github-pages >= 0 development
  • hawkins >= 0 development
  • jekyll-feed >= 0 development
  • jekyll-sitemap >= 0 development
docs/Gemfile.lock rubygems
  • activesupport 7.1.3.3
  • addressable 2.8.6
  • base64 0.2.0
  • bigdecimal 3.1.8
  • bundler 2.1.4
  • coffee-script 2.4.1
  • coffee-script-source 1.12.2
  • colorator 1.1.0
  • commonmarker 0.23.10
  • concurrent-ruby 1.2.3
  • connection_pool 2.4.1
  • dnsruby 1.72.1
  • drb 2.2.1
  • em-websocket 0.5.3
  • ethon 0.16.0
  • eventmachine 1.2.7
  • execjs 2.9.1
  • faraday 2.8.1
  • faraday-net_http 3.0.2
  • ffi 1.16.3
  • forwardable-extended 2.6.0
  • gemoji 4.1.0
  • github-pages 231
  • github-pages-health-check 1.18.2
  • hawkins 2.0.5
  • html-pipeline 2.14.3
  • http_parser.rb 0.8.0
  • i18n 1.14.5
  • jekyll 3.9.5
  • jekyll-avatar 0.8.0
  • jekyll-coffeescript 1.2.2
  • jekyll-commonmark 1.4.0
  • jekyll-commonmark-ghpages 0.4.0
  • jekyll-default-layout 0.1.5
  • jekyll-feed 0.17.0
  • jekyll-gist 1.5.0
  • jekyll-github-metadata 2.16.1
  • jekyll-include-cache 0.2.1
  • jekyll-mentions 1.6.0
  • jekyll-optional-front-matter 0.3.2
  • jekyll-paginate 1.1.0
  • jekyll-readme-index 0.3.0
  • jekyll-redirect-from 0.16.0
  • jekyll-relative-links 0.6.1
  • jekyll-remote-theme 0.4.3
  • jekyll-sass-converter 1.5.2
  • jekyll-seo-tag 2.8.0
  • jekyll-sitemap 1.4.0
  • jekyll-swiss 1.0.0
  • jekyll-theme-architect 0.2.0
  • jekyll-theme-cayman 0.2.0
  • jekyll-theme-dinky 0.2.0
  • jekyll-theme-hacker 0.2.0
  • jekyll-theme-leap-day 0.2.0
  • jekyll-theme-merlot 0.2.0
  • jekyll-theme-midnight 0.2.0
  • jekyll-theme-minimal 0.2.0
  • jekyll-theme-modernist 0.2.0
  • jekyll-theme-primer 0.6.0
  • jekyll-theme-slate 0.2.0
  • jekyll-theme-tactile 0.2.0
  • jekyll-theme-time-machine 0.2.0
  • jekyll-titles-from-headings 0.5.3
  • jekyll-watch 2.2.1
  • jemoji 0.13.0
  • kramdown 2.4.0
  • kramdown-parser-gfm 1.1.0
  • liquid 4.0.4
  • listen 3.9.0
  • mercenary 0.3.6
  • mini_portile2 2.8.6
  • minima 2.5.1
  • minitest 5.23.1
  • mutex_m 0.2.0
  • nokogiri 1.15.6
  • octokit 4.25.1
  • pathutil 0.16.2
  • public_suffix 5.0.5
  • racc 1.8.0
  • rb-fsevent 0.11.2
  • rb-inotify 0.11.1
  • rexml 3.2.8
  • rouge 3.30.0
  • ruby2_keywords 0.0.5
  • rubyzip 2.3.2
  • safe_yaml 1.0.5
  • sass 3.7.4
  • sass-listen 4.0.0
  • sawyer 0.9.2
  • simpleidn 0.2.3
  • strscan 3.1.0
  • terminal-table 1.8.0
  • typhoeus 1.4.1
  • tzinfo 2.0.6
  • unicode-display_width 1.8.0