Installation - hyschive/gamer-fork GitHub Wiki
-
Set up the machine configuration file
Please see Machine Configuration File.
-
Set your machine configuration file as default
sh tool/config/set_settings.sh --local --machine=your_machine
Note
If you want to set the default machine configuration file for all of the GAMER copies under your user account, use the --global
option instead of --local
.
Still, you can override the global setting for the individual GAMER copies with the --local
option.
Furthermore, you can override the default setting by passing the --machine=your_machine
when executing configure.py
.
-
Go to the source directory
cd src
-
Generate
Makefile
using the Python scriptconfigure.py
To get the
Makefile
, please execute the following command:python configure.py [--your_arguments]
[--your_arguments]
represent the options that should align with your simulation requirements. Please check out Option List for all the available options.For example, the following command sets the FFTW method to
FFTW2
, and enables gravity and GPU.python configure.py --fftw=FFTW2 --gravity=true --gpu=true
Tip
An example script generate_make.sh
to generate Makefile can be found in each test problem folder,
e.g., example/test_problem/Hydro/AcousticWave/generate_make.sh
.
-
Compile the code
make clean make
Tip
To reduce the compilation time, you can perform a parallel
compilation by make -j N
, where N
is the number of compilation
jobs to run in parallel. For example, the following command will
invoke 4 compilation jobs simultaneously:
make -j 4
However, please consult the documentation of your system to avoid violating the usage policy.
If the compilation succeeds, you will see the following message
Compiling GAMER --> Successful!
and get an executable gamer
, which will be automatically copied to ../bin/gamer
.