source: NEMO/branches/2019/dev_r11233_AGRIF-05_jchanut_vert_coord_interp/README.rst @ 11574

Last change on this file since 11574 was 10991, checked in by nicolasmartin, 19 months ago

First part of content synchronisation between trunk & 4.0

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