Changeset 11824 for NEMO/branches/2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps/README.rst

Timestamp:

2019-10-29T14:13:45+01:00 (4 years ago)

Author:

acc

Message:

ranch 2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps. Updates to top level rst files to align with trunk changes between 10721 and 11740. This commit brings this branch up-to-date with the trunk at revision 11740 with the exception of the doc directory which has not been touched on this branch.

File:

• NEMO/branches/2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps/README.rst (modified) (5 diffs)

NEMO/branches/2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps/README.rst

@@ -1 @@
-:Release: |version|
-:Date:    |today|
+.. todo::
 
-NEMO_ for **Nucleus for European Modelling of the Ocean** is a state-of-the-art modelling framework for
+
+
+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.
@@ -14 +15 @@
 The NEMO ocean model has 3 major components:
 
-- |OPA| models the ocean {thermo}dynamics and solves the primitive equations
-  (``./src/OCE``)
-- |SI3| simulates seaice {thermo}dynamics, brine inclusions and subgrid-scale thickness variations
-  (``./src/ICE``)
-- |TOP| models the {on,off}line oceanic tracers transport and biogeochemical processes
-  (``./src/TOP``)
+- |OCE| models the ocean {thermo}dynamics and solves the primitive equations
+  (:file:`./src/OCE`)
+- |ICE| simulates sea-ice {thermo}dynamics, brine inclusions and
+  subgrid-scale thickness variations (:file:`./src/ICE`)
+- |MBG| models the {on,off}line oceanic tracers transport and biogeochemical processes
+  (:file:`./src/TOP`)
 
-These physical core engines are described in their respective `references`_ that
-must be cited for any work related to their use.
+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:`cite`).
 
 Assets and solutions
@@ -32 +34 @@
 - 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_
+- Versatile :doc:`data assimilation<da>`
+- Generation of :doc:`diagnostics<diags>` through effective XIOS_ system
+- Roll-out Earth system modeling with :doc:`coupling interface<cplg>` based on OASIS_
 
-Several :doc:`built-in configurations<configurations>` are provided to
+Several :doc:`built-in configurations<cfgs>` are provided to
 evaluate the skills and performances of the model which
-can be used as templates for setting up a new configurations (``./cfgs``).
+can be used as templates for setting up a new configurations (:file:`./cfgs`).
 
-The user can also checkout available :doc:`idealized test cases<test_cases>` that
-address specific physical processes(``./tests``).
+The user can also checkout available :doc:`idealized test cases<tests>` that
+address specific physical processes (:file:`./tests`).
 
-A set of :doc:`utilities <tools>` is also provided to {pre,post}process your data (``./tools``).
+A set of :doc:`utilities <tools>` is also provided to {pre,post}process your data (:file:`./tools`).
 
 Project documentation
@@ -49 +51 @@
 
 A walkthrough tutorial illustrates how to get code dependencies, compile and execute NEMO
-(``./INSTALL.rst``) . 
+(:file:`./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 :website:`website<bibliography/documentation>`.
+exported to HTML or PDF formats (:file:`./doc`) or
+downloaded directly from the :forge:`development platform<wiki/Documentations>`.
 
-=========== ===================== ===============
- Component   Reference Manual      Quick start
-=========== ===================== ===============
- |OPA|       |NEMO manual|_        |NEMO guide|
-             :cite:`NEMO_manual`
- |SI3|       |SI3 manual|
-             :cite:`SI3_manual`
- |TOP|       |TOP manual|
-             :cite:`TOP_manual`
-=========== ===================== ===============
+============ ================== ===================
+ Component    Reference Manual   Quick Start Guide
+============ ================== ===================
+ |NEMO-OCE|   |DOI man OCE|_     |DOI qsg|
+ |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).
+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.
@@ -78 +77 @@
 =================
 
-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.
+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 |NEMO strategy|_ that is implemented by the System Team on a yearly basis in order to
-release a new version almost every four years.
+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
 
-.. Substitutions / Links
+Disclaimer
+==========
 
-.. |NEMO manual| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1464816.svg
-.. |NEMO guide|  image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1475325.svg
-.. |SI3 manual|  image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1471689.svg
-.. |TOP manual|  image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1471700.svg
+The NEMO source code is freely available and distributed under
+:download:`CeCILL v2.0 license <../../../LICENSE>` (GNU GPL compatible).
 
-.. |NEMO strategy| replace:: multi-year development strategy
-
-.. _Special Issue: https://www.geosci-model-dev.net/special_issue40.html
+You can use, modify and/or redistribute the software under its terms,
+but users are provided only with a limited warranty and the software's authors and
+the successive licensor's have only limited liability.