This is the generated documentation for the M\+O\+M6 source code which describes the A\+P\+Is as well as some features of the code.

This documentation is also available as web-\/linkable pages hosted on \href{http://mom6.readthedocs.io/}{\texttt{ read the docs}}, where the pages are generated with sphinx.

If you are looking for a user guide, start at the \href{https://github.com/NOAA-GFDL/MOM6-examples/wiki}{\texttt{ M\+O\+M6-\/examples wiki}} which has installation instructions, links to tutorials, and more.

The A\+P\+Is in M\+O\+M6 are documented using doxygen -\/ you are viewing the result. A brief style guide for using doxygen in M\+O\+M6 is available at \href{https://github.com/NOAA-GFDL/MOM6/wiki/Doxygen}{\texttt{ https\+://github.\+com/\+N\+O\+A\+A-\/\+G\+F\+D\+L/\+M\+O\+M6/wiki/\+Doxygen}}.





\subsection*{Contents}


\begin{DoxyItemize}
\item \href{namespaces.html}{\texttt{ List of modules}}
\begin{DoxyItemize}
\item Alphabetical list of modules
\end{DoxyItemize}
\item \href{annotated.html}{\texttt{ List of classes}}
\begin{DoxyItemize}
\item Modules with types
\end{DoxyItemize}
\item \href{files.html}{\texttt{ List of files}}
\begin{DoxyItemize}
\item File structure
\end{DoxyItemize}
\item \href{pages.html}{\texttt{ List of feature pages}}
\begin{DoxyItemize}
\item Detailed description of some features of the code 
\end{DoxyItemize}
\end{DoxyItemize}