source: NEMO/trunk/README.rst @ 11708

:Release:  |release|
:Date:     |today|
:SVN rev.: |revision|

NEMO_ 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,
developed in a sustainable way by a European consortium since 2008.

.. contents::
   :local:

Overview
========

The NEMO ocean model has 3 major components:

- |NEMO-OCE| models the ocean {thermo}dynamics and solves the primitive equations (``./src/OCE``)
- |NEMO-ICE| simulates seaice {thermo}dynamics, brine inclusions and
  subgrid-scale thickness variations (``./src/ICE``)
- |NEMO-MBG| models the {on,off}line oceanic tracers transport and biogeochemical processes
  (``./src/TOP``)

These physical core engines are described in
their respective `reference publications <#project-documentation>`_ that
must be cited for any work related to their use (see :doc:`citations`).

Assets and solutions
====================

Not only does the NEMO framework model the ocean circulation,
it offers various features to enable

- Create :doc:`embedded zooms<zooms>` seamlessly thanks to 2-way nesting package AGRIF_.
- Opportunity to integrate an :doc:`external biogeochemistry model<tracers>`
- Versatile :doc:`data assimilation<data_assimilation>`
- Generation of :doc:`diagnostics<diagnostics>` through effective XIOS_ system
- Roll-out Earth system modeling with :doc:`coupling interface<coupling>` based on OASIS_

Several :doc:`built-in configurations<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``).

The user can also checkout available :doc:`idealized test cases<test_cases>` that
address specific physical processes (``./tests``).

A set of :doc:`utilities <tools>` is also provided to {pre,post}process your data (``./tools``).

Project documentation
=====================

A walkthrough tutorial illustrates how to get code dependencies, compile and execute NEMO
(``./INSTALL.rst``).

Reference manuals and quick start guide can be build from source and
exported to HTML or PDF formats (``./doc``) or
downloaded directly from the :forge:`development platform<wiki/Documentations>`.

============ ================== ====================
 Component    Reference Manual   Quick start
============ ================== ====================
 |NEMO-OCE|   |DOI man OCE|_     |DOI strt gui|
 |NEMO-ICE|   |DOI man ICE|
 |NEMO-MBG|   |DOI man MBG|
============ ================== ====================

Since 2014 the project has a `Special Issue`_ in the open-access journal
Geoscientific Model Development (GMD) from the European Geosciences Union (EGU_).
The main scope is to collect relevant manuscripts covering various topics and
to provide a single portal to assess the model potential and evolution.

Used by a wide audience,
numerous :website:`associated projects<projects>` have been carried out and
extensive :website:`bibliography<bibliography/publications>` published.

Development board
=================

The 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.

It defines the |DOI dev stgy|_ that is implemented by the System Team on a yearly basis
in order to release a new version almost every four years.

When the need arises, :forge:`working groups<wiki/WorkingGroups>` are created or resumed to
gather the community expertise for advising on the development activities.

.. |DOI dev stgy| replace:: multi-year development strategy