.. _installation:

************
Installation
************

Besides the `webpage <https://waterfutures.github.io/WaterBenchmarkHub>`_, the Water Benchmark Hub
is also available as a Python package called *water-benchmark-hub*.

Note that the *water-benchmark-hub* package supports Python 3.9 - 3.12


PyPI
----

.. code:: bash

    pip install water-benchmark-hub


Git
---

Download or clone the repository:

.. code:: bash

    git clone https://github.com/WaterFutures/WaterBenchmarkHub.git
    cd WaterBenchmarkHub

Install all requirements as listed in `REQUIREMENTS.txt <https://raw.githubusercontent.com/WaterFutures/WaterBenchmarkHub/master/REQUIREMENTS.txt>`_:

.. code:: bash

    pip install -r REQUIREMENTS.txt


Install the toolbox:

.. code:: bash

    pip install .