Welcome to WaterBenchmarkHub's documentation!
=============================================

WaterBenchmarkHub
+++++++++++++++++

The *WaterBenchmarkHub* is a platform for providing benchmark resources regarding
Water Distribution Networks (WDNs).
The webpage is available at
`https://waterfutures.github.io/WaterBenchmarkHub <https://waterfutures.github.io/WaterBenchmarkHub>`_.

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 called *water-benchmark-hub*.

.. toctree::
    :maxdepth: 1
    :caption: User Guide

    installation
    basicusage

    how_to_contribute


API Reference
=============
.. toctree::
    :maxdepth: 2
    :caption: API Reference

    water_benchmark_hub


Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`