Commit bfefa508 authored by Katharina Heck's avatar Katharina Heck
Browse files

add readme and install script

parent 755ce30e
Preparing the Sources
Additional to the software mentioned in README you'll need the
following programs installed on your system:
cmake >= 2.8.12
Getting started
If these preliminaries are met, you should run
dunecontrol all
which will find all installed dune modules as well as all dune modules
(not installed) which sources reside in a subdirectory of the current
directory. Note that if dune is not installed properly you will either
have to add the directory where the dunecontrol script resides (probably
./dune-common/bin) to your path or specify the relative path of the script.
Most probably you'll have to provide additional information to dunecontrol
(e. g. compilers, configure options) and/or make options.
The most convenient way is to use options files in this case. The files
define four variables:
CMAKE_FLAGS flags passed to cmake (during configure)
An example options file might look like this:
#use this options to configure and make if no other options are given
-DCMAKE_CXX_FLAGS='-Wall -pedantic' \
-DCMAKE_INSTALL_PREFIX=/install/path" #Force g++-5 and set compiler flags
If you save this information into example.opts you can pass the opts file to
dunecontrol via the --opts option, e. g.
dunecontrol --opts=example.opts all
More info
dunecontrol --help
for further options.
The full build system is described in the dune-common/doc/buildsystem (Git version) or under share/doc/dune-common/buildsystem if you installed DUNE!
This is the DuMuX module containing the code for producing the results
submitted for:
K. Heck, E. Coltman, J. Schneider, R. Helmig<br>
Influence of radiation on evaporation rates: a numerical analysis
The easiest way to install this module is to create a new directory and clone this module:
mkdir heck2020a && cd heck2020a
git clone
After that, execute the file [](
cd heck2020a
chmod +x
This should automatically download all necessary modules and check out the correct versions. Afterwards dunecontrol is run.
You can find all examples in the appl folder. To run them, navigate to:
cd heck2020a/build-cmake/appl
Used Versions and Software
For an overview on the used versions of the DUNE and DuMuX modules, please have a look at
### Create a folder for the DUNE and DuMuX modules
### Go into the folder and execute this script
if [ -d dune-common ]; then
echo "error: A directory named dune-common already exists."
echo "Aborting."
exit 1
### Clone the necessary modules
git clone
git clone
git clone
git clone
git clone
git clone dumux
git clone Heck2020a
### Go to specific branches
cd dune-common && git checkout releases/2.6 && cd ..
cd dune-geometry && git checkout releases/2.6 && cd ..
cd dune-grid && git checkout releases/2.6 && cd ..
cd dune-istl && git checkout releases/2.6 && cd ..
cd dune-localfunctions && git checkout releases/2.6 && cd ..
cd dumux && git checkout release/3.1 && cd ..
cd Heck2020a && git checkout master && cd ..
### Run dunecontrol
./dune-common/bin/dunecontrol --opts=./dumux/cmake.opts all
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment