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:
  1. Overview of MITgcm

  2. Discusses the continuous formulation of the model and illustrates some applications
  3. Discretization and Algorithm

  4. Describes the spatial and temporal discretization of the model equations
  5. Getting started and using the MITgcm

  6. Describes how to download, compile, run and modify the model.
  7. Software Architecture

  8. Describes the software infrastructure for running on parallel systems.
  9. Automatic Differentiation

  10. Describes how to generate the adjoint and tangent linear forms of the model.
  11. Physical Parameterizations and Packages

  12. Describes the optional parameterizations and features available in the model.
  13. Diagnostics and other tools

  14. Details of off-line tools used in conjuction with the model.
  15. Interface with ECCO

  16. 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.
 

The hyper-linked browsable code

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: