source: NEMO/branches/2018/dev_r10164_HPC09_ESIWACE_PREP_MERGE/doc/latex/NEMO/main/NEMO_manual.sty @ 10419

Last change on this file since 10419 was 10146, checked in by nicolasmartin, 2 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: 4.9 KB
Line 
1%% ==============================================================================
2%% NEMO_manual.sty: all customizations (packages, )
3%% ==============================================================================
4
5
6%% LaTeX packages
7%% ==============================================================================
8
9\usepackage{natbib}           %% bib
10\usepackage{caption}          %% caption
11\usepackage{xcolor}           %% color
12\usepackage{silence}          %% compilation
13\usepackage{times}            %% font
14\usepackage{hyperref}         %% hyper
15\usepackage{idxlayout}        %% index
16\usepackage{enumitem}         %% list
17\usepackage{minted}           %% listing
18\usepackage{amsmath}          %% maths
19\usepackage{fancyhdr}         %% page
20\usepackage{minitoc}          %% toc
21\usepackage{subfiles}         %% subdocs
22\usepackage[utf8]{inputenc}   %% input encoding
23
24%% Extensions in bundle package
25
26\usepackage{amssymb, graphicx, makeidx, tabularx, xspace}
27
28
29%% Configuration
30
31\captionsetup{margin=10pt, font={small}, labelsep=colon, labelfont={bf}}
32\graphicspath{{../../../figures/}}
33\hypersetup{
34   pdftitle={NEMO ocean engine}, pdfauthor={Gurvan Madec, and the NEMO team},
35   colorlinks
36}
37\idxlayout{font=footnotesize, columns=3}
38\renewcommand{\bibfont}{\footnotesize}
39\renewcommand{\bibsep}{3pt}
40
41
42%% Styles
43%% ==============================================================================
44
45\pagestyle{fancy}
46\bibliographystyle{../main/ametsoc}
47
48
49%% Additionnal fonts
50
51\DeclareMathAlphabet{\mathpzc}{OT1}{pzc}{m}{it}
52
53
54%% Page layout
55
56\fancyhf{}
57\fancyhead[LE,RO]{\bfseries\thepage}
58\fancyhead[LO]{\bfseries\hspace{-0em}\rightmark}
59\renewcommand{\sectionmark}[1]{\markright{\thesection.\ #1}}
60\fancyhead[RE]{\bfseries\leftmark}
61\renewcommand{\chaptermark}[1]{\markboth{#1}{}}
62\renewcommand{\headrulewidth}{0.5pt}
63\renewcommand{\footrulewidth}{0pt  }
64\addtolength{\headheight}{2.6pt}
65
66
67%% Catcodes
68
69\makeatletter
70\def\LigneVerticale{\vrule height 5cm depth 2cm\hspace{0.1cm}\relax}
71\def\LignesVerticales{\let\LV\LigneVerticale\LV\LV\LV\LV\LV\LV\LV\LV\LV\LV}
72\def\GrosCarreAvecUnChiffre#1{
73   \rlap{\vrule height 0.8cm width 1cm depth 0.2cm}
74   \rlap{\hbox to 1cm{\hss\mbox{\color{white} #1}\hss}}
75   \vrule height 0pt width 1cm depth 0pt
76}
77\def\@makechapterhead#1{
78   \hbox{
79      \huge\LignesVerticales\hspace{-0.5cm}
80      \GrosCarreAvecUnChiffre{\thechapter}\hspace{0.2cm}
81      \hbox{#1}
82   }
83   \par\vskip
841cm
85}
86\def\@makeschapterhead#1{
87   \hbox{
88      \huge\LignesVerticales
89      \hbox{#1}
90   }
91   \par\vskip
922cm
93}
94\def\cleardoublepage{\clearpage\if@twoside \ifodd\c@page\else
95  \hbox{}
96  \vspace*{\fill}
97  \vspace{\fill}
98  \thispagestyle{empty}
99  \newpage
100  \if@twocolumn\hbox{}\newpage\fi\fi\fi}
101\def\@seccntformat#1{\protect\makebox[0pt][r]{\csname the#1\endcsname\quad}}
102\makeatother
103
104
105%% Macros (to check)
106
107\def\deg{$^{\circ}$}
108\def\degC{$^{\circ}C$}
109\def\degK{$^{\circ}K$}
110\def\degN{$^{\circ}N$}
111\def\degS{$^{\circ}S$}
112
113\def\half{\textstyle\frac{1}{2}}
114\def\hhalf{\scriptstyle\frac{1}{2}}
115
116\def\quarter{\textstyle\frac{1}{4}}
117\def\qquarter{\scriptstyle\frac{1}{4}}
118\def\squarter{\sfrac{1}{4}}
119\def\stwelfth{\sfrac{1}{12}}
120\def\sthirtysixth{\sfrac{1}{36}}
121
122\def\bgamma\boldsymbol{\gamma}
123\def\rdt{\Delta t}
124
125
126%% New commands
127
128\newcommand{\gmcomment}[1]{}
129\newcommand{\sfcomment}[1]{}
130\newcommand{\sgacomment}[1]{}
131
132\newcommand{\nl}[1]{\texttt{\small{\textcolor{blue}{#1}}}}
133\newcommand{\NEMO}{\textit{NEMO}\xspace}
134
135\newcommand{\hf}[1]{\textit{#1.h90}\index{h90 file!#1}}
136\newcommand{\ifile}[1]{\textit{#1.nc}\index{Input NetCDF files!#1.nc}}
137\newcommand{\jp}[1]{\textit{#1}\index{Model parameters!#1}}
138\newcommand{\key}[1]{\textbf{key\_#1}\index{CPP keys!key\_#1}}
139\newcommand{\mdl}[1]{\textit{#1.F90}\index{Modules!#1}}
140\newcommand{\ngn}[1]{\textit{#1}\index{Namelist Group Name!#1}}
141\newcommand{\np}[1]{\textit{#1}\index{Namelist variables!#1}}
142\newcommand{\rou}[1]{\textit{#1}\index{Routines!#1}}
143
144\newcommand{\grad}{\nabla}
145\newcommand{\gradh}{\nabla_h}
146
147\newcommand{\ew}[3]{{e_{3#1}}_{\,#2}^{\,#3} }
148\newcommand{\vect}[1]{\ensuremath{\mathbf{#1}}}
149\newcommand{\Div}{\grad\cdot}
150\newcommand{\curl}{\nabla \times}
151\newcommand{\pd}[2][]{\frac{\partial #1}{\partial #2}}
152\newcommand{\alpbet} {\left(\alpha / \beta \right)}
153
154\newcommand{\triad}[6][]{\ensuremath{{}_{#2}^{#3}{\mathbb{#4}_{#1}}_{#5}^{\,#6}}}
155\newcommand{\triadd}[5]{\ensuremath{{}_{#1}^{#2}{\mathbb{#3}}_{#4}^{\,#5}}}
156\newcommand{\triadt}[5]{\ensuremath{{}_{#1}^{#2}{\tilde{\mathbb{#3}}}_{#4}^{\,#5}}}
157\newcommand{\rtriad}[2][]{\ensuremath{\triad[#1]{i}{k}{#2}{i_p}{k_p}}}
158\newcommand{\rtriadt}[1]{\ensuremath{\triadt{i}{k}{#1}{i_p}{k_p}}}
159
160\newcommand{\Alts}{{A}}
161\newcommand{\Alt}{{A^{lT}}}
162
163\newcommand{\rMLt}[1][i]{\tilde{r}_{\mathrm{ML}\,#1}}
164\newcommand{\rML}[1][i]{r_{\mathrm{ML}\,#1}}
165
166\newcommand{\mygstrut}[2]{\rule[#1 em]{0pt}{#2 em}}
167\newcommand{\mystrut}{\rule[-.9 em]{0pt}{1.79 em}}
168
169\newcommand{\doi}[1]{\href{http://dx.doi.org/#1}{full-text}}
170
171\newcommand{\nlst}[1]{\forfile{../../../namelists/#1}}
Note: See TracBrowser for help on using the repository browser.