/[MITgcm]/MITgcm/doc/api_reference/introduction.tex
ViewVC logotype

Annotation of /MITgcm/doc/api_reference/introduction.tex

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


Revision 1.1 - (hide annotations) (download) (as text)
Thu Apr 1 04:11:22 2004 UTC (20 years, 2 months ago) by edhill
Branch: MAIN
CVS Tags: checkpoint52m_post
File MIME type: application/x-tex
 o initial check-in

1 edhill 1.1 %
2     % $Header: $
3     %
4    
5     \chapter{Introduction}
6    
7     This reference guide is intended as a gentle introduction to the
8     MITgcm internals. Each chapter contains a very brief description of
9     the ``package'' that it describes and then a listing of the various
10     functions and subrutines contained therein. The intent is to help the
11     reader become acquainted with the interface to each part of the code,
12     not to delve into the code internals.
13    
14     For a more thorough view of the subroutines, variables, and other
15     internnal details, the reader is invited to use the following
16     references which present different views of the source code:
17     \begin{itemize}
18     \item The MITgcm on-line code browser:
19     \begin{center}
20     \htmladdnormallink{\tt
21     http://mitgcm.org/sealion/code\_reference/callTree.html}
22     {http://mitgcm.org/sealion/code_reference/callTree.html}
23     \end{center}
24     is a helpful interface when, for instance, one wishes to determine
25     where subroutines are called or variables are used.
26    
27     \item The MITgcm CVS Web interface:
28     \begin{center}
29     \htmladdnormallink{\tt http://mitgcm.org/cgi-bin/viewcvs.cgi/}
30     {http://mitgcm.org/cgi-bin/viewcvs.cgi/}
31     \end{center}
32     provides a web-browse-able view that is most useful for determining
33     the history of various changes.
34    
35     \item Finally, the code itself can be obtained at:
36     \begin{center}
37     \htmladdnormallink{\tt http://mitgcm.org/source\_code.html}
38     {http://mitgcm.org/source_code.html}
39     \end{center}
40     and this is the ultimate location to look for details, make changes,
41     or add features.
42    
43     \end{itemize}
44    

  ViewVC Help
Powered by ViewVC 1.1.22