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

%% ==============================================================================
%% NEMO_book.tex: build the NEMO Reference Manual
%% ==============================================================================


%% Run ../build_NEMO_manual.sh to generate the PDF version (with pdflatex)

%% Document layout
%% ==============================================================================

\documentclass[a4paper, 11pt]{book}


%% Preamble
%% ==============================================================================

\usepackage{../tex_main/NEMO_manual}
\usepackage{../tex_sub/NEMO_minted}

\makeindex


%% 
%% ==============================================================================

\begin{document}


%% Frontmatter
%% ==============================================================================

%% Frontpage

\title{
\vspace{-6.0cm}\includegraphics[width=1.1\textwidth]{logo_ALL}          \\
\vspace{ 5.1cm}\includegraphics[width=0.9\textwidth]{NEMO_logo_Black}   \\
\vspace{ 1.4cm}\rule{345pt}{1.5pt}                                      \\
\vspace{0.45cm}{\Huge NEMO ocean engine}                                \\
\rule{345pt}{1.5pt}
}

\author{
\Large Gurvan Madec, and the NEMO team                                                          \\
\texttt{\small\href{mailto:gurvan.madec@locean-ipsl.umpc.fr}{gurvan.madec@locean-ipsl.umpc.fr}} \\
}

\date{
Decembre 2017                                                                                \\
{\small  -- version 4.0 alpha --}                                                            \\
~                                                                                            \\
\textit{\small Note du P\^ole de mod\'{e}lisation de l'Institut Pierre-Simon Laplace No 27 } \\
\vspace{0.45cm}{ ISSN No 1288-1619.}
}
%\date{\today}

\maketitle
\frontmatter


%% ToC i.e. Table of Contents

\dominitoc
\tableofcontents


%% Mainmatter
%% ==============================================================================

\mainmatter


%% Abstract - Foreword

\subfile{../tex_sub/abstract_foreword}


% Introduction

\subfile{../tex_sub/introduction}


% Chapters

\subfile{../tex_sub/chap_model_basics}

\subfile{../tex_sub/chap_time_domain}           % Time discretisation (time stepping strategy)

\subfile{../tex_sub/chap_DOM}          % Space discretisation

\subfile{../tex_sub/chap_TRA}          % Tracer advection/diffusion equation

\subfile{../tex_sub/chap_DYN}          % Dynamics : momentum equation

\subfile{../tex_sub/chap_SBC}          % Surface Boundary Conditions

\subfile{../tex_sub/chap_LBC}          % Lateral Boundary Conditions

\subfile{../tex_sub/chap_LDF}          % Lateral diffusion

\subfile{../tex_sub/chap_ZDF}          % Vertical diffusion

\subfile{../tex_sub/chap_DIA}          % Outputs and Diagnostics

\subfile{../tex_sub/chap_OBS}          % Observation operator

\subfile{../tex_sub/chap_ASM}          % Assimilation increments

\subfile{../tex_sub/chap_STO}          % Stochastic param.

\subfile{../tex_sub/chap_misc}            % Miscellaneous topics

\subfile{../tex_sub/chap_CONFIG}       % Predefined configurations


%% Appendix

\appendix

\subfile{../tex_sub/annex_A}              % Generalised vertical coordinate

\subfile{../tex_sub/annex_B}              % Diffusive operator

\subfile{../tex_sub/annex_C}              % Discrete invariants of the eqs.

\subfile{../tex_sub/annex_iso}            % Isoneutral diffusion using triads

\subfile{../tex_sub/annex_D}              % Coding rules

%% Not included
%\subfile{../tex_sub/chap_conservation}   %
%\subfile{../tex_sub/annex_E}          % Notes on some on going staff
%\subfile{../tex_sub/annex_Fox-Kemper} % Notes on Fox-Kemper
%\subfile{../tex_sub/annex_EVP}           % Notes on EVP


%% Backmatter
%% ==============================================================================

\backmatter


%% Bibliography

\cleardoublepage
\phantomsection
\addcontentsline{toc}{chapter}{Bibliography}
\bibliography{../tex_main/NEMO_manual}


%% Index

\cleardoublepage
\phantomsection
\addcontentsline{toc}{chapter}{Index}
\printindex


\end{document}