Skip to content

Commit

Permalink
Add PDF documentation and update installation instructions to build-D…
Browse files Browse the repository at this point in the history
…ockerfile-stable.sh script.
  • Loading branch information
mjziebarth committed Jan 6, 2024
1 parent 468cc56 commit 0411f0f
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 7 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Binary file removed docs/reheatfunq-1.4.0.pdf
Binary file not shown.
Binary file added docs/reheatfunq-2.0.1.pdf
Binary file not shown.
24 changes: 18 additions & 6 deletions docs/usage/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://doi.org/10.5880/GFZ.2.6.2023.002>`__. 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 <https://doi.org/10.5880/GFZ.2.6.2023.002>`__ 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`):
Expand Down

0 comments on commit 0411f0f

Please sign in to comment.