README.md 14 KB
Newer Older
Dion Haefner's avatar
Dion Haefner committed
1 2 3
# Welcome to DORiE!
(__D__UNE-__O__perated __Ri__chards equation solving __E__nvironment)

4 5 6
| Current Release | Current `master` |
| :-------------: | :--------------: |
|  N/A | [![pipeline status](https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/badges/master/pipeline.svg)](https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/commits/master) | 
Dion Haefner's avatar
Dion Haefner committed
7

8
DORiE is a software suite for solving Richard's Equation. The core feature is a C++ PDE-solver powered by [DUNE](https://dune-project.org/) and the [DUNE-PDELab](https://dune-project.org/modules/dune-pdelab/) module. It implements a Discontinous Galerkin (DG) discretization scheme on structured rectangular / cubic and unstructured simplex grids in two and three spatial dimensions, and makes use of advanced features like adaptive grid refinement.
9 10 11

The suite encapsulates a documentation and various tools for program setup, program testing, and output analysis, which are mostly written in Python.

12
DORiE is developed and maintained by the [DORiE Developers](mailto:dorieteam@iup.uni-heidelberg.de) of the [TS-CCEES](http://ts.iup.uni-heidelberg.de/) research group at [IUP Heidelberg](http://www.iup.uni-heidelberg.de/), supervised by [Kurt Roth](http://ts.iup.uni-heidelberg.de/people/prof-dr-kurt-roth/), in collaboration with [Ole Klein](https://conan.iwr.uni-heidelberg.de/people/oklein/) and the [Scientific Computing Group](https://conan.iwr.uni-heidelberg.de/) of [IWR Heidelberg](https://typo.iwr.uni-heidelberg.de/home/). 
13 14 15 16


# Installation Instructions

17

Dion Haefner's avatar
Dion Haefner committed
18
DORiE is a [DUNE](https://dune-project.org/) module and requires several other DUNE modules as well as third party software packages. Installation can be handled manually on your local machine, but for inexperienced users it is recommended to use the deployment software [Docker](https://www.docker.com/) instead.
19

Dion Haefner's avatar
Dion Haefner committed
20
In any case, DORiE is configured, built, and installed via the [DUNE Buildsystem](https://dune-project.org/doc/installation/), using the `dunecontrol` script to handle DUNE-internal dependencies.
21

22
## Docker Installation - Simple Setup
23

24 25 26 27 28 29 30 31
This setup is intended for users who simply want to start computations with DORiE.

Install Docker on your machine. Then, use `git clone` to download the DORiE repository into a suitable directory on your machine. Enter the directory, and call

    docker build -t dorie .

Docker will use a prepared image from Dockerhub and install DORiE into it. You can now call DORiE via the Docker deamon from any directory `dir` on your machine:

Dion Häfner's avatar
Dion Häfner committed
32
    docker run -i -t -v <dir>:/sim dorie <command>
33 34 35

The `-v` option tells docker to mount the directory into the container work directory (`sim`).

Dion Häfner's avatar
Dion Häfner committed
36
In the section 'Usage' you will find a list of possible commands. Note that input and output files can only be placed in the `<dir>` directory or subdirectories thereof. You must use relative paths in the DORiE configuration files.
37

Dion Haefner's avatar
Dion Haefner committed
38

39
## Manual Installation
40

Dion Häfner's avatar
Dion Häfner committed
41 42 43
Installing all packages manually can be quite an effort, but useful for developers who want to have easy access to the source files or users who prefer to run DORiE without the Docker overhead. 

Whenever possible, dependencies should be installed using a package manager, like [APT](https://wiki.ubuntuusers.de/APT/) on Ubuntu or [Homebrew](http://brew.sh/) on Mac. Manual installation on a Windows environment is strongly discouraged!
44 45

### Dependencies
Dion Haefner's avatar
Dion Haefner committed
46
Depending on your system configuration, there will be more packages necessary to install DORiE on your machine. See the step-by-step manual for further details.
47 48 49

| Software | Version/Branch | Comments |
| ---------| -------------- | -------- |
Dion Haefner's avatar
Dion Haefner committed
50
| CMake | >= 2.8.12 |
51 52 53
| GCC | >= 5 |
| git |
| pkg-config |
Dion Haefner's avatar
Dion Haefner committed
54 55
| HDF5 | | with MPI support
| FFTW3 | | with MPI support
56 57
| Python | 3.x |
| pip | 3.x |
58
| MPI | | Tested with OpenMPI
Dion Haefner's avatar
Dion Haefner committed
59
| SuperLU | 4.3 or 5.x |
60 61 62
| [dune-common](https://gitlab.dune-project.org/core/dune-common) | releases/2.5
| [dune-geometry](https://gitlab.dune-project.org/core/dune-geometry) | releases/2.5
| [dune-grid](https://gitlab.dune-project.org/core/dune-grid) | releases/2.5
63
| [dune-uggrid](https://gitlab.dune-project.org/staging/dune-uggrid) | releases/2.5
64 65
| [dune-istl](https://gitlab.dune-project.org/core/dune-istl) | releases/2.5
| [dune-localfunctions](https://gitlab.dune-project.org/core/dune-localfunctions) | releases/2.5
66
| [dune-functions](https://gitlab.dune-project.org/staging/dune-functions) | releases/2.5
67
| [dune-typetree](https://gitlab.dune-project.org/staging/dune-typetree) | releases/2.5
68
| [dune-pdelab](https://gitlab.dune-project.org/pdelab/dune-pdelab) | releases/2.5
69
| [dune-randomfield](https://gitlab.dune-project.org/oklein/dune-randomfield) | master
Lukas Riedel's avatar
Lukas Riedel committed
70 71 72 73 74


### Optional Packages
| Software | Version/Branch | Comments |
| ---------| -------------- | -------- |
75
| [dune-testtools](https://gitlab.dune-project.org/quality/dune-testtools) | master | Handles system tests
76
| [doxygen](http://www.stack.nl/~dimitri/doxygen/) | | Builds documentation
Lukas Riedel's avatar
Lukas Riedel committed
77 78
| [METIS](http://glaros.dtc.umn.edu/gkhome/views/metis) | 5 | For parallel runs
| [ParMETIS](http://glaros.dtc.umn.edu/gkhome/views/metis) | 4 | For parallel runs
79 80


81
### Step-by-step Instructions
82 83
These instructions are suitable for a clean **Ubuntu** or **Mac OS X** setup. The main difference between the two systems is the package manager. Debian-based systems have the APT manager already built in. On Mac, we recommend installing [Homebrew](http://brew.sh/). If you prefer to use [MacPorts](https://www.macports.org/), you need to check if some of the packages require different installation options than displayed here.

84 85
If you installed [Anaconda](https://conda.io/docs/user-guide/install/download.html) on your machine, you don't need to install Python or Pip. Simply skip these packages when using the package managers for installing the software. However, notice the warnings when compiling DORiE below!

86 87 88
1. **Mac OS X** users need to start by installing the Apple Command Line Tools by executing

        xcode-select --install
Dion Haefner's avatar
Dion Haefner committed
89 90

1. Install third party packages:
Lukas Riedel's avatar
Lukas Riedel committed
91
    
92
    **Ubuntu:**
Dion Haefner's avatar
Dion Haefner committed
93
    
Dion Haefner's avatar
Dion Haefner committed
94
        apt update 
95
        apt install cmake doxygen gcc-5 g++-5 gfortran-5 \
Dion Haefner's avatar
Dion Haefner committed
96 97
                    git libatlas-base-dev libfftw3-dev libfftw3-mpi-dev \
                    libfreetype6-dev libhdf5-mpi-dev libopenmpi-dev libpng-dev \
98
                    libsuperlu-dev libxft-dev python3-dev python3-pip
99

100 101 102
    **Mac OS X:**

        brew update
Lukas Riedel's avatar
Lukas Riedel committed
103
        brew install cmake doxygen gcc libpng open-mpi \
104
                    pkg-config python3 superlu
105 106 107
        brew install hdf5 --with-mpi
        brew install fftw --with-mpi

Lukas Riedel's avatar
Lukas Riedel committed
108 109 110 111
1. The parallel linear solver of DORiE can make use of the ParMETIS package. If you want to run DORiE in parallel on multiple processes, additionally install METIS and ParMETIS:

    **Ubuntu:**

112
        apt install libmetis-dev libparmetis-dev
Lukas Riedel's avatar
Lukas Riedel committed
113

114
    **Mac OS X:** _Support is dropped because ParMETIS is currently unavailable from Homebrew._
Lukas Riedel's avatar
Lukas Riedel committed
115 116 117

    **Parallel runs without these two packages are possible but not supported!**

118
3. **Mac OS X** only: 
Lukas Riedel's avatar
Lukas Riedel committed
119
    The Apple Clang compiler shipped with CMake is not suitable for compiling DORiE. Before proceeding, call
120

Lukas Riedel's avatar
Lukas Riedel committed
121 122
        export CC=gcc-7
        export CXX=g++-7
123

124
    to enfore the Homebrew'd GCC compiler. Note that this variable export only lasts for your current terminal session. Always make sure that the configuration tool actually finds GCC instead of the Apple Clang.
125

126 127 128
4. Clone the DUNE modules and DORiE into a suitable folder on your machine. Use `git checkout` to switch to the correct branches (see above). Enter the parent folder, and call

        CMAKE_FLAGS="-DDUNE_PYTHON_VIRTUALENV_SETUP=True -DDUNE_PYTHON_ALLOW_GET_PIP=True" ./dune-common/bin/dunecontrol all
129

130
    to build all DUNE modules. Additionally, you can add `MAKE_FLAGS="-j X"` before the call to `dunecontrol` to compile on `X` processes in parallel.
131

132
    If you installed software into paths not appended to your `PATH` variable, you will have to add `CMAKE_FLAGS` to the call to make sure that CMake finds all packages. Alternatively, you can add a custom options file. See the [DUNE Installation Instructions](https://dune-project.org/doc/installation/) for details. CMake will throw an error if required packages are not found.
133 134

    **Warning:** Anacoda supplies its own version of HDF5 which is typically found first by CMake. If you have Anaconda installed on your machine, add
135

136
        HDF5_ROOT=/usr/local
137

138
    to the `CMAKE_FLAGS` in the call to `dunecontrol` above.
Dion Haefner's avatar
Dion Haefner committed
139
 
Lukas Riedel's avatar
Lukas Riedel committed
140
5. After a successful build you can call the `dorie` wrapper located in `dorie/build-cmake/bin` from anywhere on your machine, but it is more handy to add this location to your search path. You can add the directory to your `PATH` variable by calling
141

Lukas Riedel's avatar
Lukas Riedel committed
142
        PATH=<path/to/>dorie/build-cmake/bin:$PATH
143

Lukas Riedel's avatar
Lukas Riedel committed
144 145 146
    However, this will only last for your current terminal session. Another option is to add this path permanently in your shell configuration file.

    **Installing DUNE and DORiE via `make install` into your usual work environment is strongly discouraged!**
147

148 149 150 151 152 153 154 155 156
### Experimental Features
The local operator implementing Richards equation's discretization supports
multiple scheme settings. Setting these via the config file is disabled by
default. You can enable this feature by reconfiguring DORiE with the CMake flag
`-DEXPERIMENTAL_DG_FEATURES=On`, and rebuilding it.

The configuration settings in the section `[dg.experimental]` will then override
the default settings.

157

158 159 160
## Recommended Third-Party Software

The following software packages are cross-platform, so you should be able to find a release that fits your operating system:
Dion Haefner's avatar
Dion Haefner committed
161 162 163 164

* [Gmsh](http://gmsh.info/): An open-source CAD that can be used to create the `.msh` files used by DORiE to define triangular meshes.
* [ParaView](http://www.paraview.org/): A powerful post-processing tool for VTK files. Offers both visualization and data analysis tools.

165
# Usage
Dion Haefner's avatar
Dion Haefner committed
166

167 168
## Start an interactive Docker session

169
In case you built DORiE using `docker build` and want to start an interactive session, e.g. to build the documentation or do some debugging, you can do so by specifying a custom entrypoint for the container:
170 171 172 173 174

    docker run -i -t --entrypoint=/bin/bash -v <dir>:/sim dorie

This way, an interactive bash session inside the container will be started (instead of directly running DORiE). Note that DUNE and DORiE are located in `/opt/dune`.

175
## Documentation
Dion Haefner's avatar
Dion Haefner committed
176

177
The documentation of the current `master` branch can be found [online](http://dorie-docs.gitballoon.com) (password: `richards`).
Dion Haefner's avatar
Dion Haefner committed
178

179
The documentation can be built after DORiE has been properly configured (i.e., by calling `dunecontrol`). Note that you might have to re-configure DORiE once after installing it, because some dependencies are installed at configure time (e.g. by `dunecontrol --only=dorie configure`). To build the documentation, just run
Dion Haefner's avatar
Dion Haefner committed
180

Dion Haefner's avatar
Dion Haefner committed
181
    dunecontrol --only=dorie make doc
Dion Haefner's avatar
Dion Haefner committed
182

Lukas Riedel's avatar
Lukas Riedel committed
183 184 185 186
or navigate to the `dorie/build-cmake` directory and call

    make doc

187
The documentation files can now be found in the subfolder `dorie/build-cmake/doc`.
Dion Haefner's avatar
Dion Haefner committed
188

189
## Run, DORiE, Run!
Lukas Riedel's avatar
Lukas Riedel committed
190
If you made the DORiE wrapper directory available through your `PATH` variable, you can call it by simply executing
191 192

    dorie <command>
193

Lukas Riedel's avatar
Lukas Riedel committed
194 195 196
You can always find the wrapper in the `dorie/build-cmake/bin` folder of your installation and call it directly with

    <path/to/>dorie/build-cmake/bin/dorie <command>
197

198
To start your first simulation run, create a new directory and enter it. Place some exemplary configuration and boundary condition data files in there by calling
199 200 201

    dorie create

202 203
DORiE encapsulates two routines, the Parameter Field Generator (PFG) and the main program routine. Each takes a single `.ini` configuration file as arguments.

204 205
Tweak the paramters to your liking and then call

206 207 208 209
    dorie pfg <inifile>

to create a parameter field file. Make sure that you instruct the main routine to call the file you just created. Then call

210
    dorie run <inifile>
Dion Haefner's avatar
Dion Haefner committed
211

212
to execute the main program.
Dion Haefner's avatar
Dion Haefner committed
213

214
List all available commands and find further help by executing
Dion Haefner's avatar
Dion Haefner committed
215

Dion Häfner's avatar
Dion Häfner committed
216
    dorie --help
Dion Haefner's avatar
Dion Haefner committed
217

218 219
or

Dion Häfner's avatar
Dion Häfner committed
220
    dorie <command> --help
221

222
## Troubleshooting
Dion Haefner's avatar
Dion Haefner committed
223 224
CMake heavily caches the results of its configuration process. In case you encounter errors or strange behavior, especially after an update, you should delete the DORiE build folder (called `build-cmake` by default) and re-install DORiE using `dunecontrol`.

225
If the problem persists, take a look at the [List of Known Bugs](https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/issues), or create an issue yourself. For problems related to the installation, refer to the sections below.
Dion Haefner's avatar
Dion Haefner committed
226

227
### Debugging
Dion Haefner's avatar
Dion Haefner committed
228
DORiE can be built with debugging flags via CMake. To do so, run
229

Dion Haefner's avatar
Dion Haefner committed
230
    CMAKE_FLAGS="-DCMAKE_BUILD_TYPE=Debug" dunecontrol --only=dorie all
231

Dion Haefner's avatar
Dion Haefner committed
232
After building, a debugger can hook into the executables.
233

Dion Haefner's avatar
Dion Haefner committed
234
**Note:** If no `CMAKE_BUILD_TYPE` is specified during re-configuration, the last configuration build type is used. If no CMake files exist, it defaults to `Release`. You will find the actual value displayed in the final output of CMake.
235

Dion Haefner's avatar
Dion Haefner committed
236
To re-create a release build, configure DORiE with the release build type by executing
237

Dion Haefner's avatar
Dion Haefner committed
238
    CMAKE_FLAGS="-DCMAKE_BUILD_TYPE=Release" dunecontrol --only=dorie all
239

240 241 242 243 244
#### Debugging inside Docker
A debugger needs special security privileges usually not provided by the Docker engine. To enable debugging inside Docker, these privileges have to be granted when calling `docker run` by adding the options

    --security-opt seccomp=unconfined

Dion Häfner's avatar
Dion Häfner committed
245
The debugger `gdb` is pre-installed in the Docker container.
246

247 248 249 250 251 252 253 254 255
### Running System Tests
DORiE includes system tests for comparing its results the ones of ODE solvers or
former versions of itself. They ensure that DORiE is running correctly and
producing the expected results. If you installed DORiE, you have to make sure
that all test executables are built by calling

    dunecontrol --only=dorie make build_tests

You then execute the system tests with
Dion Haefner's avatar
Dion Haefner committed
256

Dion Haefner's avatar
Dion Haefner committed
257
    ARGS="--output-on-failure" dunecontrol --only=dorie make test
Dion Haefner's avatar
Dion Haefner committed
258 259 260

You will be informed whether each test has been passed or failed, and you may find additional output in the DORiE build directory.

261
### Further Help
262
[Open an issue](https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/issues/new), or write to the [DORiE developer mailing list](mailto:dorieteam@iup.uni-heidelberg.de).