Changeset 11433 for NEMO/trunk/doc/latex/NEMO/main/foreword.tex

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...

File:

• NEMO/trunk/doc/latex/NEMO/main/foreword.tex (modified) (1 diff)

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

@@ -1 @@
-% ================================================================
-% Foreword
-% ================================================================
-\chapter*{Foreword}
+%% ================================================================
+%% Abstract
+%% ================================================================
 
-The ocean engine of NEMO (Nucleus for European Modelling of the Ocean) is a primitive equation model adapted to
-regional and global ocean circulation problems.
-It is intended to be a flexible tool for studying the ocean and its interactions with the others components of
-the earth climate system over a wide range of space and time scales.
+%% Common part between NEMO-SI3-TOP
+\NEMO\ (``Nucleus for European Modelling of the Ocean'') is a framework of ocean-related engines.
+It is intended to be a flexible tool for studying the ocean dynamics and thermodynamics (``blue ocean''),
+as well as its interactions with the components of the Earth climate system over
+a wide range of space and time scales.
+Within \NEMO, the ocean engine is interfaced with a sea-ice model (\SIcube\ or
+\href{http://github.com/CICE-Consortium/CICE}{CICE}),
+passive tracers and biogeochemical models (\TOP) 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
+The primitive equation model is adapted to regional and global ocean circulation problems down to
+kilometric scale.
 Prognostic variables are the three-dimensional velocity field, a non-linear sea surface height,
 the \textit{Conservative} Temperature and the \textit{Absolute} Salinity.
-In the horizontal direction, the model uses a curvilinear orthogonal grid and in the vertical direction,
-a full or partial step $z$-coordinate, or $s$-coordinate, or a mixture of the two.
+In the horizontal direction, the model uses a curvilinear orthogonal grid and
+in the vertical direction, a full or partial step $z$-coordinate, or $s$-coordinate, or
+a mixture of the two.
 The distribution of variables is a three-dimensional Arakawa C-type grid.
-Various physical choices are available to describe ocean physics, including TKE, and GLS vertical physics.
-
-Within NEMO, the ocean is interfaced with a sea-ice model (SI$^3$)
- %or \href{https://github.com/CICE-Consortium/CICE}{CICE}),
-passive tracer and biogeochemical models (TOP-PISCES) and,
-via the \href{https://portal.enes.org/oasis}{OASIS} coupler, with several atmospheric general circulation models.
-It also support two-way grid embedding via the \href{http://agrif.imag.fr}{AGRIF} software.
+Various physical choices are available to describe ocean physics,
+so as various HPC functionalities to improve performances.