Skip to content

Compiling ExoChombo

Tamara edited this page Nov 1, 2024 · 2 revisions

In order to compile ExoChombo, you need to checkout the adapted Chombo version (responsible for AMR and paralellisation) that can be found here. You should check the list of prerequisite libraries here and instructions on how to compile Chombo here. From now on, we will assume you have completed these required steps.

In order to compile ExoChombo, you first need to clone the repository onto your local machine:

Clone the GRChombo repository locally using

git clone https://github.com/GRTLCollaboration/ExoChombo.git

If you plan to make significant changes to the code, we recommend you create your own fork, so that you can store your updates to the code. Please do not create branches in the ExoChombo repository unless you have contacted us about an update.

Set the shell environment variable CHOMBO_HOME as the path to the Chombo library. Usually the command for this is something like:

export CHOMBO_HOME=/path/to/Chombo/lib/

This can also be added to the .bashrc or .profile file in your home directory so it is set automatically each time you login.

Go to Examples/BBSEqualMassFix and run

make all

This should compile without errors. See GRChombo's wiki page for advice on common errors.

If this example works, go to the base ExoChombo directory and run

make test -j 8

This will make the tests in parallel using 8 ranks. To run the tests use

make run

which is often easier to read if not done in parallel. You can also compile and run the tests, and compile the examples in one go with the command

make all

but then you have to do it all in parallel or all in serial.

If you subsequently change compiler options, use the command

make clean

or

make realclean

To start the compilation from a clean slate or change the XTRACONFIG variable in the Chombo Make.defs.local.