|
|
|
This little guide provides a step-by-step instruction for installation of *ALPACA* on a Linux machine (iOS and Windows are not supported by the development team).
|
|
|
|
|
|
|
|
Attention: This guide comes without any warranty - although we wrote it, of course, with caution and thorough testing.
|
|
|
|
|
|
|
|
# 0. Prerequisites
|
|
|
|
|
|
|
|
We require a native Linux installation with GCC (≥ version 8). Our setup is based on UBUNTU 18.04.5 LTS with GCC 8.2.1.
|
|
|
|
|
|
|
|
*ALPACA* is developed using the following dependencies (we check routinely newer versions to keep this guide up-to-date):
|
|
|
|
- MPICH 3.3.2 <or> openMPI 4.0.2
|
|
|
|
- HDF5 1.8.21
|
|
|
|
- CMAKE 3.16.0
|
|
|
|
- PARAVIEW 5.8.0 (postprocessing)
|
|
|
|
- VS CODE 1.44.0 (IDE)
|
|
|
|
|
|
|
|
Please check the existence of the mentioned dependencies in the given versions.
|
|
|
|
|
|
|
|
## Installing prerequisites
|
|
|
|
To install the collection of prerequisites we recommend to use the [install script](https://gitlab.lrz.de/nanoshock/ALPACA/-/blob/master/Utilities/InstallScripts/installNanoshockSoftware.sh) provided in the `Utilities/InstallScripts` folder of the repository.
|
|
|
|
|
|
|
|
At first, specify the desired location for the installation of the dependencies via the environment variable `ALPACAUTILDIR`:
|
|
|
|
|
|
|
|
export ALPACAUTILDIR=/path/where/to/install/software
|
|
|
|
|
|
|
|
Afterwards, go to the directory `Utilities/Installscripts` of the *ALPACA* repository:
|
|
|
|
|
|
|
|
cd /path/to/your/ALPACA/Utilities/Installscripts
|
|
|
|
|
|
|
|
and then execute the install script:
|
|
|
|
|
|
|
|
bash installNanoshockSoftware.sh
|
|
|
|
|
|
|
|
In order to 'activate' the installed libraries you need to source the setup file:
|
|
|
|
|
|
|
|
source setupAlpacaTools.sh
|
|
|
|
|
|
|
|
Note, you need to source the setup file everytime you want to work with *ALPACA*. Alternatively, adjust your `PATH` / `LD_LIBRARY_PATH` accordingly for permanent availability. For installation of individual prerequisites (additional adjustments like environmental variables might be required) there is a corresponding [individual install script](https://gitlab.lrz.de/nanoshock/ALPACA/-/blob/master/Utilities/InstallScripts) available. Please check the given tools and use them for your purposes on your own risk.
|
|
|
|
|
|
|
|
# 1. Compilation
|
|
|
|
Try `make`. If it works - be happy, you are done ;-)
|
|
|
|
|
|
|
|
If you encounter errors with MPI (such as 'mpi.h not found'), set the following environmental variables:
|
|
|
|
- `export MPI_INC=-I<PATH TO YOUR MPICH INCLUDE>`
|
|
|
|
- `export MPI_LIB=-L<PATH TO YOUR MPICH LIB>`
|
|
|
|
|
|
|
|
If you encounter errors with HDF5 (such as 'hdf5.h not found'), set the following environmental variables:
|
|
|
|
- `export HDF5_INC=-I<PATH TO YOUR HDF5 INCLUDE>`
|
|
|
|
- `export HDF5_LIB='-L<PATH TO YOUR HDF5 LIB> -lhdf5_hl -lhdf5'`
|
|
|
|
|
|
|
|
# 2. Domesticate your *ALPACA*
|
|
|
|
Congratulations you can now run ALPACA e.g. with `mpiexe/mpirun -n 2 ./ALPACA <inputfile>`.
|
|
|
|
|
|
|
|
Further information on running simulations with some example inputfiles is provided in [wiki/2_Examples](2_Examples). |
