
What is DuMuX?
DuMuX is a simulation toolbox mainly aimed at flow and transport processes in porous media. DuMuX is based on the DUNE 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 therapy and more. See our publication for a more detailed description of the goals and motivations behind DuMuX.
Installation
Have a look at the installation guide or use the DuMuX handbook, Chapter 2.
Documentation
The following resources are useful to get started with DuMux:
- Handbook, a detailed DuMux manual,
- DuMux course materials,
- Class documentation generated from the source code,
- Mailing list,
- Changelog, where all changes between different release versions are listed and explained.
Some helpful code snippets are available in the Wiki.
License
DuMuX 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 or in the LICENSE.md file 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 for a commercial license.
See the file LICENSE.md for full copying permissions.
Automated Testing
DuMuX features many tests (some unit tests and test problems) that can be run manually. We have experimental support for automated testing with buildbot. Click here (buildbot) to see the latest builds (clicking on a build number will show a detailed overview of the build).
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.
Contributing
Contributions are highly welcome. Please ask questions over the mailing list. Please review the contribution guidelines before opening issues and merge requests. For bug reports contact us over the mailing list, or file an issue. For bug fixes, feature implementations open a merge request or send us formatted patches.
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 for a list of changes. If you decide to update from version 2.12, please have a look at our small guide on how to update an application to the new version.