idefix-code/idefix at 7e4bc140ea98ecd498b23eb20dacaed28c2c3bc4 · GitHub

• Full documentation
• Download:
• Installation:
• Compile an example:
• Running
  • serial (gpu/cpu), openMP (cpu)
  • With MPI (cpu)
  • With MPI (gpu)
• Profiling
• Debugging
• Running tests
• Contributing

The latest documentation is available online following these links

• Master branch documentation.
• Develop branch documentation.

using either ssh or https url as <address>

git clone <address>
cd idefix
git submodule init
git submodule update

Set the IDEFIX_DIR environment variable to the absolute path of the directory

export IDEFIX_DIR=<idefix main folder>

Add this line to ~/.<shell_rc_file> for a permanent install.

Go to the example directory. For instance:

cd test/HD/sod

Configure the code launching cmake (version >= 3.16) in the example directory:

cmake $IDEFIX_DIR

Several options can be enabled from the command line (a complete list is available with cmake $IDEFIX_DIR -LH). For instance: -DIdefix_MHD=ON (enable MHD, required in MHD tests), -DIdefix_MPI=ON (enable mpi), -DKokkos_ENABLE_OPENMP=ON (enable openmp parallelisation), etc... For more complex target architectures, it is recommended to use cmake GUI launching ccmake $IDEFIX_DIR in place of cmake and then switching on the required options.

One can then compile the code:

make -j8

simple launch the executable

./idefix

When NX, NY, NZ and nproc are all powers of 2, Idefix can guess the best domain decomposition automatically. In the other cases, the -dec option for idefix is mandatory. Exemple, in 2D, using a 2x2 domain decomposition:

mpirun -np 4 ./idefix -dec 2 2

in 3D, using a 1x2x4 decomposition:

mpirun -np 8 ./idefix -dec 1 2 4

The same rules for cpu domain decomposition applies for gpus. In addition, one should manually specify how many GPU devices one wants to use per node. Example, in a run with 2 nodes, 4 gpu per node, one would launch idefix with

mpirun -np 8 ./idefix -dec 1 2 4 --kokkos-num-devices=4

use the kokkos profiler tool, which can be downloaded from kokkos-tools (on github) Then set the environement variable:

export KOKKOS_PROFILE_LIBRARY=~/Kokkos/kokkos-tools/src/tools/space-time-stack/kp_space_time_stack.so

and then simply run the code (no need to recompile)

Add #define DEBUG in definitions.hpp and recompile. More to come...

Tests require Python 3 along with some third party dependencies to be installed. To install those deps, run

pip install -r test/python_requirements.txt

The test suite itself is then run with

bash test/checks.sh

Idefix is developed with the help of the pre-commit framework. We use cpplint to validate code style, mostly following the Google standards for C++, and several pre-commit hooks to automatically fix some coding bad practices.

It is recommended (though not mandatory) to install pre-commit by running the following script from the top level of the repo

python3 -m pip install pre-commit
pre-commit install

Then, as one checks in their contribution with git commit, pre-commit hooks may perform changes in situ. One then needs to re-add and enter the git commit command again for the commit to be validated. Note that an important hook that does not perform auto-fixes is cpplint, so contributors need to accomodate for this one by hand.

Note that if for any reason you do not wish, or are unable to install pre-commit in your environment, formatting errors will be caught by our CI after you open a merge-request.