source: NEMO/trunk/README.rst

Last change on this file was 13245, checked in by clevy, 5 months ago

Update rst files

File size: 3.8 KB
RevLine 
[11734]1.. todo::
2
3
4
[11708]5NEMO_ for *Nucleus for European Modelling of the Ocean* is a state-of-the-art modelling framework for
[10602]6research activities and forecasting services in ocean and climate sciences,
[10460]7developed in a sustainable way by a European consortium since 2008.
[10279]8
[10602]9.. contents::
10   :local:
11
[10187]12Overview
13========
[9596]14
[10602]15The NEMO ocean model has 3 major components:
[10187]16
[11713]17- |OCE| models the ocean {thermo}dynamics and solves the primitive equations
18  (:file:`./src/OCE`)
19- |ICE| simulates sea-ice {thermo}dynamics, brine inclusions and
20  subgrid-scale thickness variations (:file:`./src/ICE`)
21- |MBG| models the {on,off}line oceanic tracers transport and biogeochemical processes
22  (:file:`./src/TOP`)
[9596]23
[11708]24These physical core engines are described in
25their respective `reference publications <#project-documentation>`_ that
[11723]26must be cited for any work related to their use (see :doc:`cite`).
[9596]27
[10602]28Assets and solutions
29====================
[9596]30
[10602]31Not only does the NEMO framework model the ocean circulation,
32it offers various features to enable
[9596]33
[10602]34- Create :doc:`embedded zooms<zooms>` seamlessly thanks to 2-way nesting package AGRIF_.
35- Opportunity to integrate an :doc:`external biogeochemistry model<tracers>`
[11723]36- Versatile :doc:`data assimilation<da>`
37- Generation of :doc:`diagnostics<diags>` through effective XIOS_ system
38- Roll-out Earth system modeling with :doc:`coupling interface<cplg>` based on OASIS_
[9596]39
[11723]40Several :doc:`built-in configurations<cfgs>` are provided to
[10602]41evaluate the skills and performances of the model which
[11713]42can be used as templates for setting up a new configurations (:file:`./cfgs`).
[9596]43
[11723]44The user can also checkout available :doc:`idealized test cases<tests>` that
[11713]45address specific physical processes (:file:`./tests`).
[9596]46
[11713]47A set of :doc:`utilities <tools>` is also provided to {pre,post}process your data (:file:`./tools`).
[9596]48
[10602]49Project documentation
50=====================
[9596]51
[10602]52A walkthrough tutorial illustrates how to get code dependencies, compile and execute NEMO
[11713]53(:file:`./INSTALL.rst`).
[9596]54
[10602]55Reference manuals and quick start guide can be build from source and
[11713]56exported to HTML or PDF formats (:file:`./doc`) or
[11708]57downloaded directly from the :forge:`development platform<wiki/Documentations>`.
[10279]58
[11713]59============ ================== ===================
60 Component    Reference Manual   Quick Start Guide
61============ ================== ===================
[11734]62 |NEMO-OCE|   |DOI man OCE|_     |DOI qsg|
[11708]63 |NEMO-ICE|   |DOI man ICE|
[13245]64 |NEMO-TOP|   |DOI man TOP|
[11713]65============ ================== ===================
[10279]66
[10602]67Since 2014 the project has a `Special Issue`_ in the open-access journal
[11708]68Geoscientific Model Development (GMD) from the European Geosciences Union (EGU_).
[10602]69The main scope is to collect relevant manuscripts covering various topics and
70to provide a single portal to assess the model potential and evolution.
[10279]71
[10602]72Used by a wide audience,
73numerous :website:`associated projects<projects>` have been carried out and
74extensive :website:`bibliography<bibliography/publications>` published.
[10279]75
[10602]76Development board
77=================
[10279]78
[11708]79The NEMO Consortium pulling together 5 European institutes
80(CMCC_, CNRS_, MOI_, `Met Office`_ and NERC_) plans the sustainable development in order to
81keep a reliable evolving framework since 2008.
[9596]82
[11708]83It defines the |DOI dev stgy|_ that is implemented by the System Team on a yearly basis
84in order to release 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
[11708]89.. |DOI dev stgy| replace:: multi-year development strategy
[11713]90
91Disclaimer
92==========
93
94The NEMO source code is freely available and distributed under
95:download:`CeCILL v2.0 license <../../../LICENSE>` (GNU GPL compatible).
96
97You can use, modify and/or redistribute the software under its terms,
98but users are provided only with a limited warranty and the software's authors and
99the successive licensor's have only limited liability.
Note: See TracBrowser for help on using the repository browser.