README.md 1.39 KB
Newer Older
Timo Koch's avatar
Timo Koch committed
1
2
3
4
5
# DuMu<sup>x</sup> course useful scripts

The install script is a shell script that will setup DuMu<sup>x</sup> on your computer
in the version that is required to complete the current course's exercises.

6
7
8
9
10
Installation guide dumux
-------------------------

You can set up dumux using the attached script install.sh.
You need to have the following REQUIREMENTS installed:
Bernd Flemisch's avatar
Bernd Flemisch committed
11
  * gcc >= 7
12
13
14
15
  * cmake >= 3.1
  * git
  * pkg-config
  * paraview (to visualize the results)
16
17
  * gnuplot (to plot some curves)
  * wget (to download some config files during the installation)
18
19

On debian-based system you can use this:
Ned Coltman's avatar
Ned Coltman committed
20
```bash
Bernd Flemisch's avatar
Bernd Flemisch committed
21
  apt-get install build-essential gfortran pkg-config cmake git paraview wget gnuplot libsuitesparse-dev
Ned Coltman's avatar
Ned Coltman committed
22
```
23
24
25

Then, you can the execute the script and it will download the dune repositories and dumux
and configure all modules with CMake
Ned Coltman's avatar
Ned Coltman committed
26
```bash
Bernd Flemisch's avatar
Bernd Flemisch committed
27
28
  wget https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-course/-/raw/master/scripts/install.sh
  chmod a+x install.sh
29
  ./install.sh
Ned Coltman's avatar
Ned Coltman committed
30
```
Bernd Flemisch's avatar
Bernd Flemisch committed
31
This will clone the necessary repositories (in a subfolder `DUMUX`) and
32
33
build all libaries.

Theresa Schollenberger's avatar
Theresa Schollenberger committed
34
Run the script `test_dumux.sh` in the newly created `DUMUX` folder
35
to test your installation of dumux.
Ned Coltman's avatar
Ned Coltman committed
36
```bash
37
  ./test_dumux.sh
Ned Coltman's avatar
Ned Coltman committed
38
```
39
40
41
It will compile and run a simple one-phase ground water flow example
and visualizes the result using paraview.

Bernd Flemisch's avatar
Bernd Flemisch committed
42
* you can also click [here](./install.sh) to view and download the install script