/[MITgcm]/manual/manual.tex
ViewVC logotype

Diff of /manual/manual.tex

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

revision 1.7 by cnh, Tue Oct 9 10:48:01 2001 UTC revision 1.33 by cnh, Tue Aug 2 17:13:01 2005 UTC
# Line 1  Line 1 
1  % $Header$  % $Header$
2  % $Name$  % $Name$
3    
4  \documentclass[12pt]{book}  \documentclass[10pt]{book}
5    
6  \usepackage{amsfonts}  %To help cross-reference
7    %\usepackage{showlabels}
8    
9    %aja%\usepackage{amsfonts}
10  \usepackage{amsmath}  \usepackage{amsmath}
11  \usepackage{html}  \usepackage{html}
12  \usepackage{epsfig}  \usepackage{hthtml}
13  \usepackage{graphics,subfigure}  \usepackage{graphicx}
14  \usepackage{array}  
15  \usepackage{multirow}  % CNH playing around with page widths
16  \usepackage{fancyhdr}  \usepackage{anysize}
17  \usepackage{psfrag}  
18  %\usepackage{oldgerm}  %cnh%\usepackage{array}
19    %cnh%\usepackage{multirow}
20    
21    %eh3  Commands to reference either files or symbols within the "HTML-ized"
22    %eh3  ("vdb") code.
23    %eh3  
24    %afe seems like these need to be long, sorry
25    \newcommand{\varlink}[2]{\htmladdnormallink{\tt #1}{../code_reference/vdb/byname/#2.html}}
26    \newcommand{\filelink}[2]{\htmladdnormallink{\bf \tt #1}{../code_reference/vdb/byname/#2.html}}
27    
28    % afe  Commands to standardize typesetting
29    \newcommand{\file}[1]{\texttt{#1}}
30    \newcommand{\sectiontitle}[1]{\textsl{#1}}
31    \newcommand{\code}[1]{\texttt{#1}}
32    
33    %%  EH3 : try out the epsfig package
34    \usepackage[dvips]{epsfig}
35    \def\scalefig#1{\epsfxsize #1\textwidth}
36    
37    %EH3% ==========================================================
38    %EH3%  ***   PRIVATE SECTIONS   ******   PRIVATE SECTIONS   ***
39    %EH3%
40    %EH3%  Directions: To build the ``private'' or ``local-only''
41    %EH3%    version of this manual, then edit the following so
42    %EH3%    they appear as:
43    %EH3%
44    %EH3%    % \includecomment{versionprivate}
45    %EH3%    \excludecoment{versionprivate}
46    %EH3%
47    %EH3%    The default is to include everything which is:
48    %EH3%
49    %EH3%    \includecomment{versionprivate}
50    %EH3%    % \excludecoment{versionprivate}
51    
52    %\includecomment{versionprivate}
53    \excludecomment{versionprivate}
54    
55    %EH3%
56    %EH3%    To use this comment, simply bracket any part of the
57    %EH3%    manual with two lines that contain ONLY the following
58    %EH3%    pair:
59    %EH3%
60    %EH3%      \begin{versionprivate}
61    %EH3%      \end{versionprivate}
62    %EH3%
63    %EH3%    with NO additional comments or other commands on the
64    %EH3%    lines containing the \begin{...}\end{...} statements.
65    %EH3%
66    %EH3%  ***   PRIVATE SECTIONS   ******   PRIVATE SECTIONS   ***
67    %EH3% ==========================================================
68    
69    
70    %ph%\usepackage{epsfig}
71    %ph%\usepackage{psfrag}
72    %ph%\usepackage{oldgerm}
73    
74  % I commented the following because it introduced excessive white space  % I commented the following because it introduced excessive white space
75  %\usepackage{palatcm}              % better PDF  %aja%\usepackage{palatcm}              % better PDF
76    
77  % page headers and footers  % page headers and footers
78    %cnh%\usepackage{fancyhdr}
79  %\pagestyle{fancy}  %\pagestyle{fancy}
80  \fancyhead{}  %cnh%\fancyhead{}
81  \fancyhead[LO]{\slshape \rightmark}  %cnh%\fancyhead[LO]{\slshape \rightmark}
82  \fancyhead[RE]{\slshape \leftmark}  %cnh%\fancyhead[RE]{\slshape \leftmark}
83  \fancyhead[RO,LE]{\thepage}  %cnh%\fancyhead[RO,LE]{\thepage}
84  \fancyfoot[CO,CE]{\today}  %cnh%\fancyfoot[CO,CE]{\today}
85  \fancyfoot[RO,LE]{ }  %cnh%\fancyfoot[RO,LE]{ }
86  \renewcommand{\headrulewidth}{0.4pt}  %cnh%\renewcommand{\headrulewidth}{0.4pt}
87  \renewcommand{\footrulewidth}{0.4pt}  %cnh%\renewcommand{\footrulewidth}{0.4pt}
88    
89  % bibtex stuff  % bibtex stuff
90  \newcommand{\BIBPATH}{.}  %aja%\newcommand{\BIBPATH}{.}
91  \usepackage{natbib}  %aja%\usepackage{natbib}
92  \bibliographystyle{\BIBPATH/jmr_my}  %aja%\bibliographystyle{\BIBPATH/jmr_my}
93  \gdef\harvardleft{[}  %aja%\gdef\harvardleft{[}
94  \gdef\harvardright{]}  %aja%\gdef\harvardright{]}
95  \bibpunct{[}{]}{,}{a}{}{,}  %aja%\bibpunct{[}{]}{,}{a}{}{,}
96    %\bibliographystyle{plain}
97    %-jmc: try agu bib-style (give author names & year instead of just a number)
98    \usepackage[square]{natbib}
99    \bibliographystyle{agu}
100    
101  % referencing  % referencing
102  \newcommand{\refequ}[1]{equation (\ref{equ:#1})}  %ph%\newcommand{\refequ}[1]{equation (\ref{equ:#1})}
103  \newcommand{\refequbig}[1]{Equation (\ref{equ:#1})}  %ph%\newcommand{\refequbig}[1]{Equation (\ref{equ:#1})}
104  \newcommand{\reftab}[1]{Tab.~\ref{tab:#1}}  %ph%\newcommand{\reftab}[1]{Tab.~\ref{tab:#1}}
105  \newcommand{\reftabno}[1]{\ref{tab:#1}}  %ph%\newcommand{\reftabno}[1]{\ref{tab:#1}}
106  \newcommand{\reffig}[1]{Fig.~\ref{fig:#1}}  %ph%\newcommand{\reffig}[1]{Fig.~\ref{fig:#1}}
107  \newcommand{\reffigno}[1]{\ref{fig:#1}}  %ph%\newcommand{\reffigno}[1]{\ref{fig:#1}}
108    
109  % stuff for psfrag  % stuff for psfrag
110  \newcommand{\textinfigure}[1]{{\footnotesize\textbf{\textsf{#1}}}}  %ph%\newcommand{\textinfigure}[1]{{\footnotesize\textbf{\textsf{#1}}}}
111  \newcommand{\mathinfigure}[1]{\small\ensuremath{{#1}}}  %ph%\newcommand{\mathinfigure}[1]{\small\ensuremath{{#1}}}
112    
113  % This allows numbering of subsubsections  % This allows numbering of subsubsections
114  \setcounter{secnumdepth}{3}  \setcounter{secnumdepth}{3}
115  % This changes the the chapter title  % This changes the the chapter title
116  %\renewcommand{\chaptername}{Section}  %\renewcommand{\chaptername}{Section}
117    
118  \usepackage{showlabels}  
119    % This allows hyperlinks in PDF
120    % hyperref package and colors for hyperref package
121    \usepackage{color}
122    \usepackage{hyperref}
123    %\usepackage[dvips]
124    \definecolor{darkgreen}{rgb}{0,0.4,0}
125    \definecolor{darkblue}{rgb}{0,0,0.4}
126    \definecolor{darkred}{rgb}{0.5,0,0}
127    \hypersetup{breaklinks=true,
128      colorlinks=true,
129      linkcolor=darkgreen,
130      citecolor=darkblue,
131      pagecolor=darkred,
132      pdftitle={MITgcm Release 1 Documentation},
133      pdfauthor={MITgcm-support@mitgcm.org},
134      pdfkeywords={oceanography, ocean model, general circulation model,
135        non-hydrostatic, finite volume, inverse methods, adjoint method}
136      }
137    
138    % Some definitions (AMM)
139    \def\p#1{{\partial \over {\partial #1}}}
140    \def\pp#1#2{{\partial #1 \over {\partial #2}}}
141    \def\dd#1#2{{d #1 \over {d #2}}}
142    \def\bq{\begin{equation}}
143    \def\bqa{\begin{eqnarray}}
144    \def\eq{\end{equation}}
145    \def\eqa{\end{eqnarray}}
146    
147    \def\h{ {1\over2} }
148    \def\txt{\mbox{$2^\circ$ x $2.5^\circ \,$}}
149    \def\fxf{\mbox{$4^\circ$ x $5^\circ \,$}}
150    
151    \def\blankpage{ \vspace*{\fill} \vspace{5in} \vfill \newpage}
152    
153    
154  \begin{document}  \begin{document}
155    
156    \bodytext{bgcolor="#FFFFFFFF"}
157    
158  \tableofcontents  \tableofcontents
159  \pagebreak  %\pagebreak
160    
161  \part{MIT GCM basics}  %\part{MIT GCM basics}
162    
163  % Section: Overview  % Section: Overview
164  \input{part1/part1}  \input{part1/part1}
165  \pagebreak  %\pagebreak
166    
167  % Section: Discretization and Algorithm  % Section: Discretization and Algorithm
168  \input{part2/part2}  \input{part2/part2}
169  \pagebreak  %\pagebreak
170    
171  % Section: Getting started  % Section: Getting started
172  \input{part3/part3}  \input{part3/part3}
173  \pagebreak  %\pagebreak
174    
175  % Section: Software Architecture  % Section: Software Architecture
176  \input{part4/part4}  \input{part4/part4}
177  \pagebreak  %\pagebreak
178    
179    
180  \part{Adjoint of the MIT GCM}  %\part{Adjoint of the MIT GCM}
181    
182  % Section: Automatic Differentiation  % Section: Automatic Differentiation
183  \input{part5/part5}  \input{part5/part5}
184  \pagebreak  %\pagebreak
185    
186    
187  \part{Additional features}  %\part{Additional features}
188    
189  % Section: Physical Packages  % Section: Physical Packages
190  \input{part6/part6}  \input{part6/part6}
191  \pagebreak  %\pagebreak
192    
193  % Section: Diagnostics  % Section: Pre-processing and Post-processing Tools
194  \input{part7/part7}  \input{part7/part7}
195  \pagebreak  %\pagebreak
196    
197  % Section: ECCO Interface  % Section: ECCO
198  \input{part8/part8}  \input{part8/part8}
199  \pagebreak  %\pagebreak
200    
201    % Section: Model Uses
202    \input{model_uses}
203    %\pagebreak
204    
205  % Section: References:  % Section: References:
206  \markboth{BIBLIOGRAPHY}{BIBLIOGRAPHY}  %\markboth{BIBLIOGRAPHY}{BIBLIOGRAPHY}
207  \addcontentsline{toc}{chapter}{BIBLIOGRAPHY}  \addcontentsline{toc}{chapter}{BIBLIOGRAPHY}
208  \bibliography{\BIBPATH/manual_references}  %aja%\bibliography{\BIBPATH/manual_references}
209    \bibliography{manual_references}
210    
211  \end{document}  \end{document}

Legend:
Removed from v.1.7  
changed lines
  Added in v.1.33

  ViewVC Help
Powered by ViewVC 1.1.22