Changes

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