Changeset 11759

Timestamp:

2019-10-21T18:24:58+02:00 (5 years ago)

Author:

nicolasmartin

Message:

Review README for data assimilation

Location:

NEMO/trunk/doc/rst/source

Files:

• conf.py (modified) (1 diff)
• cplg.rst (modified) (2 diffs)
• da.rst (modified) (5 diffs)

NEMO/trunk/doc/rst/source/conf.py

@@ -253 +253 @@
 extlinks = {
    'doi'    : ('https://doi.org/%s'                                                    , 'doi:'),
-   'doxy'   : ('https://forge.ipsl.jussieu.fr/nemo/chrome/site/doc/NEMO/manual/html/%s', None  ),
+   'manhtml': ('https://forge.ipsl.jussieu.fr/nemo/chrome/site/doc/NEMO/manual/html/%s', None  ),
    'forge'  : ('https://forge.ipsl.jussieu.fr/nemo/%s'                                 , None  ),
    'gmd'    : ('https://www.geosci-model-dev.net/%s'                                   , None  ),

NEMO/trunk/doc/rst/source/cplg.rst

@@ -8 +8 @@
 
 NEMO currently exploits OASIS-3-MCT (versions 1 to 4) to implement a generalised coupled interface
-(:doxy:`Coupled Formulation <node50.html?doc=NEMO>`).
+(:manhtml:`Coupled Formulation <node50.html>`).
 It can be used to interface with most of the European atmospheric GCM
 (ARPEGE, ECHAM, ECMWF, Ha- dAM, HadGAM, LMDz), as well as to regional atmospheric models
@@ -14 +14 @@
 To implement the coupling of two independent NEMO components,
 ocean on one hand and sea-ice plus other surface processes on the other hand
-(:doxy:`Standalone Surface Module - SAS <node46.html?doc=NEMO>`).
+(:manhtml:`Standalone Surface Module - SAS <node46.html>`).
 
 To enable the OASIS interface the required compilation key is ``key_oasis3``.

NEMO/trunk/doc/rst/source/da.rst

@@ -17 +17 @@
 - ``TAM`` the tangent linear and adjoint model.
 
-Please see |DOI man OCE|_ for more details including information about the input file formats and
-the namelist settings.
+Please see :doc:`NEMO manual <cite>` for more details including
+information about the input file formats and the namelist settings.
 
 Observation and model comparison (``OBS``)
@@ -33 +33 @@
 To build with the OBS code active ``key_diaobs`` must be set.
 
-More details in |DOI man OCE|_ "Observation and Model Comparison (``OBS``)" chapter.
+More details in :manhtml:`"Observation and Model Comparison (OBS)" chapter <node83.html>`.
 
 Standalone observation operator (``SAO``)
@@ -42 +42 @@
 (previously known the offline observation operator).
 
-To build the SAO use makenemo.
+To build the SAO use :file:`makenemo`.
 This means compiling NEMO once (in the normal way) for the chosen configuration.
 Then include ``SAO`` at the end of the relevant line in :file:`cfg.txt` file.
@@ -48 +48 @@
 This is a special version of :file:`nemogcm.F90` (which doesn't run the model,
 but reads in the model fields, and observations and runs the OBS code.
-See "Standalone observation operator (``SAO``)" section in |DOI man OCE|_.
+See :manhtml:`"Standalone observation operator (SAO)" section <node88.html>`.
 
 Apply assimilation increments (``ASM``)
@@ -61 +61 @@
 To build the ASM code ``key asminc`` must be set.
 
-More details in |DOI man OCE|_ "Apply Assimilation Increments (``ASM``)" chapter.
+More details in :manhtml:`"Apply Assimilation Increments (ASM)" chapter <node89.html>`.
 
 Tangent linear and adjoint (``TAM``)