--- mitgcm.org/sealion/online_documents/onlineDocuments.html 2001/10/18 16:52:33 1.1
+++ mitgcm.org/sealion/online_documents/onlineDocuments.html 2001/10/21 04:23:00 1.3
@@ -1,27 +1,111 @@
-
-
-
-
-
- manual
-
-
-Documentation of MITgcm takes several forms.
-
-
It can be viewed by:
-
--
-browsing an html version of the MITgcm 'manual' online - see left top
-
--
-browsing the code itself
-
--
-downloading and printing the prologues (the subroutine descriptions)
-
--
-downloading and printing out the manual - see left bottom
-
-
-
-
+
+
+
+
+
+ manual
+
+
+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 integration algorithm for the various formulations and
+gives the spatial 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 used for deploying the model
+efficiently on a wide range of parallel and uniprocessor machines.
+Running on parallel
+systems is discussed here.
+
+-
+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 supplied in the
+model.
+-
+Diagnostics and other tools
+
+
details of off-line tools used in conjuction with the model.
+-
+Interface with ECCO
+
+
describes the interface to the
+ECCO environment
+(a custom suite of
+optimization software tailored to large-scale ocean
+state-estimation).
+or 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 see
+the actual fortran.
+
+
+In-source documentation
+This takes the form of comments in the source code and has been formatted
+to render subroutine descriptions (written as prologues at the top of each
+routine). It is downloadable as:
+
+
+
+