doc/api_reference/introduction.tex

%
% $Header: /u/gcmpack/MITgcm/doc/api_reference/introduction.tex,v 1.1 2004/04/01 04:11:22 edhill Exp $
%

\chapter{Introduction}

This reference guide is intended as a gentle introduction to the
MITgcm internals.  Each chapter contains a very brief description of
the ``package'' that it describes and then a listing of the various
functions and subroutines contained therein.  The intent is to help the
reader become acquainted with the interface to each part of the code,
not to delve into the code internals.

For a more thorough view of the subroutines, variables, and other
internnal details, the reader is invited to use the following
references which present different views of the source code:
\begin{itemize}
\item The MITgcm on-line code browser:
  \begin{center}
    \htmladdnormallink{\tt
      http://mitgcm.org/sealion/code\_reference/callTree.html}
    {http://mitgcm.org/sealion/code_reference/callTree.html}
  \end{center}
  is a helpful interface when, for instance, one wishes to determine
  where subroutines are called or variables are used.

\item The MITgcm CVS Web interface:
  \begin{center}
    \htmladdnormallink{\tt http://mitgcm.org/cgi-bin/viewcvs.cgi/}
    {http://mitgcm.org/cgi-bin/viewcvs.cgi/}
  \end{center}
  provides a web-browse-able view that is most useful for determining
  the history of various changes.

\item Finally, the code itself can be obtained at:
  \begin{center}
    \htmladdnormallink{\tt http://mitgcm.org/source\_code.html}
    {http://mitgcm.org/source_code.html}
  \end{center}
  and this is the ultimate location to look for details, make changes,
  or add features.

\end{itemize}
1	edhill	1.1	%
2	dimitri	1.2	% $Header: /u/gcmpack/MITgcm/doc/api_reference/introduction.tex,v 1.1 2004/04/01 04:11:22 edhill Exp $
3	edhill	1.1	%
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	dimitri	1.2	functions and subroutines contained therein. The intent is to help the
11	edhill	1.1	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}