1. 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.

1.1. 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.

1.2. 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 command line interface documentation.

Once ready, create a directory where you want to perform the simulations. For instance

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

1.3. Create DORiE Input Files

DORiE needs multiple 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, 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 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 as the one below.

Input files

Configuration

config.ini

Boundary

richards_bc.yml, transport_bc.yml

Parameters

richards_param.yml, transport_param.yml