Ignore:
Timestamp:
2018-11-07T12:04:15+01:00 (2 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:
1 edited

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/INSTALL.rst

    r10201 r10279  
    1 ===================== 
     1********************* 
    22Install the framework 
    3 ===================== 
     3********************* 
    44 
    5 .. include:: .global.rst 
    6  
    7 .. contents:: \ 
     5.. contents:: 
    86   :local: 
    97       
     
    2422======================= 
    2523 
    26 Download the source code  
     24Download the source code 
     25------------------------ 
    2726 
    2827.. code:: console 
     
    3130 
    3231Description of directory tree 
    33 ============================= 
     32----------------------------- 
    3433 
    35 +-----------+---------------------------------------------------------------+ 
    36 | Folder    | Purpose                                                       | 
    37 +===========+===============================================================+ 
    38 | ``arch``  | Settings (per architecture-compiler pair)                     | 
    39 +-----------+---------------------------------------------------------------+ 
    40 | ``cfgs``  | Reference configurations                                      | 
    41 +-----------+---------------------------------------------------------------+ 
    42 | ``doc``   | - ``latex``: reference manuals for NEMO, SI\ :sup:`3`\  & TOP | 
    43 |           | - ``rst``:   quick start guide                                | 
    44 +-----------+---------------------------------------------------------------+ 
    45 | ``ext``   | Dependencies included (AGRIF, FCM & IOIPSL)                   | 
    46 +-----------+---------------------------------------------------------------+ 
    47 | ``mk``    | Building  routines                                            | 
    48 +-----------+---------------------------------------------------------------+ 
    49 | ``src``   | Modelling routines                                            | 
    50 |           |                                                               | 
    51 |           | - ``ICE``: SI\ :sup:`3`\ for sea ice                          | 
    52 |           | - ``NST``: AGRIF         for embedded zooms                   | 
    53 |           | - ``OCE``: OPA           for ocean dynamics                   | 
    54 |           | - ``MBG``: TOP           for tracers                          | 
    55 +-----------+---------------------------------------------------------------+ 
    56 | ``tests`` | Test cases                                                    | 
    57 +-----------+---------------------------------------------------------------+ 
    58 | ``tools`` | Utilities to [pre|post]process data                           | 
    59 +-----------+---------------------------------------------------------------+ 
     34+-----------+------------------------------------------------------------+ 
     35| Folder    | Purpose                                                    | 
     36+===========+============================================================+ 
     37| ``arch``  | Settings (per architecture-compiler pair)                  | 
     38+-----------+------------------------------------------------------------+ 
     39| ``cfgs``  | :doc:`Reference configurations <configurations>`           | 
     40+-----------+------------------------------------------------------------+ 
     41| ``doc``   | - ``latex``: reference manuals for |OPA|, |SI3| & |TOP|    | 
     42|           | - ``namelists``: k start guide                             | 
     43|           | - ``rst``:   quick start guide                             | 
     44+-----------+------------------------------------------------------------+ 
     45| ``ext``   | Dependencies included (AGRIF, FCM & IOIPSL)                | 
     46+-----------+------------------------------------------------------------+ 
     47| ``mk``    | Building  routines                                         | 
     48+-----------+------------------------------------------------------------+ 
     49| ``src``   | Modelling routines                                         | 
     50|           |                                                            | 
     51|           | - ``ICE``: |SI3| for sea ice                               | 
     52|           | - ``NST``: AGRIF for embedded zooms                        | 
     53|           | - ``OCE``: |OPA| for ocean dynamics                        | 
     54|           | - ``MBG``: |TOP| for tracers                               | 
     55+-----------+------------------------------------------------------------+ 
     56| ``tests`` | :doc:`Test cases <test_cases>` (unsupported)               | 
     57+-----------+------------------------------------------------------------+ 
     58| ``tools`` | :doc:`Utilities <tools>` to [pre|post]process data         | 
     59+-----------+------------------------------------------------------------+ 
    6060 
    6161Extract and install XIOS 
     
    121121   .. literalinclude:: 
    122122 
    123 ----------------- 
    124123Default behaviour 
    125124----------------- 
     
    128127    If –n option is not specified, ORCA2_LIM is the default configuration used.  
    129128 
    130 ----------------------------- 
    131129Tools used during the process 
    132130----------------------------- 
     
    136134    bld.cfg : FCM rules to compile  
    137135 
    138 -------- 
    139136Examples 
    140137-------- 
     
    163160        echo "./makenemo -n MY_CONFIG -j0 add_key \"key_iomput key_mpp_mpi\" del_key \"key_agrif\" "; 
    164161 
    165 ----------------- 
    166162Running the model 
    167 ----------------- 
     163================= 
    168164 
    169165Once makenemo has run successfully, the opa executable is available in ``CONFIG/MY_CONFIG/EXP00`` 
     
    173169   mpirun -n $NPROCS ./opa    # $NPROCS is the number of processes ; mpirun is your MPI wrapper 
    174170 
    175 -------------------------------------------- 
    176171Viewing and changing list of active CPP keys 
    177 -------------------------------------------- 
     172============================================ 
    178173 
    179174For a given configuration (here called MY_CONFIG), the list of active CPP keys can be found in:: 
Note: See TracChangeset for help on using the changeset viewer.