Doxygen documentation

Automatically generated Doxygen documentation for the code can be found here. However, this cannot be guaranteed to be up-to-date so we advise generating your own from a checked out version of the source code.

You will first need to install Doxygen. If you are on Linux, this may be available using the system package manager (e.g. sudo apt install doxygen on Ubuntu or Debian) and if you are on macOS, this is available as a Homebrew formula.

Next, if you have not done so already, you will need to clone GRChombo locally using a command such as

git clone https://github.com/GRChombo/GRChombo.git

To generate the Doxygen documentation, first cd into the Doxygen subdirectory of the local clone of the GRChombo repository e.g.

cd /path/to/GRChombo/Doxygen

and run

doxygen doxygen_config

This will generate a new html directory. To access the documentation, open the file html/index.html in your favourite web browser.