source: NEMO/trunk/README.rst @ 10187

Last change on this file since 10187 was 10187, checked in by nicolasmartin, 2 years ago

Push draft versions of RST root files

File size: 4.8 KB
Line 
1.. role:: rstblue
2.. role:: rstgreen
3.. role:: rstgrey
4.. role:: rstgreysup(sup)
5
6NEMO for *Nucleus for European Modelling of the Ocean* is a state-of-the-art modelling framework of
7ocean related engines for oceanographic research, operational oceanography, seasonal forecast and
8[paleo]climate studies.
9
10Overview
11========
12
13Distributed under CeCILL license (GNU GPL compatible - see ``./LICENSE``),
14the NEMO ocean model has 3 major components:
15
16- :rstblue:`OPA` is fundamental to all users by modelling the ocean [thermo]dynamics and
17  solving the primitive equations         (``./src/OCE``);
18- :rstgrey:`SI`\ :rstgreysup:`3` for sea-ice simulates ice [thermo]dynamics, brine inclusions and
19  subgrid-scale thickness variations      (``./src/ICE``);
20- :rstgreen:`TOP-PISCES` models biogeochemistry with TOP for the on/offline oceanic tracers transport and
21  PISCES for the biogeochemical processes (``./src/MBG``).
22
23These physical engines are described in their respective reference publications that must be cited for
24any work related to their use.
25
26Applications and capabilities
27=============================
28
29Not only does the NEMO framework model the ocean circulation,
30it offers various features to enable
31
32- 2-way nesting package `AGRIF`_ to create embedded zooms seamlessly
33- Flexible biogeomchemistry with online coarsening and possible integration of a customized model
34- Versatile data assimilation interface with 3 different modules
35  (tangent linear, observational operators and increments)
36
37lation a efficient XIOS_ server for outputing diagnostics a coupled via OASIS_ to alternative components or other models to enable Earth system modelling.
38
39| Several builtins configurations are provided to assess the skills and performances of the model which
40   can be used as templates for setting up a new configuration (``./cfgs``).
41| The end user could also find some idealised test cases on the web to serve as examples and
42   to study particular processes (``./tests``).
43
44A set of tools is also provided to setup your own configuration and [pre|post]process your data (``./tools``).
45
46Literature
47==========
48
49| The NEMO reference manual and a quick start guide can be generated from Latex and RST source code files
50   (``./doc``), either in PDF or in HTML format, but it might require some additional installations.
51| In any case, both formats are available online: `HTML`_ | `PDF`_
52
53| Since 2014 the project has a `Special Issue`_ in the Geoscientific Model Development (GMD) open-access journal
54   from the European Geosciences Union (EGU).
55   The main scope is to collect relevant manuscripts which cover a wide variety of topics like
56   process studies, new parameterizations, implementation of new model features and new NEMO configurations.
57| Also it provides a single portal to search, discover and understand about
58   the NEMO modelling framework potential and evolution and to submit their contributions.
59
60Community development
61=====================
62
63| The NEMO Consortium gathering 6 European institutes organises the sustainable development in order to
64   keep a reliable evolving system since 2008.
65| It defines the multi-year development strategy which is implemented by the NEMO System Team.
66
67`Working groups`_ are regularly created or resumed to gather the expertise in the NEMO community in order to
68focus the development work on a specific subject or major component of NEMO.
69
70Definitions
71===========
72
73AGRIF
74   *Adaptive Grid Refinement In Fortran*,
75   package for the integration of full adaptive mesh refinement features within
76   an existing multidimensional finite difference model
77
78SI\ :sup:`3`\
79   *Sea Ice Integrated Initiative*,
80   unified sea ice model merging functionalities from CICE, GELATO and LIM into the NEMO framework
81
82OASIS
83   *Ocean Atmosphere Sea Ice Soil*,
84   coupling software to synchronise numerical codes representing different components of the climate system
85
86PISCES
87   *Pelagic Interactions Scheme for Carbon and Ecosystem Studies*,
88   biogeochemical model simulating marine ecosystems, cycles of carbon and the main nutrients
89
90TAM
91   *Tangent linear and Adjoint Model*,
92   tools to analyse and control the NEMO dynamical core for a wide range of applications such as
93   sensitivity analysis, parameter estimation, vectors computation or data assimilation.
94
95TOP
96   *Tracers in Ocean Paradigm*,
97   on/off-line oceanic tracers transport and biogeochemistry models
98
99XIOS
100   *XML Input Output Server*,
101   library dedicated to input/output management of climate code
102
103.. _AGRIF:          http://agrif.imag.fr
104.. _HTML:           http://www.nemo-ocean.eu/doc
105.. _NEMO:           http://www.nemo-ocean.eu
106.. _OASIS:          http://verc.enes.org/oasis
107.. _PDF:            http://www.nemo-ocean.eu/wp-content/uploads/NEMO_book.pdf
108.. _Special Issue:  http://www.geosci-model-dev.net/special_issue40.html
109.. _Working groups: http://forge.ipsl.jussieu.fr/nemo/wiki/WorkingGroups
110.. _XIOS:           http://forge.ipsl.jussieu.fr/ioserver
Note: See TracBrowser for help on using the repository browser.