# MOM6 APIs

This is the generated documentation for the MOM6 source code which describes the APIs as well as some features of the code.

This documentation is also available as web-linkable pages hosted on [read the docs](http://mom6.readthedocs.io/), where the pages are generated with sphinx.

If you are looking for a user guide, start at the [MOM6-examples wiki](https://github.com/NOAA-GFDL/MOM6-examples/wiki) which has installation instructions, links to tutorials, and more.

The APIs in MOM6 are documented using doxygen - you are viewing the result. A brief style guide for using doxygen in MOM6 is available at https://github.com/NOAA-GFDL/MOM6/wiki/Doxygen.

***

## Contents

- [List of modules](namespaces.html)
   - Alphabetical list of modules
- [List of classes](annotated.html)
   - Modules with types
- [List of files](files.html)
   - File structure
- [List of feature pages](pages.html)
   - Detailed description of some features of the code