Changeset 11713 for NEMO/trunk/README.rst

Timestamp:

2019-10-17T17:49:19+02:00 (5 years ago)

Author:

nicolasmartin

Message:

Revamp TOP README and implement a TODO list
Review tracers.rst by adding snippets of source files
Add drafthtml target for Makefile related to draft building tag for sphinx-build to
display todo items at the top of the guide homepage

Misc:

• Use dedicated :file: role instead of ... for file or directory
• Update BibTeX entries of NEMO reference publications by using :title: role
• Dump of RELEASE_NOTES.rst
• New file todos.rst to list all items declared with todo directive
• Modify conf.py to add a conditional test for draft tag

File:

• NEMO/trunk/README.rst (modified) (5 diffs)

NEMO/trunk/README.rst

@@ -1 @@
-: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,
@@ -15 +11 @@
 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``)
+- |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
@@ -39 +36 @@
 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``).
+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``).
+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
@@ -50 +47 @@
 
 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
+exported to HTML or PDF formats (:file:`./doc`) or
 downloaded directly from the :forge:`development platform<wiki/Documentations>`.
 
-============ ================== ====================
- Component    Reference Manual   Quick start
-============ ================== ====================
+============ ================== ===================
+ Component    Reference Manual   Quick Start Guide
+============ ================== ===================
  |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
@@ -87 +84 @@
 
 .. |DOI dev stgy| replace:: multi-year development strategy
+
+Disclaimer
+==========
+
+The NEMO source code is freely available and distributed under
+:download:`CeCILL v2.0 license <../../../LICENSE>` (GNU GPL compatible).
+
+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.