Commit c68b47ac authored by Lukas Riedel's avatar Lukas Riedel

Refactor first Cookbook tutorial

* Move into folder '1-infiltration-sand'.
* Remove trailing whitespace from files.
* Add captions to source code.
* Slightly reformulate instructions.
* Add more links to manual.
parent 0de80b22
message(STATUS "Handling cookbook tests")
add_subdirectory("tutorial-1")
\ No newline at end of file
add_subdirectory(1-infiltration-sand)
......@@ -2,14 +2,17 @@ Introduction
************
This part of the documentation guides through increasingly complicated
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.
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 :doc:`installation manual </introduction/readme>` for details. Additionally, install Paraview_ for analyzing the output.
installation. See the :doc:`installation manual </introduction/readme>` for
details. Additionally, install Paraview_ for analyzing the output.
.. _Paraview: http://www.paraview.org/download/
......@@ -17,11 +20,11 @@ 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
:doc:`command line interface documentation </manual/cli>`.
environment in your terminal. This will allow you to call the DORiE commands
anywhere in your system. For this, follow the instructions in the
:doc:`command line interface documentation </manual/cli>`.
Once ready, create a directory where you want to perform the simulations.
Once ready, create a directory where you want to perform the simulations.
For instance
.. code-block:: bash
......@@ -32,9 +35,9 @@ For instance
Create DORiE Input Files
========================
DORiE needs multiple :doc:`input files </introduction/data-io>` to work.
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
DORiE needs multiple :doc:`input files </introduction/data-io>` to work.
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, you can find an example of these input files using the command
.. code-block:: bash
......@@ -42,22 +45,22 @@ cases. Now, you can find an example of these input files using the command
dorie create
which will provide the files for a simple DORiE application in your
which will provide the files for a simple DORiE application in your
current folder. Explore them!
.. tip::
Most recipes in this cookbook provide a complete set of input files for the
specified simulation. You will find them at the end of the recipe in blocks
Most recipes in this cookbook provide a complete set of input files for the
specified simulation. You will find them at the end of the recipe in blocks
as the one below.
.. admonition:: Input files
============= ======================================================================
Configuration :download:`config.ini </default_files/config.ini>`
Boundary :download:`2d_infiltr.bcdat <../default_files/2d_infiltr.bcdat>`,
:download:`3d_infiltr.bcdat </default_files/3d_infiltr.bcdat>`,
:download:`2d_solute.bcdat </default_files/2d_solute.bcdat>`,
Boundary :download:`2d_infiltr.bcdat <../default_files/2d_infiltr.bcdat>`,
:download:`3d_infiltr.bcdat </default_files/3d_infiltr.bcdat>`,
:download:`2d_solute.bcdat </default_files/2d_solute.bcdat>`,
:download:`3d_solute.bcdat </default_files/3d_solute.bcdat>`
Parameters :download:`richards_param.yml </default_files/richards_param.yml>`,
Parameters :download:`richards_param.yml </default_files/richards_param.yml>`,
:download:`transport_param.yml </default_files/transport_param.yml>`
============= ======================================================================
\ No newline at end of file
============= ======================================================================
......@@ -28,7 +28,7 @@ assignment and increment are based on the :doc:`public-api`.
:caption: Cook Book
cookbook/index
cookbook/tutorial-1/tutorial
cookbook/1-infiltration-sand/tutorial
cookbook/restart
.. toctree::
......
......@@ -44,6 +44,8 @@ Templates for the required files can conveniently be generated with the
| | | | |
+----------------------------------------+----------------+------------------------------------------+----------------------------------------------------------------------+
.. _intro-io-output:
Output Files
============
......
......@@ -22,6 +22,8 @@ Initial condition input is controlled entirely via the
interpolator (if applicable), the resulting solution may vary greatly from
the actual input data.
.. _man-initial-types:
Input Types
-----------
This is an overview of all input types for initial conditions.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment