[DuMu<sup>x</sup>][0] is a simulation toolbox mainly aimed at flow and transport
processes in porous media. DuMu<sup>x</sup> is based on the [DUNE][1]
...
...
@@ -15,19 +14,11 @@ for a more detailed description of the goals and motivations behind DuMu<sup>x</
[](https://www.repostatus.org/#active)
Installation
===============
Have a look at the [installation guide][3] or use the [DuMu<sup>x</sup> handbook][4],
Chapter 2.
Automated testing of installation: [](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-test-installation/-/pipelines?page=1&scope=all&ref=main)
Documentation
==============
# Overview
The following resources are useful to get started with DuMu<sup>x</sup>:
*[Installation guide][3] on the [DuMu<sup>x</sup> website](https://dumux.org/)
*[Getting started guide](https://dumux.org/gettingstarted/) on the [DuMu<sup>x</sup> website](https://dumux.org/)
*[Handbook](https://dumux.org/docs/handbook/master/dumux-handbook.pdf), a detailed DuMu<sup>x</sup> manual,
@@ -38,12 +29,13 @@ The following resources are useful to get started with DuMu<sup>x</sup>:
Some helpful code snippets are available in the [Wiki](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/wikis/home).
License
========
Automated testing of installation: [](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-test-installation/-/pipelines?page=1&scope=all&ref=main)
# License
DuMu<sup>x</sup> is licensed under the terms and conditions of the GNU General
Public License (GPL) version 3 or - at your option - any later
version. The GPL can be [read online][5] or in the [LICENSE.md](LICENSE.md) file
version. The GPL can be [read online][5] or in the [LICENSE.md](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/blob/afb7f2296d84fd2367c612a1084d9b47ff85a260/LICENSE.md) file
provided in the topmost directory of the DuMu<sup>x</sup> source code tree.
Please note that DuMu<sup>x</sup>' license, unlike DUNE's, does *not* feature a
...
...
@@ -53,13 +45,12 @@ 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.
See the file [LICENSE.md](LICENSE.md) for copying permissions.
For a curated list of contributors see [AUTHORS.md](AUTHORS.md).
See the file [LICENSE.md](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/blob/afb7f2296d84fd2367c612a1084d9b47ff85a260/LICENSE.md) for copying permissions.
For a curated list of contributors see [AUTHORS.md](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/blob/afb7f2296d84fd2367c612a1084d9b47ff85a260/AUTHORS.md).
If you notice that a contributor is missing on the list,
please [contact us][6] or open a merge request adding the name.
How to cite
============
## How to cite
DuMu<sup>x</sup> is research software and developed at research institutions.
If you are using DuMu<sup>x</sup> in scientific publications and in
...
...
@@ -87,8 +78,8 @@ You can also cite specific releases published on Zenodo: