Ignore:
Timestamp:
2019-10-18T18:46:26+02:00 (15 months ago)
Author:
nicolasmartin
Message:

Review README for reference confgiurations

File:
1 edited

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/INSTALL.rst

    r11723 r11734  
    22Build the framework 
    33******************* 
     4 
     5.. todo:: 
     6 
     7 
    48 
    59.. contents:: 
     
    123127------------------------------------------------ 
    124128 
    125 +-----------+----------------------------------------+ 
    126 | ``arch``  | Compilation settings                   | 
    127 +-----------+----------------------------------------+ 
    128 | ``cfgs``  | :doc:`Reference configurations <cfgs>` | 
    129 +-----------+----------------------------------------+ 
    130 | ``doc``   | :doc:`Documentation <doc>`             | 
    131 +-----------+----------------------------------------+ 
    132 | ``ext``   | Dependencies included                  | 
    133 |           | (``AGRIF``, ``FCM`` & ``IOIPSL``)      | 
    134 +-----------+----------------------------------------+ 
    135 | ``mk``    | Compilation scripts                    | 
    136 +-----------+----------------------------------------+ 
    137 | ``src``   | :doc:`Modelling routines <src>`        | 
    138 +-----------+----------------------------------------+ 
    139 | ``tests`` | :doc:`Test cases <tests>`              | 
    140 |           | (unsupported)                          | 
    141 +-----------+----------------------------------------+ 
    142 | ``tools`` | :doc:`Utilities <tools>`               | 
    143 |           | to {pre,post}process data              | 
    144 +-----------+----------------------------------------+ 
     129+---------------+----------------------------------------+ 
     130| :file:`arch`  | Compilation settings                   | 
     131+---------------+----------------------------------------+ 
     132| :file:`cfgs`  | :doc:`Reference configurations <cfgs>` | 
     133+---------------+----------------------------------------+ 
     134| :file:`doc`   | :doc:`Documentation <doc>`             | 
     135+---------------+----------------------------------------+ 
     136| :file:`ext`   | Dependencies included                  | 
     137|               | (``AGRIF``, ``FCM`` & ``IOIPSL``)      | 
     138+---------------+----------------------------------------+ 
     139| :file:`mk`    | Compilation scripts                    | 
     140+---------------+----------------------------------------+ 
     141| :file:`src`   | :doc:`Modelling routines <src>`        | 
     142+---------------+----------------------------------------+ 
     143| :file:`tests` | :doc:`Test cases <tests>`              | 
     144|               | (unsupported)                          | 
     145+---------------+----------------------------------------+ 
     146| :file:`tools` | :doc:`Utilities <tools>`               | 
     147|               | to {pre,post}process data              | 
     148+---------------+----------------------------------------+ 
    145149 
    146150Setup your architecture configuration file 
     
    166170====================================== 
    167171 
    168 The main script to {re}compile and create executable is called ``makenemo`` located at 
     172The main script to {re}compile and create executable is called :file:`makenemo` located at 
    169173the root of the working copy. 
    170174It is used to identify the routines you need from the source code, to build the makefile and run it. 
     
    192196+------------+----------------------------------------------------------------------------+ 
    193197 
    194 After successful execution of ``makenemo`` command, 
     198After successful execution of :file:`makenemo` command, 
    195199the executable called `nemo` is available in the :file:`EXP00` directory 
    196200 
    197 More ``makenemo`` options 
    198 ------------------------- 
     201More :file:`makenemo` options 
     202----------------------------- 
    199203 
    200204``makenemo`` has several other options that can control which source files are selected and 
     
    229233----------------------------- 
    230234 
    231 * ``functions.sh`` : bash functions used by ``makenemo``, for instance to create the WORK directory 
    232 * ``cfg.txt`` : text list of configurations and source directories 
    233 * ``bld.cfg`` : FCM rules to compile 
     235* :file:`functions.sh`: bash functions used by ``makenemo``, for instance to create the WORK directory 
     236* :file:`cfg.txt`    : text list of configurations and source directories 
     237* :file:`bld.cfg`     : FCM rules for compilation 
    234238 
    235239Examples 
     
    243247================= 
    244248 
    245 Once ``makenemo`` has run successfully, 
    246 the ``nemo`` executable is available in ``./cfgs/MY_CONFIG/EXP00``. 
    247 For the reference configurations, the ``EXP00`` folder also contains the initial input files 
     249Once :file:`makenemo` has run successfully, 
     250the ``nemo`` executable is available in :file:`./cfgs/MY_CONFIG/EXP00`. 
     251For the reference configurations, the :file:`EXP00` folder also contains the initial input files 
    248252(namelists, ``*.xml`` files for the IOs, ...). 
    249253If the configuration needs other input files, they have to be placed here. 
     
    261265the list of active CPP keys can be found in :file:`./cfgs/'MYCONFIG'/cpp_MY_CONFIG.fcm` 
    262266 
    263 This text file can be edited by hand or with ``makenemo`` to change the list of active CPP keys. 
     267This text file can be edited by hand or with :file:`makenemo` to change the list of active CPP keys. 
    264268Once changed, one needs to recompile ``nemo`` in order for this change to be taken in account. 
    265269Note that most NEMO configurations will need to specify the following CPP keys: 
Note: See TracChangeset for help on using the changeset viewer.