source: NEMO/trunk/README.rst @ 10227

Last change on this file since 10227 was 10201, checked in by nicolasmartin, 2 years ago

Various modifications related to the setting of a NEMO Quick Start Guide

  • Add missing namelist blocks from ICE and TOP
  • Create a hidden .global.rst to gather common URL links
  • Convert animated gif to frames images for PDF export
  • Place different README.rst appropriately in the code structure and refer to them with symbolic links in doc/rst/source
File size: 3.8 KB
[10201]1.. include:: .global.rst
[10201]3:Release: |release|
4:Date:    |today|
[10187]6NEMO for *Nucleus for European Modelling of the Ocean* is a state-of-the-art modelling framework of
[9596]7ocean related engines for oceanographic research, operational oceanography, seasonal forecast and
8[paleo]climate studies.
[10201]10.. contents::
11   :local:
[10187]16Distributed under CeCILL license (GNU GPL compatible - see ``./LICENSE``),
17the NEMO ocean model has 3 major components:
[9596]19- :rstblue:`OPA` is fundamental to all users by modelling the ocean [thermo]dynamics and
[10201]20  solving the primitive equations         (``./src/OCE``); :cite:`madec_bk08`
[10187]21- :rstgrey:`SI`\ :rstgreysup:`3` for sea-ice simulates ice [thermo]dynamics, brine inclusions and
[10201]22  subgrid-scale thickness variations      (``./src/ICE``); :cite:`gmd-8-2991-2015,vancoppenolle200933`
[10187]23- :rstgreen:`TOP-PISCES` models biogeochemistry with TOP for the on/offline oceanic tracers transport and
[10201]24  PISCES for the biogeochemical processes (``./src/MBG``). :cite:`gmd-8-2465-2015`
[10201]26These physical engines are described in their respective reference publications that must be cited for
[10187]27any work related to their use.
[10187]29Applications and capabilities
[10187]32Not only does the NEMO framework model the ocean circulation,
33it offers various features to enable
[10201]35- 2-way nesting package `AGRIF`_ to create :doc:`embedded zooms <zooms>` seamlessly
36- Flexible biogeochemistry with :doc:`online coarsening <coarsening>` and
37  opportunity to integrate an :doc:`alternative model <tracers>`
38- Versatile :doc:`data assimilation interface <data_assimilation>`
[10187]40lation a efficient XIOS_ server for outputing diagnostics a coupled via OASIS_ to alternative components or other models to enable Earth system modelling.
[10201]42| Several :doc:`builtins configurations <reference_configurations>` are provided to assess the skills and
43   performances of the model which can be used as templates for setting up a new configuration (``./cfgs``).
44| The end user could also find some :doc:`idealised test cases <test_cases>` on the web to serve as examples and
[10187]45   to study particular processes (``./tests``).
[10187]47A set of tools is also provided to setup your own configuration and [pre|post]process your data (``./tools``).
[10187]52| The NEMO reference manual and a quick start guide can be generated from Latex and RST source code files
53   (``./doc``), either in PDF or in HTML format, but it might require some additional installations.
54| In any case, both formats are available online: `HTML`_ | `PDF`_
[10201]56| Since 2014 the project has a `Special Issue`_ in the open-access journal Geoscientific Model Development (GMD)
[10187]57   from the European Geosciences Union (EGU).
58   The main scope is to collect relevant manuscripts which cover a wide variety of topics like
[10201]59   process studies, new parameterizations, implementation of new model features and new NEMO configurations.
[10187]60| Also it provides a single portal to search, discover and understand about
61   the NEMO modelling framework potential and evolution and to submit their contributions.
63Community development
[10201]66| The NEMO Consortium gathering 6 European institutes (`CMCC`_, `CNRS`_, `MOI`_, `Met Office`_ and `NERC`_)
67   organises the sustainable development in order to keep a reliable evolving system since 2008.
[10187]68| It defines the multi-year development strategy which is implemented by the NEMO System Team.
[10201]70When the need arises, `Working Groups`_ are created or resumed to gather the expertise in the community in order to
71focus the development work on a specific subject or major component of the framework.
[10201]73How to cite NEMO
[10201]76.. bibliography:: references.bib
77   :all:
78   :style: unsrt
[10187]80.. _HTML: 
81.. _PDF:  
Note: See TracBrowser for help on using the repository browser.