index.rst 2.44 KB
Newer Older
Dion Haefner's avatar
Dion Haefner committed
1
Introduction
2 3
************

4
This part of the documentation guides through increasingly complicated
5 6 7
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.
Dion Haefner's avatar
Dion Haefner committed
8 9

Prerequisites
10 11
=============

12 13
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
14
installation. See the :doc:`installation manual </markdown/README>` for
15
details. Additionally, install Paraview_ for analyzing the output.
Dion Haefner's avatar
Dion Haefner committed
16 17

.. _Paraview: http://www.paraview.org/download/
18 19 20 21 22

Setup DORiE virtual environment
===============================

Before of any proper calculation, it is necessary to set up the DORiE virtual
23 24 25
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>`.
26

27
Once ready, create a directory where you want to perform the simulations.
28 29 30 31 32 33 34 35 36 37
For instance

.. code-block:: bash

  mkdir $HOME/Documents/dorie/ex1
  cd $HOME/Documents/dorie/ex1

Create DORiE Input Files
========================

38 39 40
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
41
cases. Now, you can find an example of these input files using the command
42 43

.. code-block:: bash
44 45 46 47

    dorie create


48
which will provide the files for a simple DORiE application in your
49
current folder. Explore them!
50 51

.. tip::
52 53
  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
54
  as the one below.
55 56 57 58

.. admonition:: Input files

  =============  ======================================================================
59
  Configuration  :download:`config.ini </default_files/config.ini>`
60 61
  Boundary       :download:`richards_bc.yml </default_files/richards_bc.yml>`,
                 :download:`transport_bc.yml </default_files/transport_bc.yml>`
62
  Parameters     :download:`richards_param.yml </default_files/richards_param.yml>`,
63
                 :download:`transport_param.yml </default_files/transport_param.yml>`
64
  =============  ======================================================================