/[MITgcm]/mitgcm.org/sealion/online_documents/onlineDocuments.html
ViewVC logotype

Diff of /mitgcm.org/sealion/online_documents/onlineDocuments.html

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.1 by adcroft, Thu Oct 18 16:52:33 2001 UTC revision 1.5 by adcroft, Mon Oct 29 16:43:46 2001 UTC
# Line 2  Line 2 
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.77 [en] (X11; U; Linux 2.2.19-7.0.10 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>&nbsp;  <ul>
11  <br>It can be viewed by:  <li>
12  <br>&nbsp;  <font size=+1>a <a href="manual/node3.html">manual</a></font></li>
13    
14  <li>  <li>
15  browsing an html version of the MITgcm 'manual' online - see left top</li>  <font size=+1>a hyper-linked <a href="../code_reference/index.html" target="mainFrame">browsable
16    code</a></font></li>
17    
18    <li>
19    <font size=+1>in-source documentation (<a href="#prologues">subroutine
20    descriptions</a>)</font></li>
21    </ul>
22    
23    <center>
24    <h2>
25    The Manual</h2></center>
26    The manual, documenting the formulation, descretization and implementation,
27    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>  <li>
31  browsing the code itself</li>  <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">continuous formulation
35    </a>of
36    the model and illustrates some
37    <a href="manual/illustrations.html">applications</a>
38    <li>
39    <b><font size=+1><a href="manual/discrete.html">Discretization and Algorithm</a></font></b></li>
40    
41    <br>Describes the spatial and temporal discretization of the model equations
42    <li>
43    <b><font size=+1><a href="manual/getting.html">Getting started and using
44    the MITgcm</a></font></b></li>
45    
46    <br>Describes how to <a href="manual/obtaining.html">download</a>,
47    <a href="manual/compiling.html">compile</a>,
48    <a href="manual/running.html">run</a>
49    and <a href="manual/doing.html">modify</a> the model.
50    <li>
51    <b><font size=+1><a href="manual/sarch.html">Software Architecture</a></font></b></li>
52    
53    <br>Describes the software <a href="manual/wrapper.html">infrastructure</a>
54    for
55    <a href="manual/using_wrapper.html">running on parallel systems</a>.
56    <li>
57    <b><font size=+1><a href="manual/autodiff.html">Automatic Differentiation</a></font></b></li>
58    
59    <br>Describes how to generate the adjoint and tangent linear forms of the
60    model.
61    <li>
62    <b><font size=+1><a href="manual/packages.html">Physical Parameterizations
63    and Packages</a></font></b></li>
64    
65    <br>Describes the optional parameterizations and features available in
66    the model.
67    <li>
68    <b><font size=+1><a href="manual/diags.html">Diagnostics and other tools</a></font></b></li>
69    
70    <br>Details of off-line tools used in conjuction with the model.
71    <li>
72    <b><font size=+1><a href="manual/ecco.html">Interface with ECCO</a></font></b></li>
73    
74    <br>Describes the interface of MITgcm in the <a href="http://www.ecco-group.org" target="idontexist">ECCO</a>
75    suite of optimization software tailored to large-scale ocean state-estimation</ol>
76    Jump to the full <a href="manual/contents.html">table of contents</a>.
77    <p>The manual is also downloadable in <a href="manual.ps.gz">PostScript</a>
78    and
79    <a href="manual.pdf">PDF</a>.
80    <br>&nbsp;
81    <center>
82    <h2>
83    <font size=+1>The hyper-linked <a href="../code_reference/index.html" target="mainFrame">browsable
84    code</a></font></h2></center>
85    This allows you to peruse the source code by following hyper-links for
86    variables, subroutines and functions. It allows you to find instances of
87    variables, find where subroutines and functions are called from and inspect
88    full model code.
89    <center>
90    <h2>
91    <a NAME="prologues"></a>In-source documentation</h2></center>
92    Comments in the source code itself have been formatted to render subroutine
93    descriptions (written as prologues at the top of each routine). It is downloadable
94    as:
95    <ul>
96  <li>  <li>
97  downloading and printing the prologues (the subroutine descriptions)</li>  <a href="prologues.ps.gz">PostScript</a></li>
98    
99  <li>  <li>
100  downloading and printing out the manual - see left bottom</li>  <a href="prologues.pdf">PDF</a></li>
101  </ul>  </ul>
102    
103  </body>  </body>
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.5
  ViewVC Help
Powered by ViewVC 1.1.22