README.md 3.37 KB
Newer Older
1
<img src="doc/logo/dumux_logo_hires_whitebg.png" alt="dumux logo" width="400"/>
2
3

What is DuMuX?
4
===============
5
6

[DuMuX][0] is a simulation toolbox mainly aimed at flow and transport
Bernd Flemisch's avatar
Bernd Flemisch committed
7
processes in porous media. DuMuX is based on the [DUNE][1]
8
9
10
framework and aims to provide a multitude of numerical models as well
as flexible discretization methods for complex non-linear phenomena,
such as CO2 sequestration, soil remediation, drug delivery in cancer
11
therapy and more. See [our publication][2] for a more detailed
12
13
14
15
description of the goals and motivations behind DuMuX.


Installation
16
===============
17

Timo Koch's avatar
Timo Koch committed
18
19
Have a look at the [installation guide][3] or use the [DuMuX handbook][4],
Chapter 2.
20
21
22


License
23
========
24
25

DuMuX is licensed under the terms and conditions of the GNU General
26
Public License (GPL) version 3 or - at your option - any later
27
version. The GPL can be [read online][5] or in the [LICENSE.md](LICENSE.md) file
28
29
30
31
32
33
34
35
36
provided in the topmost directory of the DuMuX source code tree.

Please note that DuMuX' license, unlike DUNE's, 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 header
files if you want to redistribute your program to third parties. If
this is unacceptable to you, please [contact us][6] for a commercial
license.

37
See the file [LICENSE.md](LICENSE.md) for full copying permissions.
38

Timo Koch's avatar
Timo Koch committed
39
Automated Testing
40
==================
41
[![buildbot badge](https://git.iws.uni-stuttgart.de/buildbot/badges/dumux-master-dune-latest-gcc.svg)](https://git.iws.uni-stuttgart.de/buildbot/#/builders)
Timo Koch's avatar
Timo Koch committed
42
43
44

DuMuX features many tests (some unit tests and test problems) that can
be run manually. We have experimental support for automated testing with buildbot.
45
Click <a href="https://git.iws.uni-stuttgart.de/buildbot/#/builders" target="_blank">here (buildbot)</a>
Timo Koch's avatar
Timo Koch committed
46
47
48
to see the latest builds (clicking on a build
number will show a detailed overview of the build).

49
50
51
52
53
54
55
56
57
Contributing
=============

Contributions are highly welcome. Please ask questions over the [mailing list](mailto:dumux@listserv.uni-stuttgart.de).
Please review the [contribution guidelines](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/blob/master/CONTRIBUTING.md)
before opening issues and merge requests. For bug reports contact us
over the mailing list, or file an [issue](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/issues). For bug fixes,
feature implementations open a [merge request](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/merge_requests)
or send us formatted patches.
Timo Koch's avatar
Timo Koch committed
58

59
60
61
62
63
64
65
66
67
Major version update, 2.12 to 3.0
===================================

With the version update to version 3, many features have been added and a lot has been improved in DuMuX. See the
[changelog](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/blob/master/CHANGELOG.md) for a list of changes.
If you decide to update from version 2.12, please have a look at our small
[guide](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/wikis/Updating-programs-from-version-2.12-to-version-3.0)
on how to update an application to the new version.

68
69
70
71
72
73
[0]: https://dumux.org
[1]: https://dune-project.org/
[2]: https://dumux.org/documents/dumux_awrpaper.pdf
[3]: https://dumux.org/installation
[4]: https://dumux.org/documents/dumux-handbook-master.pdf
[5]: https://www.gnu.org/licenses/gpl-3.0.en.html
74
[6]: http://www.hydrosys.uni-stuttgart.de/index.en.php