source: NEMO/trunk/doc/latex/NEMO/main/NEMO_manual.tex @ 10614

Last change on this file since 10614 was 10614, checked in by smueller, 3 years ago

Merge of changeset [10613] into the trunk

File size: 4.2 KB
Line 
1%% ==============================================================================
2%% NEMO Reference Manual
3%% ==============================================================================
4
5
6%% Run ./PDF_creation.sh to generate the manual with latexmk
7
8
9%% Preamble
10%% ==============================================================================
11
12%% Document layout
13\documentclass{book}
14
15%% Custom style (.sty)
16\usepackage{../main/NEMO_manual}
17
18%% Include references and index for single subfile compilation
19\newcommand{\biblio}{\bibliography{../main/NEMO_manual}}
20\newcommand{\pindex}{\printindex}
21
22\makeindex
23
24%% End of common preamble between main and sub-files
25\begin{document}
26
27%% Override custom cmds for full manual compilation
28\renewcommand{\biblio}{}
29\renewcommand{\pindex}{}
30
31
32%% Frontmatter
33%% ==============================================================================
34
35%% Frontpage
36\title{
37  \includegraphics[height=0.05\textheight]{CMCC}\hfill
38  \includegraphics[height=0.05\textheight]{CNRS}\hfill
39  \includegraphics[height=0.05\textheight]{MOI} \hfill
40  \includegraphics[height=0.05\textheight]{UKMO}\hfill
41  \includegraphics[height=0.05\textheight]{NERC}       \\
42  \includegraphics[ width=0.8\textwidth  ]{NEMO_grey}  \\
43  {\Huge NEMO ocean engine}                            \\
44}
45\author{
46  \Large Gurvan Madec and NEMO System Team
47  \thanks{
48    Yevgeny Aksenov, Mirek Andrejczuk, Mike Bell, Romain Bourdalle-Badie, Cl\'{e}ment Bricaud,
49    J\'{e}r\^{o}me Chanut, Stefania Ciliberti, Emanuela Clementi, Andrew Coward, Damiano Delrosso,
50    Massimiliano Drudi, Christian Eth\'{e}, Simona Flavoni, Doroteaciro Iovino, Claire L\'{e}vy, Tomas Lovato,
51    Nicolas Martin, S\'{e}bastien Masson, Pierre Mathiot, Gelsomina Mattia, Francesca Mele, Silvia Mocavero,
52    Simon M\"{u}ller, George Nurser, Enda O'Dea, Julien Paul, Cl\'{e}ment Rousset, Dave Storkey,
53    Martin Vancoppenolle
54  }                                                        \\
55                                                           \\
56  \textit{Issue 27, Notes du P\^{o}le de mod\'{e}lisation} \\
57  \textit{Institut Pierre-Simon Laplace (IPSL)}            \\
58  \textit{ISSN 1288-1619}
59}
60\date{Version 4.0 -- January 2019}
61%\date{\today}
62
63\maketitle
64\frontmatter
65
66
67%% ToC i.e. Table of Contents
68\dominitoc
69\tableofcontents
70
71
72%% Mainmatter
73%% ==============================================================================
74
75\mainmatter
76
77%% Foreword
78\subfile{../subfiles/foreword}
79
80%% Introduction
81\subfile{../subfiles/introduction}
82
83%% Chapters
84\subfile{../subfiles/chap_model_basics}
85\subfile{../subfiles/chap_time_domain}   % Time discretisation (time stepping strategy)
86\subfile{../subfiles/chap_DOM}           % Space discretisation
87\subfile{../subfiles/chap_TRA}           % Tracer advection/diffusion equation
88\subfile{../subfiles/chap_DYN}           % Dynamics : momentum equation
89\subfile{../subfiles/chap_SBC}           % Surface Boundary Conditions
90\subfile{../subfiles/chap_LBC}           % Lateral Boundary Conditions
91\subfile{../subfiles/chap_LDF}           % Lateral diffusion
92\subfile{../subfiles/chap_ZDF}           % Vertical diffusion
93\subfile{../subfiles/chap_DIA}           % Outputs and Diagnostics
94\subfile{../subfiles/chap_OBS}           % Observation operator
95\subfile{../subfiles/chap_ASM}           % Assimilation increments
96\subfile{../subfiles/chap_STO}           % Stochastic param.
97\subfile{../subfiles/chap_misc}          % Miscellaneous topics
98\subfile{../subfiles/chap_CONFIG}        % Predefined configurations
99
100%% Appendix
101\appendix
102\subfile{../subfiles/annex_A}             % Generalised vertical coordinate
103\subfile{../subfiles/annex_B}             % Diffusive operator
104\subfile{../subfiles/annex_C}             % Discrete invariants of the eqs.
105\subfile{../subfiles/annex_iso}           % Isoneutral diffusion using triads
106\subfile{../subfiles/annex_D}             % Coding rules
107
108%% Not included
109%\subfile{../subfiles/chap_conservation}  %
110%\subfile{../subfiles/annex_E}            % Notes on some on going staff
111
112
113%% Backmatter
114%% ==============================================================================
115
116\backmatter
117
118%% Bibliography
119\cleardoublepage
120\phantomsection
121\addcontentsline{toc}{chapter}{Bibliography}
122\bibliography{../main/NEMO_manual}
123
124%% Index
125\cleardoublepage
126\phantomsection
127\addcontentsline{toc}{chapter}{Index}
128\printindex
129
130
131\end{document}
Note: See TracBrowser for help on using the repository browser.