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 @ 10146

Last change on this file since 10146 was 10146, checked in by nicolasmartin, 6 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
RevLine 
[9376]1%% ==============================================================================
2%% NEMO_book.tex: build the NEMO Reference Manual
3%% ==============================================================================
[707]4
5
[9388]6%% Run ../build_NEMO_manual.sh to generate the PDF version (with pdflatex)
[707]7
[9388]8%% Document layout
9%% ==============================================================================
[9376]10
[9388]11\documentclass[a4paper, 11pt]{book}
12
13
[9376]14%% Preamble
15%% ==============================================================================
16
[10146]17%% Custom style
18\usepackage{../main/NEMO_manual}
19\usepackage{../main/NEMO_minted}
[707]20
[9388]21\makeindex
[817]22
[9376]23
[9388]24%%
25%% ==============================================================================
[9376]26
[9388]27\begin{document}
[9376]28
29
30%% Frontmatter
31%% ==============================================================================
32
[9388]33%% Frontpage
[707]34
[9388]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}
[707]42
[9388]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}
[707]47
[9388]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
[9376]57\maketitle
[707]58\frontmatter
59
60
[9376]61%% ToC i.e. Table of Contents
62
63\dominitoc
64\tableofcontents
65
66
67%% Mainmatter
68%% ==============================================================================
69
[707]70\mainmatter
71
72
[9376]73%% Abstract - Foreword
74
[10146]75\subfile{../subfiles/abstract_foreword}
[707]76
77
[9376]78% Introduction
79
[10146]80\subfile{../subfiles/introduction}
[707]81
82
[9376]83% Chapters
84
[10146]85\subfile{../subfiles/chap_model_basics}
[707]86
[10146]87\subfile{../subfiles/chap_time_domain}   % Time discretisation (time stepping strategy)
[707]88
[10146]89\subfile{../subfiles/chap_DOM}           % Space discretisation
[707]90
[10146]91\subfile{../subfiles/chap_TRA}           % Tracer advection/diffusion equation
[707]92
[10146]93\subfile{../subfiles/chap_DYN}           % Dynamics : momentum equation
[707]94
[10146]95\subfile{../subfiles/chap_SBC}           % Surface Boundary Conditions
[707]96
[10146]97\subfile{../subfiles/chap_LBC}           % Lateral Boundary Conditions
[707]98
[10146]99\subfile{../subfiles/chap_LDF}           % Lateral diffusion
[707]100
[10146]101\subfile{../subfiles/chap_ZDF}           % Vertical diffusion
[707]102
[10146]103\subfile{../subfiles/chap_DIA}           % Outputs and Diagnostics
[2541]104
[10146]105\subfile{../subfiles/chap_OBS}           % Observation operator
[2349]106
[10146]107\subfile{../subfiles/chap_ASM}           % Assimilation increments
[2349]108
[10146]109\subfile{../subfiles/chap_STO}           % Stochastic param.
[5405]110
[10146]111\subfile{../subfiles/chap_misc}          % Miscellaneous topics
[6140]112
[10146]113\subfile{../subfiles/chap_CONFIG}        % Predefined configurations
[707]114
115
[9388]116%% Appendix
[9376]117
[817]118\appendix
[707]119
[10146]120\subfile{../subfiles/annex_A}             % Generalised vertical coordinate
[707]121
[10146]122\subfile{../subfiles/annex_B}             % Diffusive operator
[707]123
[10146]124\subfile{../subfiles/annex_C}             % Discrete invariants of the eqs.
[9376]125
[10146]126\subfile{../subfiles/annex_iso}           % Isoneutral diffusion using triads
[9376]127
[10146]128\subfile{../subfiles/annex_D}             % Coding rules
[9376]129
130%% Not included
[10146]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
[9376]135
136
137%% Backmatter
138%% ==============================================================================
139
140\backmatter
141
142
[9394]143%% Bibliography
144
145\cleardoublepage
146\phantomsection
147\addcontentsline{toc}{chapter}{Bibliography}
[10146]148\bibliography{../main/NEMO_manual}
[9394]149
150
[9376]151%% Index
152
[9394]153\cleardoublepage
154\phantomsection
[9393]155\addcontentsline{toc}{chapter}{Index}
[707]156\printindex
157
158
[781]159\end{document}
Note: See TracBrowser for help on using the repository browser.