source: NEMO/trunk/README.rst @ 10448

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

Various improvments for quick start guide

  • implementation of Rtd theme (Read the Docs) with custom layout and style file
  • add reviewed BibTeX entries for NEMO references with DOI (manuals, guide, development strategy)
  • enhancement of bibliography management and configuration file for guide building
  • standardisation of headings markup
  • numerous edits
File size: 3.9 KB
Line 
1:Authors: NEMO System Team
2:Release: |release|
3:Date:    |today|
4
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.
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> 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- 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.
37
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``).
42
43A set of :doc:`utilities <tools>` is also provided to [pre|post]process your data (``./tools``).
44
45Literature
46==========
47
48:doc:`install`
49
50The reference documentation is archived online
51
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+---------------------------+----------------+
61
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
66
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:
69
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.
74
75Used by a wide audience, numerous :website:`associated projects <projects>` have been carried out and
76extensive :website:`bibliography <bibliography/publications>` published.
77
78Community development
79=====================
80
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.
85
86.. |NEMO strategy| replace:: multi-year development strategy
87
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.