README.md 4.52 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

Timo Koch's avatar
Timo Koch committed
21
22
23
24
25
26
27
28
29
30
31
32
Documentation
==============

The following resources are useful to get started with DuMux:

* [Handbook](https://dumux.org/handbook), a detailed DuMux manual,
* [DuMux course materials](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-course/tree/master),
* [Class documentation](https://dumux.org/classdocumentation) generated from the source code,
* [Mailing list](https://listserv.uni-stuttgart.de/mailman/listinfo/dumux),
* [Changelog](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/blob/master/CHANGELOG.md), where all changes between different release versions are listed and explained.

Some helpful code snippets are available in the [Wiki](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/wikis/home).
33
34

License
35
========
36
37

DuMuX is licensed under the terms and conditions of the GNU General
38
Public License (GPL) version 3 or - at your option - any later
39
version. The GPL can be [read online][5] or in the [LICENSE.md](LICENSE.md) file
40
41
42
43
44
45
46
47
48
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.

49
See the file [LICENSE.md](LICENSE.md) for full copying permissions.
50

Timo Koch's avatar
Timo Koch committed
51
Automated Testing
52
==================
53
[![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
54
55
56

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

Timo Koch's avatar
Timo Koch committed
61
[![coverage report](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-coverage/badges/master/coverage.svg)](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-coverage/)
Timo Koch's avatar
Timo Koch committed
62
63
64
65
66
67

A weekly coverage report of the test suite is created by gcovr/gcov. The report
currently doesn't include non-instantiated code, so the real coverage is likely lower. However,
only a few lines of code are never instatiated in the comprehensive test suite.


68
69
70
71
72
73
74
75
76
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
77

78
79
80
81
82
83
84
85
86
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.

87
88
89
90
91
92
[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
93
[6]: http://www.hydrosys.uni-stuttgart.de/index.en.php