Changeset 10279 for NEMO/trunk/INSTALL.rst
- Timestamp:
- 2018-11-07T12:04:15+01:00 (5 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
NEMO/trunk/INSTALL.rst
r10201 r10279 1 ===================== 1 ********************* 2 2 Install the framework 3 ===================== 3 ********************* 4 4 5 .. include:: .global.rst 6 7 .. contents:: \ 5 .. contents:: 8 6 :local: 9 7 … … 24 22 ======================= 25 23 26 Download the source code 24 Download the source code 25 ------------------------ 27 26 28 27 .. code:: console … … 31 30 32 31 Description of directory tree 33 ============================= 32 ----------------------------- 34 33 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 +-----------+------------------------------------------------------------+ 60 60 61 61 Extract and install XIOS … … 121 121 .. literalinclude:: 122 122 123 -----------------124 123 Default behaviour 125 124 ----------------- … … 128 127 If –n option is not specified, ORCA2_LIM is the default configuration used. 129 128 130 -----------------------------131 129 Tools used during the process 132 130 ----------------------------- … … 136 134 bld.cfg : FCM rules to compile 137 135 138 --------139 136 Examples 140 137 -------- … … 163 160 echo "./makenemo -n MY_CONFIG -j0 add_key \"key_iomput key_mpp_mpi\" del_key \"key_agrif\" "; 164 161 165 -----------------166 162 Running the model 167 ----------------- 163 ================= 168 164 169 165 Once makenemo has run successfully, the opa executable is available in ``CONFIG/MY_CONFIG/EXP00`` … … 173 169 mpirun -n $NPROCS ./opa # $NPROCS is the number of processes ; mpirun is your MPI wrapper 174 170 175 --------------------------------------------176 171 Viewing and changing list of active CPP keys 177 -------------------------------------------- 172 ============================================ 178 173 179 174 For 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.