README.md 13.9 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
[![build status](https://zwackelmann.iup.uni-heidelberg.de:10443/dorie/dorie/badges/master/build.svg)](https://zwackelmann.iup.uni-heidelberg.de:10443/dorie/dorie/commits/master)
Dion Haefner's avatar
Dion Haefner committed
5

6
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.
7 8 9

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

10
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/). 
11 12 13 14


# Installation Instructions

15

Dion Haefner's avatar
Dion Haefner committed
16
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.
17

Dion Haefner's avatar
Dion Haefner committed
18
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.
19

20
## Docker Installation - Simple Setup
21

22 23 24 25 26 27 28 29
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
30
    docker run -i -t -v <dir>:/sim dorie <command>
31 32 33

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

Dion Häfner's avatar
Dion Häfner committed
34
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.
35

Dion Haefner's avatar
Dion Haefner committed
36

37
## Manual Installation
38

Dion Häfner's avatar
Dion Häfner committed
39 40 41
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!
42 43

### Dependencies
Dion Haefner's avatar
Dion Haefner committed
44
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.
45 46 47

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


### Optional Packages
| Software | Version/Branch | Comments |
| ---------| -------------- | -------- |
73
| [dune-testtools](https://gitlab.dune-project.org/quality/dune-testtools) | master | Handles system tests
74
| [doxygen](http://www.stack.nl/~dimitri/doxygen/) | | Builds documentation
Lukas Riedel's avatar
Lukas Riedel committed
75 76
| [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
77 78


79
### Step-by-step Instructions
80 81
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.

82 83
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!

84 85 86
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
87 88

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

98 99 100
    **Mac OS X:**

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

Lukas Riedel's avatar
Lukas Riedel committed
106 107 108 109
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:**

110
        apt install libmetis-dev libparmetis-dev
Lukas Riedel's avatar
Lukas Riedel committed
111

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

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

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

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

122
    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.
123

124 125 126
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
127

128
    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.
129

130
    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.
131 132

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

134
        HDF5_ROOT=/usr/local
135

136
    to the `CMAKE_FLAGS` in the call to `dunecontrol` above.
Dion Haefner's avatar
Dion Haefner committed
137
 
Lukas Riedel's avatar
Lukas Riedel committed
138
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
139

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

Lukas Riedel's avatar
Lukas Riedel committed
142 143 144
    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!**
145

146 147 148 149 150 151 152 153 154
### 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.

155

156 157 158
## 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
159 160 161 162

* [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.

163
# Usage
Dion Haefner's avatar
Dion Haefner committed
164

165 166
## Start an interactive Docker session

167
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:
168 169 170 171 172

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

173
## Documentation
Dion Haefner's avatar
Dion Haefner committed
174

175
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
176

177
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
178

Dion Haefner's avatar
Dion Haefner committed
179
    dunecontrol --only=dorie make doc
Dion Haefner's avatar
Dion Haefner committed
180

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

    make doc

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

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

    dorie <command>
191

Lukas Riedel's avatar
Lukas Riedel committed
192 193 194
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>
195

196
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
197 198 199

    dorie create

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

202 203
Tweak the paramters to your liking and then call

204 205 206 207
    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

208
    dorie run <inifile>
Dion Haefner's avatar
Dion Haefner committed
209

210
to execute the main program.
Dion Haefner's avatar
Dion Haefner committed
211

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

Dion Häfner's avatar
Dion Häfner committed
214
    dorie --help
Dion Haefner's avatar
Dion Haefner committed
215

216 217
or

Dion Häfner's avatar
Dion Häfner committed
218
    dorie <command> --help
219

220
## Troubleshooting
Dion Haefner's avatar
Dion Haefner committed
221 222
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`.

223
If the problem persists, take a look at the [List of Known Bugs](https://zwackelmann.iup.uni-heidelberg.de:10443/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
224

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

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

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

Dion Haefner's avatar
Dion Haefner committed
232
**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.
233

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

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

238 239 240 241 242
#### 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
243
The debugger `gdb` is pre-installed in the Docker container.
244

245 246 247 248 249 250 251 252 253
### 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
254

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

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

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