read_the_code - UK-FVCOM-Usergroup/uk-fvcom GitHub Wiki

Code structure

A complete graph of the interdependency of each module, subroutine and variable in FVCOM is available. This is the output of an analysis with doxygen and shows how FVCOM is structured. This is useful to find where a variable is defined and which subroutines are called by what.

As a general rule, if you don't know what a variable name contains (and it's not defined in the local namespace), check the ALL_VARS module in mod_main.F or the MOD_TYPES module in mod_types.F.

Running Doxygen

I have copied my doxygen configuration file here for future reference should you choose to run it on your own code. This uses the Twitter Bootstrap theme which requires these header.html and footer.html files.