The documentation of DORiE
***************************

.. ifconfig:: deploy_mode

    .. warning::

        This documentation was built automatically for the |branch| branch of the repository
        at |today|.
        Please note that it does not necessarily correspond to the version you are using.


Introduction
=============
Welcome to the DORiE Documentation!

DORiE is a DUNE module for solving the Richards equation. The source code is
available from the `public repository <https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie>`_.
A ready-to-use application is available from `Docker Hub <https://hub.docker.com/r/dorie/dorie/>`_.
DORiE is licensed under the `MIT License <https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/blob/master/LICENSE.md>`_.

Never used DORiE before? Get to learn its features by working through :ref:`quickstart`.
If you have already installed DORiE, jump straight to the :doc:`quickstart-cookbook`
and have a look at the test cases described therein!

You might also want to have a look at both the :doc:`quickstart-parameters`
and :doc:`quickstart-bcfile`, explaining all input parameters and boundary condition
files, respectively.

A complete documentation of the :ref:`DORiE source code <c-reference>`, the
:ref:`Python modules <python-reference>` and the :ref:`CMake files <cmake-reference>`
is provided for DORiE developers.

DORiE complies to `Semantic Versioning <https://semver.org/>`_. Version number
assignment and increment are based on the :doc:`public-api`.

Contents
=========

.. _quickstart:

Quick Start
-----------

.. toctree::
   :maxdepth: 1

   quickstart-installation
   quickstart-cookbook
   quickstart-parameters
   quickstart-bcfile
   python-dorie-wrapper
   public-api

.. _c-reference:

C++ Package Reference
---------------------

.. toctree::
   :maxdepth: 1
   :glob:

   doxygen-*

.. _python-reference:

Python Package Reference
------------------------

.. toctree::
   :maxdepth: 1
   :glob:

   python-*

.. _cmake-reference:


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`