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.
TOP_manual.tex in NEMO/trunk/doc/latex/TOP/main – NEMO

source: NEMO/trunk/doc/latex/TOP/main/TOP_manual.tex @ 11167

Last change on this file since 11167 was 11154, checked in by nicolasmartin, 5 years ago

Bugfixes and changes remaining in the directory

File size: 2.8 KB
Line 
1%% ==============================================================================
2%% TOP Reference Manual
3%% ==============================================================================
4
5
6%% Preamble
7%% ==============================================================================
8
9%% Document layout
10\documentclass[draft]{scrreport}
11
12%% Custom style (.sty)
13\usepackage{../../global/packages}
14\hypersetup{
15  pdftitle={Tracers in Ocean Paradigm (TOP) -- The NEMO passive tracers engine},
16  pdfauthor={NEMO TOP Working Group},
17  colorlinks
18}
19
20%% Include references and index for single subfile compilation
21\newcommand{\biblio}{\bibliography{../main/TOP_manual}}
22\newcommand{\pindex}{\printindex}
23
24\makeindex
25
26%% End of common preamble between main and sub-files
27\begin{document}
28\pagenumbering{gobble}
29
30%% Override custom cmds for full manual compilation
31\renewcommand{\biblio}{}
32\renewcommand{\pindex}{}
33
34
35%% Frontmatter
36%% ==============================================================================
37
38\title{Tracer in Ocean Paradigm (TOP) \\ The NEMO passive tracer engine
39%  \small{\textcolor{red}{First draft documentation. Needs completion and rewriting.}}
40}
41\author{NEMO TOP Working Group\thanks{
42    \'{E}th\'{e} Christian, Lovato Tomas, Aumont Olivier, Palmi\'{e}ri Julien,
43    Mouchet Anne, Nurser Georges, Yool Andrew
44  }
45}
46\date{\today}
47
48%% Title and information pages
49\input{../../global/frontpages}
50
51%% Citation embedded
52\textsf{
53``{\bfseries Tracer in Ocean Paradigm (TOP) -- The NEMO passive tracer engine}'',
54NEMO TOP Working Group,
55{\em Scientific Notes of Climate Modelling Center (28)} -- ISSN 1288-1619,
56Institut Pierre-Simon Laplace (IPSL),
57\href{http://doi.org/10.5281/zenodo.1471700}{doi:10.5281/zenodo.1471700}
58}
59
60\newpage
61%\frontmatter   %% Chapter numbering off and Roman numerals for page numbers
62\pagenumbering{roman}
63
64%\subfile{../subfiles/foreword}            %% Foreword
65
66
67%% ToC i.e. Table of Contents
68\newpage
69\dominitoc
70\tableofcontents
71
72\clearpage
73
74%% Mainmatter
75%% ==============================================================================
76
77%\mainmatter   %% Chapter numbering on, page numbering is reset with Arabic numerals
78\pagenumbering{arabic}
79
80\graphicspath{{../../figures/TOP/}}
81
82\subfile{../subfiles/introduction}
83\subfile{../subfiles/model_description}
84\subfile{../subfiles/model_setup}
85\subfile{../subfiles/miscellaneous}
86
87%% Appendix
88%% ==============================================================================
89
90%\appendix   % Chapter numbering is reset with letters now
91
92
93%% Backmatter
94%% ==============================================================================
95
96%\backmatter   %% Chapter numbering off
97
98%% Bibliography
99\phantomsection
100\addcontentsline{toc}{chapter}{Bibliography}
101\bibliography{../main/TOP_manual}
102
103%% Index
104\clearpage
105\phantomsection
106\addcontentsline{toc}{chapter}{Index}
107\printindex
108
109\end{document}
Note: See TracBrowser for help on using the repository browser.