source: NEMO/branches/2019/dev_r10503_XIOS_RW_doc/README.rst @ 10508

Last change on this file since 10508 was 10460, checked in by nicolasmartin, 21 months ago

Small modifications regarding README(s) and ReST files

File size: 4.1 KB
Line 
1:Release: |release|
2:Date:    |today|
3
4`NEMO`_ for *Nucleus for European Modelling of the Ocean* is a state-of-the-art modelling framework,
5for research activities and forecasting services in ocean and climate sciences,
6developed in a sustainable way by a European consortium since 2008.
7
8.. contents::
9   :local:
10
11Overview
12========
13
14The NEMO ocean model has 3 major components:
15
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`.
22
23These physical core engines are described in their respective `reference publications`_,
24that must be cited for any work related to their use.
25
26Assets and ready-to-use solutions
27=================================
28
29Not only does the NEMO framework model the ocean circulation,
30it offers various features to enable
31
32- Create :doc:`embedded zooms <zooms>` seamlessly thanks to 2-way nesting package `AGRIF`_.
33- Opportunity to integrate an :doc:`alternative biogeochemistry model <tracers>`
34- Versatile :doc:`data_assimilation <data assimilation>`.
35- Generation of :doc:`diagnostics <diagnostics>` through effective `XIOS`_ server.
36- Roll-out Earth system modelling with :doc:`coupling interface <coupling>` to `OASIS`_.
37
38| Several :doc:`built-in configurations <configurations>` are provided to evaluate 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 online some :doc:`idealised test cases <test_cases>` to serve as templates and
41   to study particular processes (``./tests``).
42
43A set of :doc:`utilities <tools>` is also provided to [pre|post]process your data (``./tools``).
44
45Project literature
46==================
47
48A tutorial
49:doc:`install`
50
51The reference documentation is archived online
52
53+-------+-------------------+----------------+
54|       | Reference manual  | |NEMO manual|_ |
55| |OPA| +-------------------+----------------+
56|       | Quick start guide | |NEMO guide|_  |
57+-------+-------------------+----------------+
58| |SI3|                     | |SI3 manual|_  |
59+---------------------------+----------------+
60| |TOP|                     | |TOP manual|_  |
61+---------------------------+----------------+
62
63.. |NEMO manual| image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1464816.svg
64.. |NEMO guide|  image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1475325.svg
65.. |SI3 manual|  image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1471689.svg
66.. |TOP manual|  image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1471700.svg
67
68| Reference manuals and quick start guide can be build from source and exported to HTML or PDF (``./doc``).
69| In any case, one can find them online:
70
71Since 2014 the project has a `Special Issue <http://www.geosci-model-dev.net/special_issue40.html>`_ in
72the open-access journal Geoscientific Model Development (GMD) from the European Geosciences Union (EGU).
73The main scope is to collect relevant manuscripts covering various topics and to provide a single portal to
74assess the model potential and evolution.
75
76Used by a wide audience, numerous :website:`associated projects <projects>` have been carried out and
77extensive :website:`bibliography <bibliography/publications>` published.
78
79Collaborative development
80=========================
81
82| The NEMO Consortium pulling together 5 European institutes (`CMCC`_, `CNRS`_, `MOI`_, `Met Office`_ and `NERC`_)
83   plans the sustainable development in order to keep a reliable evolving framework since 2008.
84| It defines the |NEMO strategy|_ which is implemented by the System Team on
85   a yearly basis in order to release a new version almost every four years.
86
87.. |NEMO strategy| replace:: multi-year development strategy
88
89When the need arises, :forge:`working groups <wiki/WorkingGroups>` are created or resumed to
90gather the community expertise for advising on the development activities.
91
92:doc:`<contributing>`
Note: See TracBrowser for help on using the repository browser.