source: NEMO/trunk/doc/latex/SI3/main/SI3_manual.tex @ 11015

Last change on this file since 11015 was 11015, checked in by nicolasmartin, 17 months ago

Modification of the content to be in line with the NEMO manual
SI3 manual can now be build like the NEMO manual with ./manual_build.sh SI3

  • Mimick the directory organisation with main and subfiles folders.
  • Regarding the particular case of namelists
    • Remove the duplicates already contained in the global namelists folder at 1st level of ./doc
    • Keep the namelists sub-folder only for namdyn_adv & namsbc which already exist in ocean namelists
  • Rewriting of SI3_manual.tex with NEMO_manual.tex as template to easily highlight differences
  • Updating of several paths for figures/namelists inclusion or LaTeX files referencing
  • LaTeX source:
    • Replacement of \forfile command for namelists with pre-configured \nlst alias
    • " "" \bm with \mathbf (save installation of an extra package)
File size: 3.0 KB
Line 
1%% ==============================================================================
2%% SI3 Reference Manual
3%% ==============================================================================
4
5
6%% Preamble
7%% ==============================================================================
8
9%% Document layout
10\documentclass{book}
11
12%% Custom style (.sty)
13\usepackage{../../NEMO/main/NEMO_manual}
14
15%% Include references and index for single subfile compilation
16\newcommand{\biblio}{\bibliography{../main/SI3_manual}}
17\newcommand{\pindex}{\printindex}
18
19\makeindex
20
21%% End of common preamble between main and sub-files
22\begin{document}
23
24%% Override custom cmds for full manual compilation
25\renewcommand{\biblio}{}
26\renewcommand{\pindex}{}
27
28
29%% Frontmatter
30%% ==============================================================================
31
32\graphicspath{{../../figures/logos/}}
33
34%% Frontpage
35\title{
36  \includegraphics[height=0.05\textheight]{CMCC}\hfill
37  \includegraphics[height=0.05\textheight]{CNRS}\hfill
38  \includegraphics[height=0.05\textheight]{MOI} \hfill
39  \includegraphics[height=0.05\textheight]{UKMO}\hfill
40  \includegraphics[height=0.05\textheight]{NERC}       \\
41  {\Huge SI$^3$ \\}
42  {\Large Sea Ice modelling Integrated Initiative -- The NEMO Sea Ice engine}\\ 
43  {\small \textcolor{red}{First draft documentation. Needs completion and rewriting}.}
44}
45\author{The NEMO Sea Ice Working Group
46%  \thanks{
47%
48%  }                                                        \\
49%                                                           \\
50  \textit{Issue 27, Notes du P\^{o}le de mod\'{e}lisation} \\
51  \textit{Institut Pierre-Simon Laplace (IPSL)}            \\
52  \textit{ISSN 1288-1619}
53}
54\date{\today}
55
56\maketitle
57\frontmatter
58
59
60%% ToC i.e. Table of Contents
61\dominitoc
62\tableofcontents
63
64
65%% Mainmatter
66%% ==============================================================================
67
68\mainmatter
69
70\graphicspath{{../../figures/SI3/}}
71
72\subfile{../subfiles/todolist}
73
74%% Abstract - Foreword
75
76\subfile{../subfiles/abstract_foreword}
77
78% Introduction
79
80\subfile{../subfiles/introduction}
81
82% Chapters
83
84\subfile{../subfiles/chap_model_basics}
85
86\subfile{../subfiles/chap_domain}
87
88\subfile{../subfiles/chap_dynamics}
89
90\subfile{../subfiles/chap_transport}
91
92\subfile{../subfiles/chap_ridging_rafting}
93
94\subfile{../subfiles/chap_radiative_transfer}
95
96\subfile{../subfiles/chap_thermo}
97
98\subfile{../subfiles/chap_interfaces}
99
100\subfile{../subfiles/chap_output_diagnostics}
101
102\subfile{../subfiles/chap_single_category_use}
103
104\subfile{../subfiles/chap_bdy_agrif}
105
106\subfile{../subfiles/chap_miscellaneous}
107
108%% Appendix
109
110%\appendix
111%% Backmatter
112%% ==============================================================================
113
114\backmatter
115
116%% Bibliography
117
118\cleardoublepage
119\phantomsection
120\addcontentsline{toc}{chapter}{Bibliography}
121
122\bibliography{../main/SI3_manual}
123%\bibliography{/Users/ioulianikolskaia/Boulot/LIBRARY/BIBTEX/Martin_biblio.bib}
124
125%% Index
126
127\cleardoublepage
128\phantomsection
129\addcontentsline{toc}{chapter}{Index}
130\printindex
131
132\end{document}
Note: See TracBrowser for help on using the repository browser.