tutorial: compilation links to SHEMAT-Suite_Models-open authored by Johannes Keller's avatar Johannes Keller
......@@ -111,13 +111,14 @@ For `hdf5` support, the corresponding software has to be installed (see [instal
# Compilation: Best Practices
The compilation shell script
[compilequick.sh](https://git.rwth-aachen.de/SHEMAT-Suite/SHEMAT-Suite_Models/blob/master/compilequick.sh) in the Gitlab
repository [SHEMAT-Suite_Models](https://git.rwth-aachen.de/SHEMAT-Suite/SHEMAT-Suite_Models) includes all compilation best
practices!
[compilequick.sh](https://git.rwth-aachen.de/SHEMAT-Suite/SHEMAT-Suite_Models-open/blob/master/compilequick.sh)
in the Gitlab repository
[SHEMAT-Suite_Models-open](https://git.rwth-aachen.de/SHEMAT-Suite/SHEMAT-Suite_Models-open)
includes all compilation best practices!
Here, some best practices for compilation are written down. There are
two good things to do:
three good things to do:
1. rename the executable to reflect your input (for example including
the branch of SHEMAT-Suite, under which the executable was compiled)
......@@ -143,21 +144,23 @@ very helpful, when errors occur.
### Compilation Shell Script
A compilation shell script (`compilequick.sh`) can be found in
[SHEMAT-Suite_Models](https://git.rwth-aachen.de/SHEMAT-Suite/SHEMAT-Suite_Models):
[compilequick.sh](https://git.rwth-aachen.de/SHEMAT-Suite/SHEMAT-Suite_Models/blob/master/compilequick.sh). Another
script wich includes more module loading options can be found in
[SHEMAT-Suite_Models/deltasets](https://git.rwth-aachen.de/SHEMAT-Suite/SHEMAT-Suite_Models/tree/master/deltatests):
[compilequick.sh](https://git.rwth-aachen.de/SHEMAT-Suite/SHEMAT-Suite_Models/blob/master/deltatests/compilequick.sh).
Use the first script to compile SHEMAT-Suite. Specify your model
directory under `model_dir`, then specify the make directory (the
SHEMAT-Suite directory) under `make_dir` and a few more variables
(compilation type, head or pres mode, property module, user directory,
compiler and compiler flag). Finally you can execute it as follows
[SHEMAT-Suite_Models-open](https://git.rwth-aachen.de/SHEMAT-Suite/SHEMAT-Suite_Models-open):
[compilequick.sh](https://git.rwth-aachen.de/SHEMAT-Suite/SHEMAT-Suite_Models-open/blob/master/compilequick.sh).
Use this script for compiling SHEMAT-Suite. Inside the scripts,
specify your model directory under `model_dir`, then specify the make
directory (the SHEMAT-Suite directory) under `make_dir` and a few more
variables (compilation type, head or pres mode, property module, user
directory, compiler type, and compiler flags). Finally you can execute
it in the command line with the following command:
```
./compilequick.sh
```
It will compile SHEMAT-Suite in `make_dir` and afterwards move the
executable to `model_dir` along with the files `version.inc`,
`CMakeCache.txt`. To be noted, the local and the online git version of the `make_dir` SHEMAT repository must be equal.
The script will compile the SHEMAT-Suite source code in `make_dir` and
move the resulting executable to `model_dir` along with the files
`version.inc`, `CMakeCache.txt`.
Note: the git repository of the `make_dir` SHEMAT repository should
have no uncommitted changes. Otherwise, the compilation script will
terminate showing an error messages.