.. ReWaterGAP documentation master file, created by

########################
ReWaterGAP documentation
########################

**Date**: |today| **Version**: 2.2e

**Useful links**:
`Source Repository <https://github.com/HydrologyFrankfurt/ReWaterGAP>`__ |
`Issues & Ideas <https://github.com/HydrologyFrankfurt/ReWaterGAP/issues>`__ |

:mod:`ReWaterGAP` is an open source, GNU-GPL 3-licensed hydrological simulation software for quantifying water flows and storages on all continents of the Earth.

.. grid:: 2
    :gutter: 1

    .. grid-item-card:: Getting started
        :text-align: center
        :link:  getting_started
        :link-type: ref

        :octicon:`play;10em`
        +++
        New to *ReWaterGAP*? Check out the getting started guides. They contain an
        introduction to *ReWaterGAP's* main concepts and links to additional tutorials.


    .. grid-item-card:: User guide
        :text-align: center
        :link:  user_guide
        :link-type: ref

        :octicon:`book;10em`
        +++
        The user guide provides in-depth information on the
        key concepts of ReWaterGAP with useful background information and explanation.

    .. grid-item-card:: Model Processes
        :text-align: center
        :link:  model_processes
        :link-type: ref

        :octicon:`gear;10em`
        +++
        This section contains a detailed description of
        the ReWaterGAP Model. The reference describes how the methods work and which parameters can
        be used.

    .. grid-item-card:: Contributers Guide
        :text-align: center
        :link: contributers_guide
        :link-type: ref

        :octicon:`light-bulb;10em`
        +++
        Saw a typo in the documentation or want to improve functionalities? The contributing guidelines will guide
        you through the process of improving ReWaterGAP.

    .. grid-item-card:: Glossary
        :text-align: center
        :link: glossary
        :link-type: ref

        :octicon:`search;10em`

.. toctree::
    :maxdepth: 1
    :hidden:

    getting_started/index
    user_guide/index
    model_processes/index
    contributers_guide/index
    glossary/index