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 branches/2017/dev_merge_2017/DOC/tex_main – NEMO

source: branches/2017/dev_merge_2017/DOC/tex_main/NEMO_manual.tex @ 9388

Last change on this file since 9388 was 9388, checked in by nicolasmartin, 6 years ago

Global reorganisation of DOC directory: implementation and configuration of syntax highlighting with 'minted' LaTeX package
New macros have been created to insert different source codes (fortran, xml, c and shell-session) in the document.
Pygments Python package is now required to compile the documentation.

File size: 3.6 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\usepackage{../tex_main/NEMO_manual}
18\usepackage{../tex_sub/minted}
19\pagestyle{fancy}
20\bibliographystyle{../tex_sub/ametsoc}
21
22\makeindex
23
24
25%%
26%% ==============================================================================
27
28\begin{document}
29
30
31%% Frontmatter
32%% ==============================================================================
33
34%% Frontpage
35
36\title{
37\vspace{-6.0cm}\includegraphics[width=1.1\textwidth]{logo_ALL}          \\
38\vspace{ 5.1cm}\includegraphics[width=0.9\textwidth]{NEMO_logo_Black}   \\
39\vspace{ 1.4cm}\rule{345pt}{1.5pt}                                      \\
40\vspace{0.45cm}{\Huge NEMO ocean engine}                                \\
41\rule{345pt}{1.5pt}
42}
43
44\author{
45\Large Gurvan Madec, and the NEMO team                                                          \\
46\texttt{\small\href{mailto:gurvan.madec@locean-ipsl.umpc.fr}{gurvan.madec@locean-ipsl.umpc.fr}} \\
47}
48
49\date{
50Decembre 2017                                                                                \\
51{\small  -- version 4.0 alpha --}                                                            \\
52~                                                                                            \\
53\textit{\small Note du P\^ole de mod\'{e}lisation de l'Institut Pierre-Simon Laplace No 27 } \\
54\vspace{0.45cm}{ ISSN No 1288-1619.}
55}
56%\date{\today}
57
58\maketitle
59\frontmatter
60
61
62%% ToC i.e. Table of Contents
63
64\dominitoc
65\tableofcontents
66
67
68%% Mainmatter
69%% ==============================================================================
70
71\mainmatter
72
73
74%% Abstract - Foreword
75
76\subfile{../tex_sub/abstract_foreword}
77
78
79% Introduction
80
81\subfile{../tex_sub/introduction}
82
83
84% Chapters
85
86\subfile{../tex_sub/chap_model_basics}
87
88\subfile{../tex_sub/chap_time_domain}           % Time discretisation (time stepping strategy)
89
90\subfile{../tex_sub/chap_DOM}          % Space discretisation
91
92\subfile{../tex_sub/chap_TRA}          % Tracer advection/diffusion equation
93
94\subfile{../tex_sub/chap_DYN}          % Dynamics : momentum equation
95
96\subfile{../tex_sub/chap_SBC}          % Surface Boundary Conditions
97
98\subfile{../tex_sub/chap_LBC}          % Lateral Boundary Conditions
99
100\subfile{../tex_sub/chap_LDF}          % Lateral diffusion
101
102\subfile{../tex_sub/chap_ZDF}          % Vertical diffusion
103
104\subfile{../tex_sub/chap_DIA}          % Outputs and Diagnostics
105
106\subfile{../tex_sub/chap_OBS}          % Observation operator
107
108\subfile{../tex_sub/chap_ASM}          % Assimilation increments
109
110\subfile{../tex_sub/chap_STO}          % Stochastic param.
111
112\subfile{../tex_sub/chap_misc}            % Miscellaneous topics
113
114\subfile{../tex_sub/chap_CONFIG}       % Predefined configurations
115
116
117%% Appendix
118
119\appendix
120
121\subfile{../tex_sub/annex_A}              % Generalised vertical coordinate
122
123\subfile{../tex_sub/annex_B}              % Diffusive operator
124
125\subfile{../tex_sub/annex_C}              % Discrete invariants of the eqs.
126
127\subfile{../tex_sub/annex_iso}            % Isoneutral diffusion using triads
128
129\subfile{../tex_sub/annex_D}              % Coding rules
130
131%% Not included
132%\subfile{../tex_sub/chap_conservation}   %
133%\subfile{../tex_sub/annex_E}          % Notes on some on going staff
134%\subfile{../tex_sub/annex_Fox-Kemper} % Notes on Fox-Kemper
135%\subfile{../tex_sub/annex_EVP}           % Notes on EVP
136
137
138%% Backmatter
139%% ==============================================================================
140
141\backmatter
142
143
144%% Index
145
146%\addcontentsline{toc}{chapter}{Index}
147\printindex
148
149
150%% Bibliography
151
152\bibliography{../tex_main/NEMO_manual}
153
154
155\end{document}
Note: See TracBrowser for help on using the repository browser.