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

Last change on this file since 10509 was 10509, checked in by andmirek, 19 months ago

ticket #2204 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    George Nurser, Enda O'Dea, Julien Paul, Cl\'{e}ment Rousset, Dave Storkey, Martin Vancoppenolle
53  }                                                        \\
54                                                           \\
55  \textit{Issue 27, Notes du P\^{o}le de mod\'{e}lisation} \\
56  \textit{Institut Pierre-Simon Laplace (IPSL)}            \\
57  \textit{ISSN 1288-1619}
58}
59\date{Version 4.0 -- January 2019}
60%\date{\today}
61
62\maketitle
63\frontmatter
64
65
66%% ToC i.e. Table of Contents
67\dominitoc
68\tableofcontents
69
70
71%% Mainmatter
72%% ==============================================================================
73
74\mainmatter
75
76%% Foreword
77\subfile{../subfiles/foreword}
78
79%% Introduction
80\subfile{../subfiles/introduction}
81
82%% Chapters
83\subfile{../subfiles/chap_model_basics}
84\subfile{../subfiles/chap_time_domain}   % Time discretisation (time stepping strategy)
85\subfile{../subfiles/chap_DOM}           % Space discretisation
86\subfile{../subfiles/chap_TRA}           % Tracer advection/diffusion equation
87\subfile{../subfiles/chap_DYN}           % Dynamics : momentum equation
88\subfile{../subfiles/chap_SBC}           % Surface Boundary Conditions
89\subfile{../subfiles/chap_LBC}           % Lateral Boundary Conditions
90\subfile{../subfiles/chap_LDF}           % Lateral diffusion
91\subfile{../subfiles/chap_ZDF}           % Vertical diffusion
92\subfile{../subfiles/chap_DIA}           % Outputs and Diagnostics
93\subfile{../subfiles/chap_OBS}           % Observation operator
94\subfile{../subfiles/chap_ASM}           % Assimilation increments
95\subfile{../subfiles/chap_STO}           % Stochastic param.
96\subfile{../subfiles/chap_misc}          % Miscellaneous topics
97\subfile{../subfiles/chap_CONFIG}        % Predefined configurations
98
99%% Appendix
100\appendix
101\subfile{../subfiles/annex_A}             % Generalised vertical coordinate
102\subfile{../subfiles/annex_B}             % Diffusive operator
103\subfile{../subfiles/annex_C}             % Discrete invariants of the eqs.
104\subfile{../subfiles/annex_iso}           % Isoneutral diffusion using triads
105\subfile{../subfiles/annex_D}             % Coding rules
106
107%% Not included
108%\subfile{../subfiles/chap_conservation}  %
109%\subfile{../subfiles/annex_E}            % Notes on some on going staff
110
111
112%% Backmatter
113%% ==============================================================================
114
115\backmatter
116
117%% Bibliography
118\cleardoublepage
119\phantomsection
120\addcontentsline{toc}{chapter}{Bibliography}
121\bibliography{../main/NEMO_manual}
122
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.