source: NEMO/trunk/README.rst @ 10605

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

Corrections to .rst first files

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