Skip to content
Snippets Groups Projects

[README] improve docker section

Merged Dennis Gläser requested to merge feature/improve-readme-docker-section into master
All threads resolved!
1 file
+ 10
17
Compare changes
  • Side-by-side
  • Inline
+ 10
17
@@ -31,20 +31,13 @@ while allowing you to change a few selected parameters.
Dockerfile and Docker image
===========================
A Dockerfile as well as a prebuilt docker image are also contained in the dataset
at [doi.org/10.18419/darus-3228](https://doi.org/10.18419/darus-3228). You may use those to explore the
software locally on your machine without going through the installation process (as described below),
while still being able to modify all parts of the code or input files as desired.
For loading the prebuilt
image, simply download it and type `docker load berre2020_docker_image.tar.gz`. For building the docker
image locally, download the `Dockerfile` and source code (`berre2020.tar.gz`), extract the source code
and type `docker build -t berre2020 .`.
For instructions on how to execute the benchmark cases inside the container, see the `Execution` section
After downloading, you can load the prebuilt image via `docker load berre2020_docker_image.tar.gz`.
If you prefer to build the image locally, download the `Dockerfile` and source code (`berre2020.tar.gz`)
into a new directory, extract the source code, and type `docker build -t berre2020 .`.
If you do not want to install this software and its dependencies on your local machine (see instructions further
below), you may also explore it from within a `docker` container. A Dockerfile and a prebuilt docker image are
contained in the dataset at [doi.org/10.18419/darus-3228](https://doi.org/10.18419/darus-3228). After downloading it,
the prebuilt image can directly be loaded into your local container registry with `docker load berre2020_docker_image.tar.gz`.
In order to build the image locally, download the `Dockerfile` and source code (`berre2020.tar.gz`) into a new directory,
extract the source code and type `docker build -t berre2020 .`. This may take some time as it installs all dependencies
into the container image and compiles the application.
For exploration of the code inside the container, spin up an interactive session via
`docker run -it --entrypoint /bin/bash berre2020`. Afterwards, you can head to the directory with
@@ -85,7 +78,7 @@ sudo apt-get install libcgal-dev
Execution
=========
In the directory
__dumux-benchmarks/berre2020/build-cmake/cases/transport__
__berre2020/build-cmake/cases/transport__
you will find a directory for each case
```bash
transport/
@@ -133,8 +126,8 @@ cd case1_singlefracture
# the grid with ~1k cells corresponds to refinement 0 in Berre et al (2018)
./case1_singlefracture params.input -Grid.File grids/single_1k.msh -Discretization.Scheme tpfa
# invoke the plot script to produce the plot-over-line data `pol_1.csv`, `pol_2.csv`, `pol_3.csv`
# as requested in Berre et al. (2018)
# invoke the plot script to produce the plot-over-line data for refinement 0
# the script produces the files `pol_1.csv`, `pol_2.csv`, `pol_3.csv` as requested in Berre et al. (2018)
pvpython makeplotoverlinedata.py tpfa 0
```
Loading