New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
NEMO_manual.tex in NEMO/trunk/doc/latex/NEMO/main – NEMO

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

Last change on this file since 10442 was 10442, checked in by nicolasmartin, 5 years ago

Front page edition, cleaning in custom LaTeX commands and add index for single subfile compilation

  • Use \thanks storing cmd to refer to the ST members list for 2018 in an footnote on the cover page
  • NEMO and Fortran in small capitals
  • Removing of unused or underused custom cmds, move local cmds to their respective .tex file
  • Addition of new ones (\zstar, \ztilde, \sstar, \stilde, \ie, \eg, \fortran, \fninety)
  • Fonts for indexed items: italic font for files (modules and .nc files), preformat for code (CPP keys, routines names and namelists content)
File size: 4.4 KB
Line 
1%% ==============================================================================
2%% NEMO_book.tex: build the NEMO Reference Manual
3%% ==============================================================================
4
5
6%% Run ../build_NEMO_manual.sh to generate the PDF version (with pdflatex)
7
8%% Document layout
9%% ==============================================================================
10
11\documentclass[a4paper, 11pt]{book}
12
13
14%% Preamble
15%% ==============================================================================
16
17%% Custom style
18\usepackage{../main/NEMO_manual}
19
20\makeindex
21
22
23%%
24%% ==============================================================================
25
26%% Include references and index for single subfile compilation
27\newcommand{\biblio}{\bibliography{../main/NEMO_manual}}
28\newcommand{\pindex}{\printindex}
29
30\begin{document}
31
32%% Override custom cmds for full manual compilation
33\renewcommand{\biblio}{}
34\renewcommand{\pindex}{}
35
36
37%% Frontmatter
38%% ==============================================================================
39
40%% Frontpage
41
42\title{
43%\vspace{-6.0cm}\includegraphics[width=1.1\textwidth]{logo_ALL}            \\
44%\vspace{ 5.1cm}\includegraphics[width=0.9\textwidth]{NEMO_logo_Black}  \\
45\vspace{ 1.4cm}\rule{345pt}{1.5pt}                                      \\
46\vspace{0.45cm}{\Huge NEMO ocean engine}                                \\
47\rule{345pt}{1.5pt}
48}
49
50\author{
51  \Large Gurvan Madec and NEMO System Team
52  \thanks{
53    Yevgeny Aksenov, Mireck Andrejczuk, Mike Bell, Romain Bourdalle-Badie, Cl\'{e}ment Bricaud,
54    J\'{e}r\^{o}me Chanut, Stefania Ciliberti, Emanuela Clementi, Andrew Coward, Damiano Delrosso,
55    Massimiliano Drudi, Christian Eth\'{e}, Simona Flavoni, Doroteaciro Iovino, Claire L\'{e}vy, Tomas Lovato,
56    Nicolas Martin, S\'{e}bastien Masson, Pierre Mathiot, Gelsomina Mattia, Francesca Mele, Silvia Mocavero,
57    George Nurser, Enda O'Dea, Julien Paul, Cl\'{e}ment Rousset, Dave Storkey, Martin Vancoppenolle
58  }                                                        \\
59                                                           \\
60  \textit{Issue 27, Notes du P\^{o}le de mod\'{e}lisation} \\
61  \textit{Institut Pierre-Simon Laplace (IPSL)}            \\
62  \textit{ISSN 1288-1619}
63}
64
65\date{Version 4.0 -- January 2019}
66%\date{\today}
67
68\maketitle
69\frontmatter
70
71
72%% ToC i.e. Table of Contents
73
74\dominitoc
75\tableofcontents
76
77
78%% Mainmatter
79%% ==============================================================================
80
81\mainmatter
82
83
84%% Foreword
85
86\subfile{../subfiles/foreword}
87
88
89% Introduction
90
91\subfile{../subfiles/introduction}
92
93
94% Chapters
95
96\subfile{../subfiles/chap_model_basics}
97
98\subfile{../subfiles/chap_time_domain}   % Time discretisation (time stepping strategy)
99
100\subfile{../subfiles/chap_DOM}           % Space discretisation
101
102\subfile{../subfiles/chap_TRA}           % Tracer advection/diffusion equation
103
104\subfile{../subfiles/chap_DYN}           % Dynamics : momentum equation
105
106\subfile{../subfiles/chap_SBC}           % Surface Boundary Conditions
107
108\subfile{../subfiles/chap_LBC}           % Lateral Boundary Conditions
109
110\subfile{../subfiles/chap_LDF}           % Lateral diffusion
111
112\subfile{../subfiles/chap_ZDF}           % Vertical diffusion
113
114\subfile{../subfiles/chap_DIA}           % Outputs and Diagnostics
115
116\subfile{../subfiles/chap_OBS}           % Observation operator
117
118\subfile{../subfiles/chap_ASM}           % Assimilation increments
119
120\subfile{../subfiles/chap_STO}           % Stochastic param.
121
122\subfile{../subfiles/chap_misc}          % Miscellaneous topics
123
124\subfile{../subfiles/chap_CONFIG}        % Predefined configurations
125
126
127%% Appendix
128
129\appendix
130
131\subfile{../subfiles/annex_A}             % Generalised vertical coordinate
132
133\subfile{../subfiles/annex_B}             % Diffusive operator
134
135\subfile{../subfiles/annex_C}             % Discrete invariants of the eqs.
136
137\subfile{../subfiles/annex_iso}           % Isoneutral diffusion using triads
138
139\subfile{../subfiles/annex_D}             % Coding rules
140
141%% Not included
142%\subfile{../subfiles/chap_conservation}  %
143%\subfile{../subfiles/annex_E}            % Notes on some on going staff
144%\subfile{../subfiles/annex_Fox-Kemper}   % Notes on Fox-Kemper
145%\subfile{../subfiles/annex_EVP}          % Notes on EVP
146
147
148%% Backmatter
149%% ==============================================================================
150
151\backmatter
152
153
154%% Bibliography
155
156\cleardoublepage
157\phantomsection
158\addcontentsline{toc}{chapter}{Bibliography}
159\bibliography{../main/NEMO_manual}
160
161
162%% Index
163
164\cleardoublepage
165\phantomsection
166\addcontentsline{toc}{chapter}{Index}
167\printindex
168
169
170\end{document}
Note: See TracBrowser for help on using the repository browser.