@@ -27,13 +27,14 @@ ways of installation. The preferable way is the use the package manager Spack, w
2727care of all dependencies automatically. The second way is a manual installation of a components,
2828which can be used in case the installation with Spack is not possible on the target system.
2929
30- # Installation --- Using Spack
31- Spack is a package manager for supercomputers, Linux, and macOS, for which a
32- local repo is to be found in the directory ` spack ` in the pfd-parallel source tree. For
30+ # Installation using Spack
31+ Spack is a package manager specifically aimed at handling software installations in supercomputing environments, but
32+ usable on anything from a personal computer to an HPC cluster. It supports Linux and macOS (note that the Singular/GPI-Space
33+ framework requires Linux). A local repository for Space can be found in the directory ` spack ` in the pfd-parallel source tree. For
3334most users, this should be the easiest way to install the pfd-parallel project and all
3435it's dependencies, with minimal configuration required.
3536
36- We will assume the user has some directory path to which she/he can read and
37+ We will assume that the user has some directory path to which she/he can read and
3738write. In the following, we assume this path is set as the bash variable
3839` software_ROOT ` :
3940
@@ -99,8 +100,8 @@ Finally, install pfd-parallel:
99100``` bash
100101spack install pfd-parallel
101102```
102- Note, this may take a long time, as it needs to build gpi-space and singular
103- ( including dependencies), both of which are quite extensive .
103+ Note, this may take quite a bit of time, when doing the initial installation, as it needs to build GPI-Space and Singular
104+ including dependencies.
104105
105106Once pfd-parallel is installed, using pfd-parallel requires loading the installed software:
106107``` bash
@@ -116,11 +117,15 @@ export PFD_INPUT_DIR=$PFD_ROOT/input
116117export PFD_OUTPUT_DIR=$PFD_ROOT /output
117118```
118119
119- # Installation --- Manually from sources
120+ The following section is not necessary if installation via Spack has been completed, and should be skipped. It contains
121+ everything what Spack does automatically for you.
120122
121- As an alternative to spack, pfd-parallel and its dependencies can also be compiled
122- directly. For most users, a spack installation should suffice, in which case
123- this section can be skipped.
123+
124+ # Manual installation from sources
125+
126+ As an alternative to Spack, pfd-parallel and its dependencies can also be compiled
127+ directly. For most users, a Spack installation should suffice, in which case
128+ this section should be skipped.
124129
125130For the various dependencies, it is recommended to create a file that exports
126131the various install locations as environment variables. For this purpose, the
0 commit comments