Ignore:
Timestamp:
2018-11-07T12:04:15+01:00 (23 months 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/tests/README.rst

    r10240 r10279  
    1 ====================== 
     1********************** 
    22Explore the test cases 
    3 ====================== 
     3********************** 
     4 
     5.. contents:: 
     6   :local: 
     7 
     8List 
     9==== 
    410 
    511  The description below is a brief description of the test cases available in NEMO.  
    6   For detailed description and notebook, the reader is directed on the `Github repository`_ 
    7  
    8 .. _Github repository:   https://github.com/sflavoni/NEMO-test-cases/ 
    912 
    1013ICEDYN 
    11 ====== 
     14------ 
    1215   
    1316  This test case illustrates the advection of an ice patch across a East/West and North/South periodic channel.  
     
    1922 
    2023VORTEX 
    21 ====== 
     24------ 
    2225   
    2326  This test case illustrates the propagation of an anticyclonic eddy over a Beta plan and a flat bottom. 
     
    3235 
    3336ISOMIP 
    34 ====== 
     37------ 
    3538 
    3639  The purpose of this test case is to evaluate the impact of various schemes and new development with the iceshelf cavities circulation and melt. 
     
    4346 
    4447LOCK_EXCHANGE 
    45 ============= 
     48------------- 
    4649 
    4750  The LOCK EXCHANGE experiment is a classical fluid dynamics experiment that has been adapted 
     
    5659 
    5760OVERFLOW 
    58 ======== 
     61-------- 
    5962 
    6063  The OVERFLOW experiment illustrates the impact of different choices of numerical schemes  
     
    6972 
    7073WAD 
    71 === 
     74--- 
    7275 
    7376  A set of simple closed basin geometries for testing the Wetting and drying capabilities.  
     
    8184 
    8285CANAL 
    83 ===== 
     86----- 
    8487 
    8588  East-west periodic canal of variable size with several initial states and associated geostrophic currents (zonal jets or vortex). 
     
    8790  .. image::_static/CANAL_image.gif 
    8891 
    89 ================== 
    9092Compile test cases 
    9193================== 
     94 
    9295The compilation of the test cases is very similar to the manner the reference configurations are compiled. 
    93 If you are not familiar on how to compile NEMO, it is first recomended to read the instruction  
    94 `here <http://forge.ipsl.jussieu.fr/nemo/wiki/Users/ModelInstall>`_ 
     96If you are not familiar on how to compile NEMO, it is first recomended to read :doc:`the instructions <install>` 
    9597 
    9698| 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. 
     
    99101 
    100102.. code-block:: console 
    101                     
    102         $ ./makenemo -n WAD2 -a WAD -m macport_osx -j 4 
     103  
     104   $ ./makenemo -n WAD2 -a WAD -m macport_osx -j 4 
    103105 
    104 ===================================== 
    105106Run and analyse the test cases 
    106 ===================================== 
     107============================== 
     108 
    107109There no requirement of specific input file for the test_cases presented here. The XIOS xml input files and namelist are already setup correctly.  
    108 All the detailed on how to run a specific test cases and Jupyter notebook are available on github `here <https://github.com/sflavoni/NEMO-test-cases>`_. 
     110For detailed description and Jupyter notebook, the reader is directed on 
     111the `NEMO test cases repository <http://github.com/NEMO-ocean/NEMO-examples>`_ 
    109112 
    110 ========== 
    111113References 
    112114========== 
    113115 
    114 ..      bibliography:: test_cases.bib 
    115                 :all: 
    116         :style: unsrt 
     116.. bibliography:: test_cases.bib 
     117   :all: 
     118   :style: unsrt 
     119   :labelprefix: T 
Note: See TracChangeset for help on using the changeset viewer.