Changeset 10279 for NEMO/trunk/tests/README.rst

Timestamp:

2018-11-07T12:04:15+01:00 (6 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:

• NEMO/trunk/tests/README.rst (modified) (9 diffs)

NEMO/trunk/tests/README.rst

@@ -1 @@
-======================
+**********************
 Explore the test cases
-======================
+**********************
+
+.. contents::
+   :local:
+
+List
+====
 
   The description below is a brief description of the test cases available in NEMO. 
-  For detailed description and notebook, the reader is directed on the `Github repository`_
-
-.. _Github repository:   https://github.com/sflavoni/NEMO-test-cases/
 
 ICEDYN
-======
+------
   
   This test case illustrates the advection of an ice patch across a East/West and North/South periodic channel. 
@@ -19 +22 @@
 
 VORTEX
-======
+------
   
   This test case illustrates the propagation of an anticyclonic eddy over a Beta plan and a flat bottom.
@@ -32 +35 @@
 
 ISOMIP
-======
+------
 
   The purpose of this test case is to evaluate the impact of various schemes and new development with the iceshelf cavities circulation and melt.
@@ -43 +46 @@
 
 LOCK_EXCHANGE
-=============
+-------------
 
   The LOCK EXCHANGE experiment is a classical fluid dynamics experiment that has been adapted
@@ -56 +59 @@
 
 OVERFLOW
-========
+--------
 
   The OVERFLOW experiment illustrates the impact of different choices of numerical schemes 
@@ -69 +72 @@
 
 WAD
-===
+---
 
   A set of simple closed basin geometries for testing the Wetting and drying capabilities. 
@@ -81 +84 @@
 
 CANAL
-=====
+-----
 
   East-west periodic canal of variable size with several initial states and associated geostrophic currents (zonal jets or vortex).
@@ -87 +90 @@
   .. image::_static/CANAL_image.gif
 
-==================
 Compile test cases
 ==================
+
 The compilation of the test cases is very similar to the manner the reference configurations are compiled.
-If you are not familiar on how to compile NEMO, it is first recomended to read the instruction 
-`here <http://forge.ipsl.jussieu.fr/nemo/wiki/Users/ModelInstall>`_
+If you are not familiar on how to compile NEMO, it is first recomended to read :doc:`the instructions <install>`
 
 | 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.
@@ -99 +101 @@
 
 .. code-block:: console
-                   
-        $ ./makenemo -n WAD2 -a WAD -m macport_osx -j 4
+ 
+   $ ./makenemo -n WAD2 -a WAD -m macport_osx -j 4
 
-=====================================
 Run and analyse the test cases
-=====================================
+==============================
+
 There no requirement of specific input file for the test_cases presented here. The XIOS xml input files and namelist are already setup correctly. 
-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>`_.
+For detailed description and Jupyter notebook, the reader is directed on
+the `NEMO test cases repository <http://github.com/NEMO-ocean/NEMO-examples>`_
 
-==========
 References
 ==========
 
-..      bibliography:: test_cases.bib
-                :all:
-        :style: unsrt
+.. bibliography:: test_cases.bib
+   :all:
+   :style: unsrt
+   :labelprefix: T