New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
README.rst in NEMO/trunk – NEMO

source: NEMO/trunk/README.rst @ 10596

Last change on this file since 10596 was 10596, checked in by nicolasmartin, 5 years ago

Fixes for a unsuccessful Python Sphinx building, no more warnings but still crashing

File size: 3.7 KB
RevLine 
[10551]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,
[10460]2developed in a sustainable way by a European consortium since 2008.
[10279]3
[10187]4Overview
5========
[9596]6
[10551]7The NEMO_ ocean model has 3 major components:
[10187]8
[10551]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``)
[9596]12
[10551]13These physical core engines are described in their respective `reference documentation`_ that must be cited for any work related to their use.
[9596]14
[10460]15Assets and ready-to-use solutions
16=================================
[9596]17
[10551]18Not only does the NEMO_ framework model the ocean circulation, it offers various features to enable
[9596]19
[10551]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_
[9596]25
[10551]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``).
[9596]27
[10551]28NEMO user can also checkout available idealized test cases that address specific physical processes(``./tests``).
[9596]29
[10592]30A set of utilities is also provided to {pre,post}process your data (``./tools``).
[9596]31
[10551]32Documentation and references
33============================
[9596]34
[10551]35A walkthrough tutorial illustrates how to get code dependencies, compile and execute NEMO (``./INSTALL.rst``) .
[9596]36
[10551]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.
[10279]38
[10551]39=========== =================== ===================
40 Component    Reference Manual   Quick start
41=========== =================== ===================
42 OCE          `NEMO manual`_     `NEMO guide`_
43 SI3          `SI3 manual`_
44 TOP          `TOP manual`_     
45=========== =================== ===================
[10279]46
[10551]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.
[10279]49
[10551]50Used by a wide audience, numerous `associated projects`_ have been carried out and extensive `bibliography`_ published.
[10279]51
[10551]52NEMO Consortium
53===============
[10279]54
[10592]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.
[9596]56
[10551]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.
[9596]58
[10551]59When the need arises, `working groups`_ are created or resumed to gather the community expertise for advising on the development activities.
[9596]60
[10551]61..  _external biogeochemistry model : http://forge.ipsl.jussieu.fr/nemo/wiki/WorkingGroups/TOP/TOP-UserQuickGuide
62.. _working groups : https://forge.ipsl.jussieu.fr/nemo/wiki/WorkingGroups
63.. _reference documentation : https://www.nemo-ocean.eu/bibliography/documentation/
64.. _Special Issue : http://www.geosci-model-dev.net/special_issue40.html
65.. _associated projects : https://www.nemo-ocean.eu/projects/
66.. _bibliography : https://www.nemo-ocean.eu/wp-content/plugins/wp-bibtexbrowser/bibtexbrowser.php?bib=nemo.bib
Note: See TracBrowser for help on using the repository browser.