| 1 |
<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> |
<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> |
| 2 |
<html> |
<html> |
| 3 |
<head> |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| 5 |
<meta name="GENERATOR" content="Mozilla/4.74 [en]C-CCK-MCD (Win98; U) [Netscape]"> |
<meta name="GENERATOR" content="Mozilla/4.75 [en] (X11; U; Linux 2.2.14-5.0 i686) [Netscape]"> |
| 6 |
<title>manual</title> |
<title>manual</title> |
| 7 |
</head> |
</head> |
| 8 |
<body bgcolor="#FFFFFF"> |
<body bgcolor="#FFFFFF"> |
| 9 |
Documentation of MITgcm takes several forms. |
<font size=+1>Documentation of MITgcm takes several forms:</font> |
| 10 |
<ul> |
<ul> |
| 11 |
<br>It can be viewed by: |
<li> |
| 12 |
<br> |
<font size=+1>a <a href="manual/node3.html">manual</a></font></li> |
| 13 |
<li> |
|
| 14 |
browsing an html version of the MITgcm 'manual' online - see left top</li> |
<li> |
| 15 |
|
<font size=+1>a hyper-linked <a href="../code_reference/index.html" target="mainFrame">browsable |
| 16 |
<li> |
code</a></font></li> |
| 17 |
browsing the code itself</li> |
|
| 18 |
|
<li> |
| 19 |
<li> |
<font size=+1>in-source documentation (<a href="#prologues">subroutine |
| 20 |
downloading and printing the prologues (the subroutine descriptions)</li> |
descriptions</a>)</font></li> |
| 21 |
|
</ul> |
| 22 |
<li> |
|
| 23 |
downloading and printing out the manual - see left bottom</li> |
<center> |
| 24 |
</ul> |
<h2> |
| 25 |
|
The manual</h2></center> |
| 26 |
</body> |
The manual, documenting the formulation, descretization and implementation, |
| 27 |
</html> |
can be accessed by following the links on the left. These take you to the |
| 28 |
|
main sections of the document: |
| 29 |
|
<ol> |
| 30 |
|
<li> |
| 31 |
|
<b><font size=+1><a href="manual/overview.html">Overview of MITgcm</a></font></b></li> |
| 32 |
|
|
| 33 |
|
<br>Discusses the |
| 34 |
|
<a href="manual/continuous.html"> |
| 35 |
|
continuous formulation |
| 36 |
|
</a> |
| 37 |
|
of the model and illustrates some |
| 38 |
|
<a href="manual/illustrations.html">applications</a> |
| 39 |
|
<li> |
| 40 |
|
<b><font size=+1><a href="manual/discrete.html">Discretization and Algorithm</a></font></b></li> |
| 41 |
|
|
| 42 |
|
<br>describes the integration algorithm for the various formulations and |
| 43 |
|
gives the spatial discretization of the model equations |
| 44 |
|
<li> |
| 45 |
|
<b><font size=+1><a href="manual/getting.html">Getting started and using |
| 46 |
|
the MITgcm</a></font></b></li> |
| 47 |
|
|
| 48 |
|
<br>describes how to <a href=../online_documents/manual/obtaining.html> |
| 49 |
|
download</a>, |
| 50 |
|
<a href=../online_documents/manual/compiling.html>compile</a>, |
| 51 |
|
<a href=../online_documents/manual/running.html>run</a> and |
| 52 |
|
<a href=../online_documents/manual/doing.html>modify</a> the model. |
| 53 |
|
<li> |
| 54 |
|
<b><font size=+1><a href="manual/sarch.html">Software Architecture</a></font></b></li> |
| 55 |
|
|
| 56 |
|
<br><font >describes the software <a href=../online_documents/manual/wrapper.html>infrastructure</a> used for deploying the model |
| 57 |
|
efficiently on a wide range of parallel and uniprocessor machines. |
| 58 |
|
<a href=../online_documents/manual/using_wrapper.html>Running on parallel |
| 59 |
|
systems</a> is discussed here. |
| 60 |
|
</font> |
| 61 |
|
<li> |
| 62 |
|
<b><font size=+1><a href="manual/autodiff.html">Automatic Differentiation</a></font></b></li> |
| 63 |
|
|
| 64 |
|
<br>describes how to generate the adjoint and tangent linear forms of the |
| 65 |
|
model. |
| 66 |
|
<li> |
| 67 |
|
<b><font size=+1><a href="manual/packages.html">Physical Parameterizations |
| 68 |
|
and Packages</a></font></b></li> |
| 69 |
|
|
| 70 |
|
<br>describes the optional parameterizations and features supplied in the |
| 71 |
|
model. |
| 72 |
|
<li> |
| 73 |
|
<b><font size=+1><a href="manual/diags.html">Diagnostics and other tools</a></font></b></li> |
| 74 |
|
|
| 75 |
|
<br>details of off-line tools used in conjuction with the model. |
| 76 |
|
<li> |
| 77 |
|
<b><font size=+1><a href="manual/ecco.html">Interface with ECCO</a></font></b></li> |
| 78 |
|
|
| 79 |
|
<br>describes the interface to the |
| 80 |
|
<A href=http://www.ecco-group.org target=idontexist>ECCO</a> environment |
| 81 |
|
(a custom suite of |
| 82 |
|
optimization software tailored to large-scale ocean |
| 83 |
|
state-estimation). </ol> |
| 84 |
|
or jump to the full <a href="manual/contents.html">table of contents</a>.The |
| 85 |
|
manual is also downloadable in <a href="manual.ps.gz">PostScript</a> and |
| 86 |
|
<a href="manual.pdf">PDF</a>. |
| 87 |
|
<br> |
| 88 |
|
<center> |
| 89 |
|
<h2> |
| 90 |
|
<font size=+1>The hyper-linked <a href="../code_reference/index.html" target="mainFrame">browsable |
| 91 |
|
code</a></font></h2></center> |
| 92 |
|
This allows you to peruse the source code by following hyper-links for |
| 93 |
|
variables, subroutines and functions. It allows you to find instances of |
| 94 |
|
variables, find where subroutines and functions are called from and see |
| 95 |
|
the actual fortran. |
| 96 |
|
<center> |
| 97 |
|
<h2> |
| 98 |
|
<a NAME="prologues"></a>In-source documentation</h2></center> |
| 99 |
|
This takes the form of comments in the source code and has been formatted |
| 100 |
|
to render subroutine descriptions (written as prologues at the top of each |
| 101 |
|
routine). It is downloadable as: |
| 102 |
|
<ul> |
| 103 |
|
<li> |
| 104 |
|
<a href="prologues.ps.gz">PostScript</a></li> |
| 105 |
|
|
| 106 |
|
<li> |
| 107 |
|
<a href="prologues.pdf">PDF</a></li> |
| 108 |
|
</ul> |
| 109 |
|
|
| 110 |
|
</body> |
| 111 |
|
</html> |
Parent Directory
| 
Revision Log
| 
Revision Graph
| 
Patch