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

Last change on this file since 10146 was 10146, checked in by nicolasmartin, 2 years ago

Reorganisation for future addition of .rst files from users wiki extraction

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