Simple instructions on how to use doxygen to generate offline webpage-form documentation for ORCHIDEE. One of the nice feature is that it will show calling graph, i.e., which subroutines a given subroutine is calling and itself in turn is called by which subroutines. The call graph is also interactive. When you click on a subroutine, you will be directed to the details of this subroutine, because the offline webpages are linked. Note we are just visiting our local files using an internet browser.

The steps are:

(1) Download the most recent trunk of ORCHIDEE code.

(2) To install doxygen and the another program needed (examples on ubuntu machine): sudo apt install doxygen sudo apt-get install graphviz

(3) Inside your ORCHIDEE code folder (.../modipsl/modeles/ORCHIDEE/),

download the attached file (with the name of "Doxyfile", which is the doxygen configuration file) and put it into this folder.

Then run the command 'doxygen Doxyfile' You will see three new folders being added after all commands are OK:

docbook latex html

Then go into the html folder, there is a file named 'index.html'

open it with firefox or any other browser, you will be able to use the 'offline' documentation and check the call graph of different subroutines.

You can actually also read code there.