Ignore:
Timestamp:
2019-01-29T19:22:27+01:00 (20 months ago)
Author:
nicolasmartin
Message:

Corrections to .rst first files

File:
1 edited

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/tests/README.rst

    r10554 r10605  
    33********************** 
    44 
     5The complete and up-to-date set of test cases is available on 
     6`NEMO test cases Github repository <http://github.com/NEMO-ocean/NEMO-examples>`_. 
     7 
     8Download it directly in the ``./tests`` root directory with 
     9 
     10.. code-block:: console 
     11 
     12   $ git clone http://github.com/NEMO-ocean/NEMO-examples 
     13 
    514.. contents:: 
    615   :local: 
    716 
    8 List 
    9 ==== 
     17Procedure 
     18========= 
    1019 
    11   The description below is a brief description of the test cases available in NEMO.  
     20Compile test cases 
     21------------------ 
     22 
     23The compilation of the test cases is very similar to the manner the reference configurations are compiled. 
     24If you are not familiar on how to compile NEMO, it is first recomended to read :doc:`the instructions <install>` 
     25 
     26| In the same manner as the ref. cfg are compiled with '-r' option, test cases can be compile by the use of makenemo with '-a' option. 
     27| Here an example to compile a copy named WAD2 of the wetting and drying test case (WAD) on the macport_osx architecture on 4 cores: 
     28 
     29.. code-block:: console 
     30 
     31   $ ./makenemo -n 'WAD2' -a 'WAD' -m 'macport_osx' -j '4' 
     32 
     33Run and analyse the test cases 
     34------------------------------ 
     35 
     36There no requirement of specific input file for the test_cases presented here. The XIOS xml input files and namelist are already setup correctly.  
     37For detailed description and Jupyter notebook, the reader is directed on 
     38the `NEMO test cases repository <http://github.com/NEMO-ocean/NEMO-examples>`_ 
     39 
     40The description below is a brief advertisement of some test cases. 
    1241 
    1342ICE_AGRIF 
    14 --------- 
     43========= 
    1544   
    1645  This test case illustrates the advection of an ice patch across an East/West and North/South periodic channel 
     
    2453 
    2554VORTEX 
    26 ------ 
     55====== 
    2756   
    2857  This test case illustrates the propagation of an anticyclonic eddy over a Beta plan and a flat bottom. 
     
    3766 
    3867ISOMIP 
    39 ------ 
     68====== 
    4069 
    4170  The purpose of this test case is to evaluate the impact of various schemes and new development with the iceshelf cavities circulation and melt. 
     
    4877 
    4978LOCK_EXCHANGE 
    50 ------------- 
     79============= 
    5180 
    5281  The LOCK EXCHANGE experiment is a classical fluid dynamics experiment that has been adapted 
     
    6190 
    6291OVERFLOW 
    63 -------- 
     92======== 
    6493 
    6594  The OVERFLOW experiment illustrates the impact of different choices of numerical schemes  
     
    74103 
    75104WAD 
    76 --- 
     105=== 
    77106 
    78107  A set of simple closed basin geometries for testing the Wetting and drying capabilities.  
     
    86115 
    87116CANAL 
    88 ----- 
     117===== 
    89118 
    90119  East-west periodic canal of variable size with several initial states and associated geostrophic currents (zonal jets or vortex). 
     
    93122 
    94123ICE_ADV2D 
    95 --------- 
     124========= 
    96125   
    97126  This test case illustrates the advection of an ice patch across an East/West and North/South periodic channel 
     
    104133 
    105134ICE_ADV1D 
    106 --------- 
     135========= 
    107136   
    108137  This experiment is the classical Schar & Smolarkiewicz (1996) test case :cite:`SCHAR1996`, 
     
    112141  The purpose of this configuration is to test the caracteristics of advection schemes available in the sea-ice code 
    113142  (for now, Prather and Ultimate-Macho from 1st to 5th order), 
    114   especially the constitency between concentration, thickness and volume, and the preservation of initial shapes. 
    115    
    116    
    117  
    118    
    119 Compile test cases 
    120 ================== 
    121  
    122 The compilation of the test cases is very similar to the manner the reference configurations are compiled. 
    123 If you are not familiar on how to compile NEMO, it is first recomended to read :doc:`the instructions <install>` 
    124  
    125 | In the same manner as the ref. cfg are compiled with '-r' option, test cases can be compile by the use of makenemo with '-a' option. 
    126  
    127 | Here an example to compile a copy named WAD2 of the wetting and drying test case (WAD) on the macport_osx architecture on 4 cores: 
    128  
    129 .. code-block:: console 
    130   
    131    $ ./makenemo -n WAD2 -a WAD -m macport_osx -j 4 
    132  
    133 Run and analyse the test cases 
    134 ============================== 
    135  
    136 There no requirement of specific input file for the test_cases presented here. The XIOS xml input files and namelist are already setup correctly.  
    137 For detailed description and Jupyter notebook, the reader is directed on 
    138 the `NEMO test cases repository <http://github.com/NEMO-ocean/NEMO-examples>`_ 
     143  especially the constitency between concentration, thickness and volume, and the preservation of initial shapes.   
    139144 
    140145References 
Note: See TracChangeset for help on using the changeset viewer.