Changeset 11734 for NEMO/trunk/cfgs/SHARED/README.rst

Timestamp:

2019-10-18T18:46:26+02:00 (5 years ago)

Author:

nicolasmartin

Message:

Review README for reference confgiurations

File:

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

NEMO/trunk/cfgs/SHARED/README.rst

@@ -3 +3 @@
 ***********
 
+.. todo::
+
+
+
 .. contents::
-           :local:
+   :local:
 
 Output of diagnostics in NEMO is usually done using XIOS.
@@ -11 +15 @@
 Much more information is available from the XIOS homepage above and from the NEMO manual.
 
-Use of XIOS for diagnostics is activated using the pre-compiler key ``key_iomput``. 
+Use of XIOS for diagnostics is activated using the pre-compiler key ``key_iomput``.
 
 Extracting and installing XIOS
@@ -19 +23 @@
    If you want to use single file output you will need to compile the HDF & NetCDF libraries to allow parallel IO.
 2. Download the version of XIOS that you wish to use. The recommended version is now XIOS 2.5:
-   
+
 .. code-block:: console
 
@@ -25 +29 @@
 
 and follow the instructions in `XIOS documentation <http://forge.ipsl.jussieu.fr/ioserver/wiki/documentation>`_ to compile it.
-   If you find problems at this stage, support can be found by subscribing to the `XIOS mailing list <http://forge.ipsl.jussieu.fr/mailman/listinfo.cgi/xios-users>`_ and sending a mail message to it. 
+   If you find problems at this stage, support can be found by subscribing to the `XIOS mailing list <http://forge.ipsl.jussieu.fr/mailman/listinfo.cgi/xios-users>`_ and sending a mail message to it.
 
 XIOS Configuration files
@@ -73 +77 @@
 1. Add any necessary code to calculate you new diagnostic in NEMO
 2. Send the field to XIOS using ``CALL iom_put( 'field_id', variable )`` where ``field_id`` is a unique id for your new diagnostics and variable is the fortran variable containing the data.
-   This should be called at every model timestep regardless of how often you want to output the field. No time averaging should be done in the model code. 
+   This should be called at every model timestep regardless of how often you want to output the field. No time averaging should be done in the model code.
 3. If it is computationally expensive to calculate your new diagnostic you should also use "iom_use" to determine if it is requested in the current model run. For example,
-   
+
 .. code-block:: fortran