README.md 2.21 KB
Newer Older
1
2
3
Readme
======

4
What is DuMuX-Lecture?
5
----------------------
6

7
8
DuMuX-Lecture contains several numerical examples for modeling flow
and transport processes in porous media. It is based on the open-source
9
10
11
porous-media simulator [DuMuX][0]. The examples are used in the lectures
of the [LH2 group at the University of Stuttgart][1]. They are contained
in subfolders of the folder `lecture`.
12
13


14
Installation
15
------------
16

17
18
DuMuX-Lecture is a DUNE module that depends on DuMuX. It can be installed
like DuMuX itself, please refer to the DuMuX and DUNE installation
19
instructions for details.
20
21


22
License
23
-------
24

25
DuMuX-Lecture is licensed under the terms and conditions of the GNU
26
General Public License (GPL) version 2 or - at your option - any later
27
version. The [GPL can be read online][2], or in the `LICENSE.md` file
28
provided in the topmost directory of the DuMuX source code tree.
29

30
31
32
33
Please note that DuMuX-Lecture's license, unlike DUNE, does NOT feature
a template exception to the GNU General Public License. This means that
you must publish any source code which uses any of the DuMuX-Lecture
header files if you want to redistribute your program to third parties.
34
If this is unacceptable to you, please [contact us][1] for a commercial
35
license.
36

37
See the file `LICENSE.md` for full copying permissions.
38

39

Timo Koch's avatar
Timo Koch committed
40
41
42
43
Automated Testing
------------------
* Master branch (development): [![master build badge](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-lecture/badges/master/pipeline.svg)](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-lecture/-/pipelines?page=1&scope=all&ref=master)
* Latest release: [![release build badge](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-lecture/badges/releases/3.4/pipeline.svg)](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-lecture/-/pipelines?page=1&scope=all&ref=releases/3.4)
44

45

Timo Koch's avatar
Timo Koch committed
46
47
48
49
50
51
DuMu<sup>x</sup> lecture contains test problems for every example that
are continuously and automatically tested in the GitLab-CI framework (see badges).
The test suite is based on CTest and can also be built and run manually
```
make -j8 build_tests && ctest -j8
```
52

53
54
55
[0]: http://dumux.org
[1]: http://www.hydrosys.uni-stuttgart.de/index.en.php
[2]: http://www.gnu.org/licenses/old-licenses/gpl-2.0.html