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

%% ==============================================================================
%% NEMO Reference Manual
%% ==============================================================================


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

%% Document layout
\documentclass[draft]{scrreport}

%% Custom style (.sty)
\usepackage{../../global/packages}
\hypersetup{
  pdftitle={NEMO ocean engine},
  pdfauthor={Gurvan Madec and NEMO System Team},
  colorlinks
}

%% Include references and index for single subfile compilation
\newcommand{\biblio}{\bibliography{../main/NEMO_manual}}
\newcommand{\pindex}{\printindex}

\makeindex

%% End of common preamble between main and sub-files
\begin{document}
\pagenumbering{gobble}

%% Override custom cmds for full manual compilation
\renewcommand{\biblio}{}
\renewcommand{\pindex}{}


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

\title{NEMO ocean engine}
\author{Gurvan Madec \and NEMO System Team\thanks{
    TBD
  }
}
\date{\today}

%% Title and information pages
\input{../../global/frontpages}

%% Citation embedded
\textsf{
``{\bfseries NEMO ocean engine}'', 
Madec Gurvan and NEMO System Team, 
{\em Scientific Notes of Climate Modelling Center (27)}, ISSN 1288-1619, 
Institut Pierre-Simon Laplace (IPSL), 
}

\newpage
%\frontmatter   %% Chapter numbering off and Roman numerals for page numbers
\pagenumbering{roman}

\subfile{../subfiles/foreword}            %% Foreword


%% ToC i.e. Table of Contents
\newpage
\dominitoc
\tableofcontents

\clearpage
%\end{document}

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

%\mainmatter   %% Chapter numbering on, page numbering is reset with Arabic numerals
\pagenumbering{arabic}

\graphicspath{{../../figures/NEMO/}}

\subfile{../subfiles/introduction}        %% Introduction

%% Chapters
\subfile{../subfiles/chap_model_basics}
\subfile{../subfiles/chap_time_domain}    %% Time discretisation (time stepping strategy)
\subfile{../subfiles/chap_DOM}            %% Space discretisation
\subfile{../subfiles/chap_TRA}            %% Tracer advection/diffusion equation
\subfile{../subfiles/chap_DYN}            %% Dynamics : momentum equation
\subfile{../subfiles/chap_SBC}            %% Surface Boundary Conditions
\subfile{../subfiles/chap_LBC}            %% Lateral Boundary Conditions
\subfile{../subfiles/chap_LDF}            %% Lateral diffusion
\subfile{../subfiles/chap_ZDF}            %% Vertical diffusion
\subfile{../subfiles/chap_DIA}            %% Outputs and Diagnostics
\subfile{../subfiles/chap_OBS}            %% Observation operator
\subfile{../subfiles/chap_ASM}            %% Assimilation increments
\subfile{../subfiles/chap_STO}            %% Stochastic param.
\subfile{../subfiles/chap_misc}           %% Miscellaneous topics
\subfile{../subfiles/chap_CONFIG}         %% Predefined configurations

%% Appendix
%% ==============================================================================

\appendix   % Chapter numbering is reset with letters now

\subfile{../subfiles/annex_A}             %% Generalised vertical coordinate
\subfile{../subfiles/annex_B}             %% Diffusive operator
\subfile{../subfiles/annex_C}             %% Discrete invariants of the eqs.
\subfile{../subfiles/annex_iso}            %% Isoneutral diffusion using triads
\subfile{../subfiles/annex_D}             %% Coding rules

%% Not included
%\subfile{../subfiles/chap_model_basics_zstar}
%\subfile{../subfiles/chap_DIU}
%\subfile{../subfiles/chap_conservation}
%\subfile{../subfiles/annex_E}            %% Notes on some on going staff

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

%\backmatter   %% Chapter numbering off

%% Bibliography
\phantomsection
\addcontentsline{toc}{chapter}{Bibliography}
\bibliography{../main/NEMO_manual}

%% Index
\clearpage
\phantomsection
\addcontentsline{toc}{chapter}{Index}
\printindex

\end{document}