source: NEMO/trunk/README.rst @ 10592

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

Cosmetic changes

File size: 4.3 KB
Line 
1NEMO_ for **Nucleus for European Modelling of the Ocean** is a state-of-the-art modelling framework for research activities and forecasting services in ocean and climate sciences,
2developed in a sustainable way by a European consortium since 2008.
3
4Overview
5========
6
7The NEMO_ ocean model has 3 major components:
8
9- **OCE** models the ocean [thermo]dynamics and solves the primitive equations (``./src/OCE``)
10- **SI3** simulates seaice [thermo]dynamics, brine inclusions and subgrid-scale thickness variations (``./src/ICE``)
11- **TOP** models the [on|off]line oceanic tracers transport and biogeochemical processes (``./src/TOP``)
12
13These physical core engines are described in their respective `reference documentation`_ that must be cited for any work related to their use.
14
15Assets and ready-to-use solutions
16=================================
17
18Not only does the NEMO_ framework model the ocean circulation, it offers various features to enable
19
20- Create embedded zoom seamlessly thanks to 2-way nesting package AGRIF_.
21- Opportunity to integrate an `external biogeochemistry model`_ 
22- Versatile data_assimilation (``./src/OBS``)
23- Generation of diagnostics through effective XIOS_ system
24- Roll-out Earth system modeling with coupling interface based on OASIS_
25
26Several built-in configurations are provided to evaluate the skills and performances of the model which can be used as templates for setting up a new configurations (``./cfgs``).
27
28NEMO user can also checkout available idealized test cases that address specific physical processes(``./tests``).
29
30A set of utilities is also provided to {pre,post}process your data (``./tools``).
31
32Documentation and references
33============================
34
35A walkthrough tutorial illustrates how to get code dependencies, compile and execute NEMO (``./INSTALL.rst``) .
36
37Reference manuals and quick start guide can be build from source and exported to HTML or PDF formats (``./doc``) or downloaded directly from the NEMO_ website.
38
39=========== =================== ===================
40 Component    Reference Manual   Quick start
41=========== =================== ===================
42 OCE          `NEMO manual`_     `NEMO guide`_
43 SI3          `SI3 manual`_
44 TOP          `TOP manual`_     
45=========== =================== ===================
46
47Since 2014 the project has a `Special Issue`_ in the open-access journal Geoscientific Model Development (GMD) from the European Geosciences Union (EGU).
48The main scope is to collect relevant manuscripts covering various topics and to provide a single portal to assess the model potential and evolution.
49
50Used by a wide audience, numerous `associated projects`_ have been carried out and extensive `bibliography`_ published.
51
52NEMO Consortium
53===============
54
55The NEMO Consortium pulling together 5 European institutes (CMCC_, CNRS_, MOI_, `Met Office`_ and NERC_) plans the sustainable development in order to keep a reliable evolving framework since 2008.
56
57It defines the NEMO strategy that is implemented by the System Team on a yearly basis in order to release a new version almost every four years.
58
59When the need arises, `working groups`_ are created or resumed to gather the community expertise for advising on the development activities.
60
61..  _external biogeochemistry model : http://forge.ipsl.jussieu.fr/nemo/wiki/WorkingGroups/TOP/TOP-UserQuickGuide
62.. _NEMO : https://www.nemo-ocean.eu/
63.. _OASIS : https://portal.enes.org/oasis
64.. _XIOS : http://forge.ipsl.jussieu.fr/ioserver
65.. _AGRIF : https://www-ljk.imag.fr/MOISE/AGRIF/
66.. _working groups : https://forge.ipsl.jussieu.fr/nemo/wiki/WorkingGroups
67.. _reference documentation : https://www.nemo-ocean.eu/bibliography/documentation/
68.. _Special Issue : http://www.geosci-model-dev.net/special_issue40.html
69.. _associated projects : https://www.nemo-ocean.eu/projects/
70.. _bibliography : https://www.nemo-ocean.eu/wp-content/plugins/wp-bibtexbrowser/bibtexbrowser.php?bib=nemo.bib
71.. _CMCC : https://www.cmcc.it/
72.. _CNRS : http://www.cnrs.fr/
73.. _MOI : https://www.mercator-ocean.fr
74.. _Met Office : https://www.metoffice.gov.uk/
75.. _NERC : https://nerc.ukri.org/
76.. _`NEMO manual` : http://zenodo.org/badge/DOI/10.5281/zenodo.1464816.svg
77.. _`NEMO guide` : http://zenodo.org/badge/DOI/10.5281/zenodo.1475325.svg
78.. _`SI3 manual` : http://zenodo.org/badge/DOI/10.5281/zenodo.1471689.svg
79.. _`TOP manual` : http://zenodo.org/badge/DOI/10.5281/zenodo.1471700.svg
80
Note: See TracBrowser for help on using the repository browser.