Documentation of MITgcm takes several forms:
The Manual
The manual, documenting the formulation, descretization and implementation,
can be accessed by following the links on the left. These take you to the
main sections of the document:
- 
Overview of MITgcm
 
Discusses the
continuous formulation
of
the model and illustrates some
applications
- 
Discretization and Algorithm
 
Describes the spatial and temporal discretization of the model equations
- 
Getting started and using
the MITgcm
 
Describes how to download,
compile,
run
and modify the model.
- 
Software Architecture
 
Describes the software infrastructure
for
running on parallel systems.
- 
Automatic Differentiation
 
Describes how to generate the adjoint and tangent linear forms of the
model.
- 
Physical Parameterizations
and Packages
 
Describes the optional parameterizations and features available in
the model.
- 
Diagnostics and other tools
 
Details of off-line tools used in conjuction with the model.
- 
Interface with ECCO
 
Describes the interface of MITgcm in the ECCO
suite of optimization software tailored to large-scale ocean state-estimation
Jump to the full table of contents.
The manual is also downloadable in PostScript
and
PDF.
 
This allows you to peruse the source code by following hyper-links for
variables, subroutines and functions. It allows you to find instances of
variables, find where subroutines and functions are called from and inspect
full model code.
In-source documentation
Comments in the source code itself have been formatted to render subroutine
descriptions (written as prologues at the top of each routine). It is downloadable
as: