.. module:: rameau

**********************
|rameau| documentation
**********************

|rameau| is a Python package dedicated to the modelling of river flows and/or
groundwater levels in watersheds of various scales. It relies on a lumped or
semi-distributed model for the simulation of the main components of the surface
water budget in a single watershed or a cluster of watersheds. It is based on
the `Gardenia <https://gardenia.brgm.fr>`_ :cite:p:`2014:thiery_gardenia` and
`Eros <https://eros.brgm.fr>`_ :cite:p:`2018:thiery_logiciel` softwares that
were developed at the `French Geological Survey <https://brgm.fr>`_.

.. grid:: 1 1 2 2 
   :gutter: 2

   .. grid-item-card:: Getting started
      :img-top: _static/index_getting_started.svg
      :link: getting_started/index
      :link-type: doc

      New to |rameau|? Check out the getting started guides. 
      They contain an introduction to |rameau|'s main concepts and
      links to additional tutorials.

   .. grid-item-card:: User guide
      :img-top: _static/index_user_guide.svg
      :link: user_guide/index
      :link-type: doc

      The user guide provides in-depth information on the
      key concepts of |rameau| with useful background
      information and explanations.

   .. grid-item-card:: API reference
      :img-top: _static/index_api.svg
      :link: api
      :link-type: doc

      The reference guide contains a detailed description of the
      |rameau| API. The reference describes how the objects and their
      methods work and which parameters can be used. It assumes that you
      already have an understanding of the key concepts.

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

   getting_started/index
   user_guide/index
   api
   bibliography
   changelog