Doxygen documentation - GRTLCollaboration/GRChombo GitHub Wiki

Automatically generated Doxygen documentation for the code can be found here.

Installing Doxygen

You will first need to check if Doxygen is installed on your system and, if not, install it. To check if it is available, you can try the command

doxygen --version

which should output a version number such as 1.8.17 if it is installed correctly. If you need to install it, the installation procedure varies depending on your operating system. If you are on Linux, it may be available using the system package manager (e.g. sudo apt install doxygen on Ubuntu or Debian) and if you are on macOS, it is available as a Homebrew formula.

Generating the documentation

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.