source: NEMO/releases/release-4.0/README.rst @ 10823

Last change on this file since 10823 was 10606, checked in by nicolasmartin, 22 months ago

Creation of NEMO 4.0 release

File size: 4.0 KB
Line 
1:Release: |version|
2:Date:    |today|
3
4NEMO_ for **Nucleus for European Modelling of the Ocean** is a state-of-the-art modelling framework for
5research 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``)
18- |SI3| simulates seaice {thermo}dynamics, brine inclusions and subgrid-scale thickness variations
19  (``./src/ICE``)
20- |TOP| models the {on,off}line oceanic tracers transport and biogeochemical processes
21  (``./src/TOP``)
22
23These physical core engines are described in their respective `references`_ that
24must be cited for any work related to their use.
25
26Assets and 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:`external biogeochemistry model<tracers>`
34- Versatile :doc:`data assimilation<data_assimilation>`
35- Generation of :doc:`diagnostics<diagnostics>` through effective XIOS_ system
36- Roll-out Earth system modeling with :doc:`coupling interface<coupling>` based on OASIS_
37
38Several :doc:`built-in configurations<configurations>` are provided to
39evaluate the skills and performances of the model which
40can be used as templates for setting up a new configurations (``./cfgs``).
41
42The user can also checkout available :doc:`idealized test cases<test_cases>` that
43address specific physical processes(``./tests``).
44
45A set of :doc:`utilities <tools>` is also provided to {pre,post}process your data (``./tools``).
46
47Project documentation
48=====================
49
50A walkthrough tutorial illustrates how to get code dependencies, compile and execute NEMO
51(``./INSTALL.rst``) .
52
53Reference manuals and quick start guide can be build from source and
54exported to HTML or PDF formats (``./doc``) or
55downloaded directly from the :website:`website<bibliography/documentation>`.
56
57=========== ===================== ===============
58 Component   Reference Manual      Quick start
59=========== ===================== ===============
60 |OPA|       |NEMO manual|_        |NEMO guide|
61             :cite:`NEMO_manual`
62 |SI3|       |SI3 manual|
63             :cite:`SI3_manual`
64 |TOP|       |TOP manual|
65             :cite:`TOP_manual`
66=========== ===================== ===============
67
68Since 2014 the project has a `Special Issue`_ in the open-access journal
69Geoscientific Model Development (GMD) from the European Geosciences Union (EGU).
70The main scope is to collect relevant manuscripts covering various topics and
71to provide a single portal to assess the model potential and evolution.
72
73Used by a wide audience,
74numerous :website:`associated projects<projects>` have been carried out and
75extensive :website:`bibliography<bibliography/publications>` published.
76
77Development board
78=================
79
80The NEMO Consortium pulling together 5 European institutes (CMCC_, CNRS_, MOI_, `Met Office`_ and NERC_)
81plans the sustainable development in order to keep a reliable evolving framework since 2008.
82
83It defines the |NEMO strategy|_ that is implemented by the System Team on a yearly basis in order to
84release a new version almost every four years.
85
86When the need arises, :forge:`working groups<wiki/WorkingGroups>` are created or resumed to
87gather the community expertise for advising on the development activities.
88
89
90.. Substitutions / Links
91
92.. |NEMO manual| image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1464816.svg
93.. |NEMO guide|  image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1475325.svg
94.. |SI3 manual|  image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1471689.svg
95.. |TOP manual|  image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1471700.svg
96
97.. |NEMO strategy| replace:: multi-year development strategy
98
99.. _Special Issue: https://www.geosci-model-dev.net/special_issue40.html
Note: See TracBrowser for help on using the repository browser.