source: NEMO/branches/2018/dev_r10164_HPC09_ESIWACE_PREP_MERGE/README.rst @ 10377

Last change on this file since 10377 was 10345, checked in by smasson, 2 years ago

dev_r10164_HPC09_ESIWACE_PREP_MERGE: merge with trunk@10344, see #2133

File size: 3.9 KB
RevLine 
[10345]1:Authors: NEMO System Team
2:Release: |release|
3:Date:    |today|
[9596]4
[10345]5`NEMO`_ for *Nucleus for European Modelling of the Ocean* is a state-of-the-art modelling framework for
6research activities and forecasting services in ocean and climate sciences.
[9596]7
[10345]8.. contents::
9   :local:
[9596]10
[10345]11Overview
12========
13
[9596]14The NEMO ocean model has 3 major components:
15
[10345]16- |OPA| models the ocean [thermo]dynamics and solves the primitive equations
17  (``./src/OCE``) :cite:`NEMO_manual`;
18- |SI3| simulates ice [thermo]dynamics, brine inclusions and subgrid-scale thickness variations
19  (``./src/ICE``) :cite:`SI3_manual`;
20- |TOP| models the [on|off]line oceanic tracers transport and the biogeochemical processes
21  (``./src/MBG``) :cite:`TOP_manual`.
[9596]22
[10345]23These physical core engines are described in their respective <reference publications> that must be cited for
24any work related to their use.
[9596]25
[10345]26Applications and capabilities
27=============================
[9596]28
[10345]29Not only does the NEMO framework model the ocean circulation,
30it offers various features to enable
[9596]31
[10345]32- Create :doc:`embedded zooms <zooms>` seamlessly with 2-way nesting package `AGRIF`_.
33- :doc:`Low cost biogeochemistry <coarsening>` and :doc:`alternative model opportunity <tracers>`.
34- Versatile :doc:`assimilation <assimilation>`.
35- :doc:`Output diagnostics <diagnostics>` with `XIOS`_ server.
36- :doc:`Coupling <coupling>` via `OASIS`_ for Earth system modelling.
[9596]37
[10345]38| Several :doc:`builtins configurations <configurations>` are provided to assess the skills and performances of
39   the model which can be used as templates for :doc:`setting up a new configuration <setup>` (``./cfgs``).
40| The end user could also find some :doc:`idealised test cases <test_cases>` online to serve as templates and
41   to study particular processes (``./tests``).
[9596]42
[10345]43A set of :doc:`utilities <tools>` is also provided to [pre|post]process your data (``./tools``).
[9596]44
[10345]45Literature
46==========
[9596]47
[10345]48:doc:`install`
[9596]49
[10345]50The reference documentation is archived online
[9596]51
[10345]52+-------+-------------------+----------------+
53|       | Reference manual  | |NEMO manual|_ |
54| |OPA| +-------------------+----------------+
55|       | Quick start guide | |NEMO guide|_  |
56+-------+-------------------+----------------+
57| |SI3|                     | |SI3 manual|_  |
58+---------------------------+----------------+
59| |TOP|                     | |TOP manual|_  |
60+---------------------------+----------------+
[9596]61
[10345]62.. |NEMO manual| image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1464816.svg
63.. |NEMO guide|  image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1475325.svg
64.. |SI3 manual|  image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1471689.svg
65.. |TOP manual|  image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1471700.svg
[9596]66
[10345]67| Reference manuals and quick start guide can be build from source and exported to HTML or PDF (``./doc``).
68| In any case, one can find them online:
[9596]69
[10345]70Since 2014 the project has a `Special Issue <http://www.geosci-model-dev.net/special_issue40.html>`_ in
71the open-access journal Geoscientific Model Development (GMD) from the European Geosciences Union (EGU).
72The main scope is to collect relevant manuscripts covering various topics and to provide a single portal to
73assess the model potential and evolution.
[9596]74
[10345]75Used by a wide audience, numerous :website:`associated projects <projects>` have been carried out and
76extensive :website:`bibliography <bibliography/publications>` published.
[9596]77
[10345]78Community development
79=====================
[9596]80
[10345]81| The NEMO Consortium pulling together 5 European institutes (`CMCC`_, `CNRS`_, `MOI`_, `Met Office`_ and `NERC`_)
82   plans the sustainable development in order to keep a reliable evolving framework since 2008.
83| It defines the |NEMO strategy|_ which is implemented by the System Team on
84   a yearly basis in order to release a new version almost every four years.
[9596]85
[10345]86.. |NEMO strategy| replace:: multi-year development strategy
[9596]87
[10345]88When the need arises, :forge:`working groups <wiki/WorkingGroups>` are created or resumed to
89gather the community expertise for advising on the development activities.
Note: See TracBrowser for help on using the repository browser.