diff --git a/README.md b/README.md index 698f548..08e5dc5 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,12 @@ includes updated dependencies and has a short compilation time. Alternatively, you can build the reproducible `Dockerfile-stable` with fixed dependencies at the state of the REHEATFUNQ description paper. See the [REHEATFUNQ documentation](https://mjziebarth.github.io/REHEATFUNQ/) for more -information about how to build the `Dockerfile-stable` image. +information about how to build the `Dockerfile-stable` image. Typically, building +this image should be as simple as +```bash +bash build-Dockerfile-stable.sh +``` +if `podman` is installed. ## Usage REHEATFUNQ can be used by importing the various module components from the diff --git a/docs/reheatfunq-1.4.0.pdf b/docs/reheatfunq-1.4.0.pdf deleted file mode 100644 index 902ef00..0000000 Binary files a/docs/reheatfunq-1.4.0.pdf and /dev/null differ diff --git a/docs/reheatfunq-2.0.1.pdf b/docs/reheatfunq-2.0.1.pdf new file mode 100644 index 0000000..d692ad8 Binary files /dev/null and b/docs/reheatfunq-2.0.1.pdf differ diff --git a/docs/usage/installation.rst b/docs/usage/installation.rst index 71dd5c2..dc1071f 100644 --- a/docs/usage/installation.rst +++ b/docs/usage/installation.rst @@ -92,13 +92,25 @@ This container image requires the sources of the software upon which REHEATFUNQ is built. The combined source code archive of this software is large (the :code:`Dockerfile-stable` starts by bootstrapping the GNU Compiler Collection and successively compiles the Python ecosystem and numeric software) and it is -split off this git repository. Therefore, you first need to download the -:code:`vendor-1.3.3.tar.xz` and :code:`vendor-2.0.1.tar.xz` archives from -`GFZ Data Services `__. Following -the instructions presented therein, extract the :code:`compile` and -:code:`wheels` subfolders into the :code:`vendor` directory of this repository. +split off this git repository. The archives :code:`vendor-1.3.3.tar.xz` and +:code:`vendor-2.0.1.tar.xz` from +`GFZ Data Services `__ contains the +required software. -Then, you can build and run the Docker image as above (you might want to rename +There are two ways to build the :code:`Dockerfile-stable` image. Since version +2.0.1, the shell script `build-Dockerfile-stable.sh` is available to facilitate +the build process. Using this script, the build process should be as simple as + +.. code :: bash + + bash build-Dockerfile-stable.sh + +A second way is to build the image manually. This first requires downloading +:code:`vendor-1.3.3.tar.xz` and :code:`vendor-2.0.1.tar.xz`. Following the +instructions presented therein, extract the :code:`compile` and :code:`wheels` +subfolders into the :code:`vendor` directory of this repository. + +Then, you can build and run the Docker image as below (you might want to rename the container according to the REHEATFUNQ version you are using---unless stated otherwise, the following versions are compatible with :code:`vendor-1.3.3.tar.xz` and :code:`vendor-2.0.1.tar.xz`):