# WaterBenchmarkHub
The [*WaterBenchmarkHub*](https://waterfutures.github.io/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](https://waterfutures.github.io/WaterBenchmarkHub)
-- see [docs/](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](https://waterbenchmarkhub.readthedocs.io/en/latest/how_to_contribute.html).
## 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](REQUIREMENTS.txt):
```
pip install -r REQUIREMENTS.txt
```
Install the benchmark hub:
```
pip install .
```
## Quick Example
```python
from water_benchmark_hub 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/](https://waterbenchmarkhub.readthedocs.io/en/stable/)
## License
MIT license -- see [LICENSE](LICENSE)
## How to Cite?
If you use the WaterBenchmarkHub in your research, please cite it as follows:
```
@misc{github:water_benchmark_hub,
author = {André Artelt and Katharina Giese},
title = {WaterBenchmarkHub},
year = {2024},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\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](https://waterbenchmarkhub.readthedocs.io/en/latest/how_to_contribute.html),
the [code of conduct](CODE_OF_CONDUCT.md) and follow the [developers' guidelines](DEVELOPERS.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "water-benchmark-hub",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "water, networks, benchmarks, data",
"author": null,
"author_email": "Andr\u00e9 Artelt <aartelt@techfak.uni-bielefeld.de>",
"download_url": "https://files.pythonhosted.org/packages/de/60/90abf323916c576d2781d845eb01f3dee9c596b8fa1e3680cd88b108e44d/water_benchmark_hub-0.2.1.tar.gz",
"platform": null,
"description": "# WaterBenchmarkHub\n\nThe [*WaterBenchmarkHub*](https://waterfutures.github.io/WaterBenchmarkHub) is a platform for\naccessing and sharing Water Distribution Network (WDN) benchmarks and data sets.\nThe webpage is available at\n[https://waterfutures.github.io/WaterBenchmarkHub](https://waterfutures.github.io/WaterBenchmarkHub)\n-- see [docs/](docs/) for details such as source code, etc.\n\nThe availability and accessibility of benchmarks are essential for reproducible research as well as\nfor accelerating scientific progress.\nA benchmark is a *verified* data set or resource (e.g. a water distribution network) together with an\nevaluation functions that can evaluate different algorithms/methods under the same criteria.\n\nThe WaterBenchmarkHub is also available as a Python package *water-benchmark-hub*.\n\n## Call for Contributions\n\nIf you have a benchmark (resource) that is not yet available in the *WaterBenchmarkHub*,\nplease either create a new issue or read on\n[How to Contribute](https://waterbenchmarkhub.readthedocs.io/en/latest/how_to_contribute.html).\n\n## Installation of the Python Package\n\nThe Python package supports Python 3.9 - 3.13\n\n### PyPI\n\n```\npip install water-benchmark-hub\n```\n\n### Git\nDownload or clone the repository:\n```\ngit clone https://github.com/WaterFutures/WaterBenchmarkHub.git\ncd WaterBenchmarkHub\n```\n\nInstall all requirements as listed in [REQUIREMENTS.txt](REQUIREMENTS.txt):\n```\npip install -r REQUIREMENTS.txt\n```\n\nInstall the benchmark hub:\n```\npip install .\n```\n\n## Quick Example\n\n```python\nfrom water_benchmark_hub import load\n\n\nif __name__ == \"__main__\":\n # Load the GECCO Water Quality 2019 benchmark\n benchmark = load(\"GECCO-WaterQuality2019\")\n\n # Load data set\n data = benchmark.load_data(return_X_y=True)\n\n # Show number of samples\n X_train, y_train = data[\"train\"]\n X_val, y_val = data[\"validation\"]\n X_test, y_test = data[\"test\"]\n print(X_train.shape, X_val.shape, X_test.shape)\n```\n\n## Documentation\n\nDocumentation is available on readthedocs:\n[https://waterbenchmarkhub.readthedocs.io/en/stable/](https://waterbenchmarkhub.readthedocs.io/en/stable/)\n\n## License\n\nMIT license -- see [LICENSE](LICENSE)\n\n## How to Cite?\n\nIf you use the WaterBenchmarkHub in your research, please cite it as follows:\n\n```\n@misc{github:water_benchmark_hub,\n author = {Andr\u00e9 Artelt and Katharina Giese},\n title = {WaterBenchmarkHub},\n year = {2024},\n publisher = {GitHub},\n journal = {GitHub repository},\n howpublished = {\\url{https://github.com/WaterFutures/WaterBenchmarkHub}}\n }\n```\n\n## How to get Support?\n\nIf 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.\n\n## How to Contribute?\n\nContributions (e.g. creating issues, pull-requests, etc.) are welcome -- please make sure to read\n[How to Contribute](https://waterbenchmarkhub.readthedocs.io/en/latest/how_to_contribute.html),\nthe [code of conduct](CODE_OF_CONDUCT.md) and follow the [developers' guidelines](DEVELOPERS.md).\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "WaterBenchmarkHub",
"version": "0.2.1",
"project_urls": {
"Documentation": "https://water-benchmark-hub.readthedocs.io/en/latest/",
"Homepage": "https://github.com/WaterFutures/WaterBenchmarkHub",
"Issues": "https://github.com/WaterFutures/WaterBenchmarkHub/issues",
"Repository": "https://github.com/WaterFutures/WaterBenchmarkHub.git"
},
"split_keywords": [
"water",
" networks",
" benchmarks",
" data"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f498593705aa506e1209e6f0b0b2afe1809ae32f72cd1995896c4030c2bb1e2b",
"md5": "30357c89bb0d657426ce527b57a02df7",
"sha256": "27a7c7f67dbbbb083bad96baa06c071a8be65e3ad7424e9ed76421fe20ee30a9"
},
"downloads": -1,
"filename": "water_benchmark_hub-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "30357c89bb0d657426ce527b57a02df7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 104946,
"upload_time": "2025-01-13T13:02:59",
"upload_time_iso_8601": "2025-01-13T13:02:59.688547Z",
"url": "https://files.pythonhosted.org/packages/f4/98/593705aa506e1209e6f0b0b2afe1809ae32f72cd1995896c4030c2bb1e2b/water_benchmark_hub-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "de6090abf323916c576d2781d845eb01f3dee9c596b8fa1e3680cd88b108e44d",
"md5": "b6e96bdbb6b4a903f4711c0278fc7be4",
"sha256": "163f89e2f290a3bd5db1be32cdb8e71660146de74f4b7bc7b08efa6d6fb25221"
},
"downloads": -1,
"filename": "water_benchmark_hub-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "b6e96bdbb6b4a903f4711c0278fc7be4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 290939,
"upload_time": "2025-01-13T13:03:02",
"upload_time_iso_8601": "2025-01-13T13:03:02.379375Z",
"url": "https://files.pythonhosted.org/packages/de/60/90abf323916c576d2781d845eb01f3dee9c596b8fa1e3680cd88b108e44d/water_benchmark_hub-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-13 13:03:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "WaterFutures",
"github_project": "WaterBenchmarkHub",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "water-benchmark-hub"
}
JSON
