This part of the documentation guides through increasingly complicated
use-cases of DORiE. It is intended for users who wish to jump right into using
DORiE, without much knowledge of all its functions. The relevant manual pages
will be linked on the way.
use-cases of DORiE. It is intended for users who are using DORiE for the first time. It explains the usage of the program, how to execute a simulation and how to analyze its results. The relevant manual pages will be linked on the way.
Prerequisites
=============
You need a working application. You can either use the image shipped via
`Docker Hub <https://hub.docker.com/r/dorie/dorie/>`_ or use a local
installation. See the installation manual for details.
Additionally, install Paraview_ for analyzing the output.
installation. See the installation manual for details. Additionally, install Paraview_ for analyzing the output.
.. _Paraview: http://www.paraview.org/download/
.. _Gmsh: http://gmsh.info
Setup DORiE virtual environment
===============================
Before of any proper calculation, it is necessary to set up the DORiE virtual
environment in your terminal. This will allow you to call the DORiE commands
anywhere in your system. For this, follow the instructions in the
:ref:`command line interface documentation <manual/cli>`.
Once ready, create a directory where you want to perform the simulations.
For instance
.. code-block:: bash
mkdir $HOME/Documents/dorie/ex1
cd $HOME/Documents/dorie/ex1
Create DORiE Input Files
========================
DORiE needs multiple input files to work. Let's check them:
* **Configuration File:** (:file:`.ini`) Supplies static information on the
simulation. Have a look at the :doc:`config-file` for more information on
the file syntax, or default and possible values.
* **Parameter File:** (:file:`.yml`) Supplies information on the parameters of
the richards model. Have a look at the :doc:`parameter-file` for more information on
the file syntax, or default and possible values.
* **Boundary Condition Datafile:** (:file:`.bcdat`) Specifying the boundary
conditions dependent on time and space. Name (and path) of the desired file
have to be stated in the Parameter File at key ``boundary.file``.
The :doc:`bcfile` supplies information on how write and use the BC
Datafile.
* *Optional* **Mesh File:** (:file:`.msh`) Representing the grid on which the
simulation will run. This file is only required if ``grid.gridType = simplex``
is chosen in the Parameter File. The Path to the file and it's name will then
have to be stated at ``grid.gridFile``. Use Gmsh_ to easily create such a
file.
Although these files seem to be quite overwhelming at the beginning, you will
notice that most of their parameters will not be modified in most of the
cases. Now, where could you find an example of these input files? The command
.. code-block:: bash
dorie create
will provide the three first mentioned files in your current folder.
Explore them!
.. tip::
Each recipe in this cookbook provides a complete set of input files. You will
find them at the end of the recipe in blocks as the one below.
