Changeset 11433 for NEMO/trunk/doc/latex/SI3

Timestamp:

2019-08-12T21:44:18+02:00 (5 years ago)

Author:

nicolasmartin

Message:

Pre-implementation of new cover page and new headings style for reference manuals

Cover page

The layout of the frontpage has been completely redesigned,
a coloured banner has been added to emphasize the title and easily identify each manual
between them.
The chosen color for each document (blue for NEMO, gray for SI³ and green for TOP) will be
used throughout the manual for the links and in the chapter headings.
The list of authors (writers/editors/reviewers) for the version of the manual is given next to
the abstract, which is now included in the frontpage.
A link to an existing ORCID profile for the author precedes its name.
Few settings have been added to each definitions.tex in order to adjust the rendering of the cover page (vertical spaces above and below the title, a subtitle, the width for authors list and
abstract section)

Headings

• header: chapter number and title for even pages, same infos for section otherwise
• footer: name of the manual and page numbering with the total number of pages (reverse order between odd/even pages)

For the chapter heading, a new style 'Bjornstrup' from fncychap package is now use.

Abstract

Split the section in two paragraphs for all manuals

1. Common description with almost the same sentences only customized by the general infos of the model
2. Specific part for the characteristics of the model

Troubleshooting

As announced, I have introduced some icons from academicons and fontawesome packages.
It required to switch from pdflatex to xelatex for the compilation and it prevents from now
the building of the whole document.
Also the PDF generated does not look nice due to the font

Work in progress...

Location:

NEMO/trunk/doc/latex/SI3

Files:

• main/definitions.tex (modified) (1 diff)
• main/foreword.tex (modified) (1 diff)
• main/thanks.tex (modified) (1 diff)
• subfiles/introduction.tex (modified) (3 diffs)

NEMO/trunk/doc/latex/SI3/main/definitions.tex

@@ -2 +2 @@
 \def \engine{SI3}
 
-%% Title (variable name already use by 'titling' pkg)
-\def \heading{Sea Ice modelling Integrated Initiative (SI$^3$) \\ The NEMO sea ice engine}
+%% Title and cover page settings
+\def \spacetop{  \vspace*{1.2cm} }
+\def \heading{Sea Ice modelling Integrated Initiative (SI$^3$)}
+\def \subheading{The NEMO sea ice engine}
+\def \spacedown{ \vspace*{1cm  } }
+\def \authorswidth{0.2\linewidth}
+\def \rulelenght{230pt}
+\def \abstractwidth{0.65\linewidth}
 
-%% Authors (thanks will apply to the second author)
-\def \firstauthor{}
-\def \secondauthor{NEMO Sea Ice Working Group}
+%% Color for document (frontpage banner, links and chapter boxes)
+\def \setcolor{ \definecolor{manualcolor}{cmyk}{0, 0, 0, 0.4} }
 
 %% IPSL publication number

NEMO/trunk/doc/latex/SI3/main/foreword.tex

@@ +1 @@
+%% ================================================================
+%% Abstract
+%% ================================================================
+
+%% Common part between NEMO-SI3-TOP
+``Sea Ice Modelling Integrated Initiative'' (\SIcube) is the sea ice engine of
+the \NEMO\ ocean model (``Nucleus for European Modelling of the Ocean'').
+It is intended to be a flexible tool for studying the sea ice dynamics and thermodynamics,
+brine inclusions and subgrid-scale thickness variations (``white ocean''),
+as well as its interactions with the other components of the Earth climate system over
+a wide range of space and time scales.
+\SIcube\ is interfaced with the \NEMO\ ocean engine, and,
+via the \href{http://portal.enes.org/oasis}{OASIS} coupler,
+with several atmospheric general circulation models.
+It also supports two-way grid embedding by means of the \href{http://agrif.imag.fr}{AGRIF} software.
+
+%% Specific part
+Designed for global to regional applications up to $~$10 km of effective resolution,
+\SIcube\ is a curvilinear grid, finite-difference implementation of the classical AIDJEX model
+(Arctic Ice Dynamics Joint EXperiment),
+combining the conservation of momentum for viscous-plastic continuum,
+energy and salt-conserving halo-thermodynamics,
+an explicit representation of subgrid-scale ice thickness variations, snow and melt ponds.
+An option to switch back to the \textit{single-category} (or \textit{2-level}) framework provides
+a cheap sea ice modelling solution.

NEMO/trunk/doc/latex/SI3/main/thanks.tex

@@ -1 @@
-TBD
+Yevgeny Aksenov       \\
+Ed Blockley           \\
+Matthieu Chevallier   \\
+Danny Feltham         \\
+Thierry Fichefet      \\
+Gilles Garric         \\
+Paul Holland          \\
+Dorotea Iovino        \\
+Gurvan Madec          \\
+Fran\c cois Massonnet \\
+Jeff Ridley           \\
+Cl\'ement Rousset     \\
+David Salas           \\
+David Schroeder       \\
+Steffen Tietsche      \\
+Martin Vancoppenolle

NEMO/trunk/doc/latex/SI3/subfiles/introduction.tex

@@ -8 +8 @@
 \textcolor{red}{[ \textit{July 2018} ]} \\
 
-%Near the poles of the Earth, the seas and oceans freeze when seawater at the freezing point loses heat. The resulting forms of saline ice are collectively called \textit{sea ice} \citep{WMO70}, reaching up to a few meters in thickness, where as sea ice coverage is about 5\% of the global ocean, about 30 million square kilometers. All sea ice characteristics vary over a wide range of spatio-temporal scales, reflecting changes in heat, mass and momentum exchanges with the atmosphere and the ocean; the clearest temporal signal being an ample seasonal cycle. Sea ice formation and melting affects water mass formation in the ocean \citep{goosse_1999}. It not only impacts, but also reflects the state of the climate system \citep{budyko_1969,notz_2016}.  Sea ice also affects marine life, water chemistry and human activities in polar regions. Local populations use sea ice for travelling and hunting, whereas navigation and resource exploitation are dependent on sea ice conditions. For such reasons, ocean modelling systems, including NEMO, must include a sea ice component.
+%Near the poles of the Earth, the seas and oceans freeze when seawater at the freezing point loses heat. The resulting forms of saline ice are collectively called \textit{sea ice} \citep{WMO70}, reaching up to a few meters in thickness, where as sea ice coverage is about 5\% of the global ocean, about 30 million square kilometers. All sea ice characteristics vary over a wide range of spatio-temporal scales, reflecting changes in heat, mass and momentum exchanges with the atmosphere and the ocean; the clearest temporal signal being an ample seasonal cycle. Sea ice formation and melting affects water mass formation in the ocean \citep{goosse_1999}. It not only impacts, but also reflects the state of the climate system \citep{budyko_1969,notz_2016}.  Sea ice also affects marine life, water chemistry and human activities in polar regions. Local populations use sea ice for travelling and hunting, whereas navigation and resource exploitation are dependent on sea ice conditions. For such reasons, ocean modelling systems, including \NEMO, must include a sea ice component.
 
-The sea Ice Modelling Integrated Initiative (SI$^3$) is the sea ice engine of the Nucleus for European Modelling of the Ocean (NEMO). It is intended to be a flexible tool for studying sea ice and its interactions with the other components of the Earth System over a wide range of space and time scales. SI$^3$ is a curvilinear grid, finite-difference implementation of the classical AIDJEX\footnote{AIDJEX=\textbf{A}rctic \textbf{I}ce \textbf{D}ynamics \textbf{J}oint \textbf{EX}periment} model \citep{coon_1974}, combining the conservation of momentum for viscous-plastic continuum, energy and salt-conserving halo-thermodynamics, an explicit representation of subgrid-scale ice thickness variations, snow and melt ponds. An option to switch back to the \textit{single-category} (or \textit{2-level}) framework of \cite{hibler_1979} provides a cheap sea ice modelling solution.
-
-SI$^3$ is the result of the recommendation of the Sea Ice Working Group (SIWG) to reduce duplication and better use development resources. SI$^3$ merges the capabilities of the 3 formerly used NEMO sea ice models (CICE, GELATO and LIM). The \textbf{3} in SI$^3$ refers to the three formerly used sea ice models. It also refers to linkages between 3 different media (ocean, ice, snow). The model can be spelt 'SI3' in situations where the superscript could be problematic (i.e., within code and svn repository etc.) The model name would be pronounced as 'si-cube' for short (or 'sea ice cubed' for slightly longer). 
+\SIcube\ is the result of the recommendation of the Sea Ice Working Group (SIWG) to
+reduce duplication and better use development resources.
+\SIcube\ merges the capabilities of the 3 formerly sea ice models used in \NEMO\ (CICE, GELATO and LIM).
+The \textbf{3} in \SIcube\ refers either to the three formerly used sea ice models and
+linkages between 3 different media (ocean-ice-snow).
+The model would be pronounced as ``SI cube'' for short (or ``Sea Ice cubed'' for slightly longer),
+otherwise it can be spelt ``SI three'' in situations where the superscript could be problematic.
 
 % Limitations & scope
-%There are limitations to the applicability of models such as SI$^3$. The continuum approach is not invalid for grid cell size above at least 1 km, below which sea ice particles may include just a few floes, which is not sufficient \citep{lepparanta_2011}. Second, one must remember that our current knowledge of sea ice is not as complete as for the ocean: there are no fundamental equations such as Navier Stokes equations for sea ice. Besides, important features and processes span widely different scales, such as brine inclusions (1 $\mu$m-1 mm) \citep{perovich_1996}, horizontal thickness variations (1 m-100 km) \citep{percival_2008}, deformation and fracturing (10 m-1000 km) \citep{marsan_2004}. These impose complicated and often subjective subgrid-scale treatments. All in all, there is more empirism in sea ice models than in ocean models. 
+%There are limitations to the applicability of models such as \SIcube. The continuum approach is not invalid for grid cell size above at least 1 km, below which sea ice particles may include just a few floes, which is not sufficient \citep{lepparanta_2011}. Second, one must remember that our current knowledge of sea ice is not as complete as for the ocean: there are no fundamental equations such as Navier Stokes equations for sea ice. Besides, important features and processes span widely different scales, such as brine inclusions (1 $\mu$m-1 mm) \citep{perovich_1996}, horizontal thickness variations (1 m-100 km) \citep{percival_2008}, deformation and fracturing (10 m-1000 km) \citep{marsan_2004}. These impose complicated and often subjective subgrid-scale treatments. All in all, there is more empiricism in sea ice models than in ocean models.
 
 In order to handle all the subsequent required subjective choices, we applied the following guidelines or principles:
 \begin{itemize}
-\item Sea ice is frozen seawater that is in tight interaction with the underlying ocean. This close connexion suggests that the sea ice and ocean model components must be as consistent as possible. In practice, this is materialized by the close match between LIM and NEMO, in terms of numerical choices, regarding the grid (Arakawa C-type) and the numerical discretization (finite differences with NEMO scale factors).
+\item Sea ice is frozen seawater that is in tight interaction with the underlying ocean. This close connexion suggests that the sea ice and ocean model components must be as consistent as possible. In practice, this is materialized by the close match between LIM and \NEMO, in terms of numerical choices, regarding the grid (Arakawa C-type) and the numerical discretization (finite differences with \NEMO\ scale factors).
 \item It is useful to be able to either prescribe the atmospheric state or to use an atmospheric model. For consistency and simplicity of the code, we choose to use formulations as close as possible in both cases.
-\item Different resolutions and time steps can be used. There are parameters that depend on such choices. We thrieved to achieve a resolution and time-step independent code, by imposing a priori scaling on the resolution / time step dependence of such parameters.
+\item Different resolutions and time steps can be used. There are parameters that depend on such choices. We thrived to achieve a resolution and time-step independent code, by imposing a priori scaling on the resolution / time step dependence of such parameters.
 \item Energy, mass and salt must be conserved as much as possible.
 \end{itemize}
@@ -31 +35 @@
 There are no more CPP keys in the code. \\
 
-Namelists and output management follow NEMO guidelines. \\
+Namelists and output management follow \NEMO\ guidelines. \\
 
 Changes between releases. \\
@@ -55 +59 @@
 \item David Schroeder (CPOM, Reading, UK)
 \item Steffen Tietsche (ECMWF, Reading, UK)
-\item Martin Vancoppenolle (LOCEAN, CNRS, Paris, France, co-chair) 
+\item Martin Vancoppenolle (LOCEAN, CNRS, Paris, France, co-chair)
 \end{footnotesize}
 \end{itemize}