Changeset 10279 for NEMO/trunk/src/TOP/README.rst

Timestamp:

2018-11-07T12:04:15+01:00 (6 years ago)

Author:

nicolasmartin

Message:

Various improvments for quick start guide

• implementation of Rtd theme (Read the Docs) with custom layout and style file
• add reviewed BibTeX entries for NEMO references with DOI (manuals, guide, development strategy)
• enhancement of bibliography management and configuration file for guide building
• standardisation of headings markup
• numerous edits

File:

• NEMO/trunk/src/TOP/README.rst (modified) (6 diffs)

NEMO/trunk/src/TOP/README.rst

@@ -1 @@
-TOP interface
-=============
-
-.. include:: .global.rst
+*********************
+Oceanic tracers (TOP)
+*********************
 
 .. contents::
@@ -17 +16 @@
 up to the full set of equations involving marine biogeochemical cycles.
 
----------
 Structure
----------
+=========
 
 TOP interface has the following location in the source code ``./src/MBG/`` and
@@ -73 +71 @@
    trend computation for tracers
 
-------------------
 Synthetic Workflow
-------------------
+==================
 
 A synthetic description of the TOP interface workflow is given below to summarize the steps involved in
@@ -125 +122 @@
   ↳ call trc_rst_wri, output tracers restart files
 
----------------------
 Namelists walkthrough
----------------------
+=====================
 
 namelist_top
@@ -235 +231 @@
 |||| &'''namc14_fcg'''     !  files & dates ||
 
------------------------------------------------------
 ``MY_TRC`` interface for coupling external BGC models
------------------------------------------------------
+=====================================================
 
 The generalized interface is pivoted on MY_TRC module that contains template files to build the coupling between
@@ -277 +272 @@
    if not done elsewhere in the code, using the call to iom_put.
 
----------------------------------------------------
 Coupling an external BGC model using NEMO framework
----------------------------------------------------
+===================================================
 
 The coupling with an external BGC model through the NEMO compilation framework can be achieved in