Technical documentation

Technical Documentation

Model configuration

• The runtime parameter system

Browse the source code using Doxygen

We are (slowly) migrating to doxygen-style comments for API and in-code documentation.

To use doxygen to generate HTML do the following:

cd MOM6-examples/src/MOM6
git clone https://github.com/doxygen/doxygen
(cd doxygen; ./configure)
(cd doxygen; make)
./doxygen/bin/doxygen .doxygen

This will create HTML files in the directory html/. You can then view the doxygen pages by pasting the following path into the URL bar of your web browser:

file://<full_path_to_MOM6_examples/MOM6-examples/src/MOM6/html/index.html

Other Relevant Publications

Software Quality and Testing for Geophysical Models by Nicholas Hannah. A presentation discussing motivation for engineering/software quality in geophysical models and outlining several interesting techniques for testing numerical codes.

Reproducibility and Transparency in Ocean Climate Modeling by Nicholas Hannah, Alistair Adcroft, Robert Hallberg and Stephen Griffies. A poster presented at AGU 2015 summarizing our efforts to improve the reproducibility, openness and engineering quality of MOM6 and SIS2.