diff --git a/doc/cookbook/index.rst b/doc/cookbook/index.rst index 4273b504763825545fcb05a601a65c92c097800c..19f86d0a5cc9c1b76792e61da118f4c5333888c0 100644 --- a/doc/cookbook/index.rst +++ b/doc/cookbook/index.rst @@ -9,7 +9,7 @@ Prerequisites You need a working application. You can either use the image shipped via `Docker Hub `_ or use a local -installation. See the installation manual for details. Additionally, install Paraview_ for analyzing the output. +installation. See the :doc:`installation manual ` for details. Additionally, install Paraview_ for analyzing the output. .. _Paraview: http://www.paraview.org/download/ @@ -19,7 +19,7 @@ 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 `. +:doc:`command line interface documentation `. Once ready, create a directory where you want to perform the simulations. For instance @@ -32,46 +32,32 @@ For instance 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. - +DORiE needs multiple :doc:`input files ` 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, where could you find an example of these input files? The command +cases. Now, you can find an example of these input files using the command .. code-block:: bash - dorie create -will provide the three first mentioned files in your current folder. -Explore them! + + dorie create + + +which will provide the files for a simple DORiE application 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. + 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 ` + Configuration :download:`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>`, - :download:`3d_solute.bcdat <../default_files/3d_solute.bcdat>` - Parameters :download:`richards_param.yml <../default_files/richards_param.yml>`, - :download:`transport_param.yml <../default_files/transport_param.yml>` + :download:`3d_infiltr.bcdat `, + :download:`2d_solute.bcdat `, + :download:`3d_solute.bcdat ` + Parameters :download:`richards_param.yml `, + :download:`transport_param.yml ` ============= ====================================================================== \ No newline at end of file