Changeset 11734 for NEMO/trunk/INSTALL.rst

Timestamp:

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

Author:

nicolasmartin

Message:

Review README for reference confgiurations

File:

• NEMO/trunk/INSTALL.rst (modified) (7 diffs)

NEMO/trunk/INSTALL.rst

@@ -2 +2 @@
 Build the framework
 *******************
+
+.. todo::
+
+
 
 .. contents::
@@ -123 +127 @@
 ------------------------------------------------
 
-+-----------+----------------------------------------+
-| ``arch``  | Compilation settings                   |
-+-----------+----------------------------------------+
-| ``cfgs``  | :doc:`Reference configurations <cfgs>` |
-+-----------+----------------------------------------+
-| ``doc``   | :doc:`Documentation <doc>`             |
-+-----------+----------------------------------------+
-| ``ext``   | Dependencies included                  |
-|           | (``AGRIF``, ``FCM`` & ``IOIPSL``)      |
-+-----------+----------------------------------------+
-| ``mk``    | Compilation scripts                    |
-+-----------+----------------------------------------+
-| ``src``   | :doc:`Modelling routines <src>`        |
-+-----------+----------------------------------------+
-| ``tests`` | :doc:`Test cases <tests>`              |
-|           | (unsupported)                          |
-+-----------+----------------------------------------+
-| ``tools`` | :doc:`Utilities <tools>`               |
-|           | to {pre,post}process data              |
-+-----------+----------------------------------------+
++---------------+----------------------------------------+
+| :file:`arch`  | Compilation settings                   |
++---------------+----------------------------------------+
+| :file:`cfgs`  | :doc:`Reference configurations <cfgs>` |
++---------------+----------------------------------------+
+| :file:`doc`   | :doc:`Documentation <doc>`             |
++---------------+----------------------------------------+
+| :file:`ext`   | Dependencies included                  |
+|               | (``AGRIF``, ``FCM`` & ``IOIPSL``)      |
++---------------+----------------------------------------+
+| :file:`mk`    | Compilation scripts                    |
++---------------+----------------------------------------+
+| :file:`src`   | :doc:`Modelling routines <src>`        |
++---------------+----------------------------------------+
+| :file:`tests` | :doc:`Test cases <tests>`              |
+|               | (unsupported)                          |
++---------------+----------------------------------------+
+| :file:`tools` | :doc:`Utilities <tools>`               |
+|               | to {pre,post}process data              |
++---------------+----------------------------------------+
 
 Setup your architecture configuration file
@@ -166 +170 @@
 ======================================
 
-The main script to {re}compile and create executable is called ``makenemo`` located at
+The main script to {re}compile and create executable is called :file:`makenemo` located at
 the root of the working copy.
 It is used to identify the routines you need from the source code, to build the makefile and run it.
@@ -192 +196 @@
 +------------+----------------------------------------------------------------------------+
 
-After successful execution of ``makenemo`` command,
+After successful execution of :file:`makenemo` command,
 the executable called `nemo` is available in the :file:`EXP00` directory
 
-More ``makenemo`` options
--------------------------
+More :file:`makenemo` options
+-----------------------------
 
 ``makenemo`` has several other options that can control which source files are selected and
@@ -229 +233 @@
 -----------------------------
 
-* ``functions.sh`` : bash functions used by ``makenemo``, for instance to create the WORK directory
-* ``cfg.txt`` : text list of configurations and source directories
-* ``bld.cfg`` : FCM rules to compile
+* :file:`functions.sh`: bash functions used by ``makenemo``, for instance to create the WORK directory
+* :file:`cfg.txt`     : text list of configurations and source directories
+* :file:`bld.cfg`     : FCM rules for compilation
 
 Examples
@@ -243 +247 @@
 =================
 
-Once ``makenemo`` has run successfully,
-the ``nemo`` executable is available in ``./cfgs/MY_CONFIG/EXP00``.
-For the reference configurations, the ``EXP00`` folder also contains the initial input files
+Once :file:`makenemo` has run successfully,
+the ``nemo`` executable is available in :file:`./cfgs/MY_CONFIG/EXP00`.
+For the reference configurations, the :file:`EXP00` folder also contains the initial input files
 (namelists, ``*.xml`` files for the IOs, ...).
 If the configuration needs other input files, they have to be placed here.
@@ -261 +265 @@
 the list of active CPP keys can be found in :file:`./cfgs/'MYCONFIG'/cpp_MY_CONFIG.fcm`
 
-This text file can be edited by hand or with ``makenemo`` to change the list of active CPP keys.
+This text file can be edited by hand or with :file:`makenemo` to change the list of active CPP keys.
 Once changed, one needs to recompile ``nemo`` in order for this change to be taken in account.
 Note that most NEMO configurations will need to specify the following CPP keys: