source: NEMO/trunk/doc/latex/NEMO/main/foreword.tex @ 11433

Last change on this file since 11433 was 11433, checked in by nicolasmartin, 15 months ago

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 SI3 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 size: 1.6 KB
Line 
1%% ================================================================
2%% Abstract
3%% ================================================================
4
5%% Common part between NEMO-SI3-TOP
6\NEMO\ (``Nucleus for European Modelling of the Ocean'') is a framework of ocean-related engines.
7It is intended to be a flexible tool for studying the ocean dynamics and thermodynamics (``blue ocean''),
8as well as its interactions with the components of the Earth climate system over
9a wide range of space and time scales.
10Within \NEMO, the ocean engine is interfaced with a sea-ice model (\SIcube\ or
11\href{http://github.com/CICE-Consortium/CICE}{CICE}),
12passive tracers and biogeochemical models (\TOP) and,
13via the \href{http://portal.enes.org/oasis}{OASIS} coupler,
14with several atmospheric general circulation models.
15It also supports two-way grid embedding by means of the \href{http://agrif.imag.fr}{AGRIF} software.
16
17%% Specific part
18The primitive equation model is adapted to regional and global ocean circulation problems down to
19kilometric scale.
20Prognostic variables are the three-dimensional velocity field, a non-linear sea surface height,
21the \textit{Conservative} Temperature and the \textit{Absolute} Salinity.
22In the horizontal direction, the model uses a curvilinear orthogonal grid and
23in the vertical direction, a full or partial step $z$-coordinate, or $s$-coordinate, or
24a mixture of the two.
25The distribution of variables is a three-dimensional Arakawa C-type grid.
26Various physical choices are available to describe ocean physics,
27so as various HPC functionalities to improve performances.
Note: See TracBrowser for help on using the repository browser.