Commit 7a739148 authored by Praetorius, Simon's avatar Praetorius, Simon
Browse files
parents a6818510 426985ea
......@@ -65,8 +65,37 @@ for (auto const& e : edges(gv)) {
## Installation
We provide a *cmake*-based configuration. See also the `INSTALL.md` file in the
source directory.
We provide a *cmake*-based configuration and use the `dunecontrol` build system.
Simply run
```
dunecontrol --current all
cmake --build build-cmake --target examples
```
to build all the example problems. The `dunecontrol` script searches for the required
(and suggested) dune modules this library depends on. These include:
- [dune-common](https://gitlab.dune-project.org/core/dune-common)
- [dune-geometry](https://gitlab.dune-project.org/core/dune-geometry)
- [dune-grid](https://gitlab.dune-project.org/core/dune-grid)
- [dune-foamgrid](https://gitlab.dune-project.org/extensions/dune-foamgrid.git)
- [dune-localfunctions](https://gitlab.dune-project.org/core/dune-localfunctions)
- [dune-typetree](https://gitlab.dune-project.org/staging/dune-typetree)
- [dune-functions](https://gitlab.dune-project.org/staging/dune-functions)
(See the file `dune.module` for an up-to-date list of dependencies). The dune modules
can be obtained from https://gitlab.dune-project.org and need to be found in a
subdirectory of `DUNE_CONTROL_PATH`. See also https://dune-project.org/doc/installation
for details about the installation of dune modules.
Additionally we require the following libraries to be found:
- [Eigen3](http://eigen.tuxfamily.org)
- [SuiteSparse](http://faculty.cse.tamu.edu/davis/suitesparse.html)
And a compiler that supports the C++14 standard, e.g. g++ >= 4.9 and clang >= 3.6.
See also the Dokerfiles in [iwr/docker-images/dune-latest](https://gitlab.math.tu-dresden.de/iwr/docker-images)
for a [docker](https://www.docker.com) container based installation.
## Documentation
......@@ -74,5 +103,5 @@ Currently only a *doxygen*-based documentation of the source files is available.
Generate a html version by
```
doxygen doc/Doxyfile
cmake --build build-cmake --target documentation
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment