Changeset 14446

Timestamp:

2021-02-11T19:33:57+01:00 (3 years ago)

Author:

clem

Message:

trunk: some corrections on the html user guide

Location:

NEMO/trunk

Files:

• INSTALL.rst (modified) (1 diff)
• README.rst (modified) (1 diff)
• cfgs/README.rst (modified) (1 diff)
• doc/rst/source/conf.py (modified) (2 diffs)
• doc/rst/source/guide.rst (modified) (1 diff)
• src/OCE/USR/README.rst (modified) (1 diff)
• src/TOP/README.rst (modified) (1 diff)
• tests/README.rst (modified) (1 diff)

NEMO/trunk/INSTALL.rst

@@ -122 +122 @@
 .. code:: console
 
-   $ svn co https://forge.ipsl.jussieu.fr/nemo/svn/NEMO/releases/r4.0/r4.0.4
+   $ svn co https://forge.ipsl.jussieu.fr/ipsl/forge/projets/nemo/svn/NEMO/trunk
 
 Description of 1\ :sup:`st` level tree structure

NEMO/trunk/README.rst

@@ -62 +62 @@
  |NEMO-OCE|   |DOI man OCE|_     |DOI qsg|
  |NEMO-ICE|   |DOI man ICE|
- |NEMO-TOP|   |DOI man TOP|
+ |NEMO-MBG|   |DOI man MBG|
 ============ ================== ===================
 

NEMO/trunk/cfgs/README.rst

@@ -240 +240 @@
    The vertical eddy viscosity and diffusivity coefficients are increased to 1 m\ :sup:`2`/s in
    case of static instability.
-:time step: is 5760sec (1h36') so that there is 15 time steps in one day.
+:time step: is 5400sec (1h30') so that there is 16 time steps in one day.
 
 ORCA2_OFF_PISCES

NEMO/trunk/doc/rst/source/conf.py

@@ -43 +43 @@
 # General information about the project.
 project = u'NEMO'
-copyright = u'2019, NEMO Consortium'
+copyright = u'2020, NEMO Consortium'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -50 +50 @@
 #
 # The short X.Y version.
-version = 'trk'
+version = 'trunk'
 # The full version, including alpha/beta/rc tags.
 release = 'trunk'

NEMO/trunk/doc/rst/source/guide.rst

@@ -16 +16 @@
 .. toctree::
    :hidden:
-.. todos::
+
+   todos
 
 .. Only displayed with 'make drafthtml'

NEMO/trunk/src/OCE/USR/README.rst

@@ -58 +58 @@
 
 .. _here: https://prodn.idris.fr/thredds/catalog/ipsl_public/rron463/catalog.html
+
+Option 4: Use the nesting tools to create embedded zooms or regional configurations from an existing grid
+---------------------------------------------------------------------------------------------------------
+(see :download:`NESTING README <../../../tools/NESTING/README>`).
+
 
 Creating a completely new configuration

NEMO/trunk/src/TOP/README.rst

@@ -376 +376 @@
    .. code-block:: perl
 
-      bld::tool::fppkeys  key_zdftke key_dynspg_ts key_xios key_top
+      bld::tool::fppkeys key_xios key_top
       inc <MYBGCPATH>/MYBGC.fcm
 

NEMO/trunk/tests/README.rst

@@ -206 +206 @@
    :labelprefix: T
 
+ICE_RHEO
+--------
+| 
+
+BENCH
+-----
+| Benchmark configuration. Allow to run any configuration (including ORCA type or BDY) with idealized grid
+  and initial state so it does not need any input file other than the namelists.
+  As usual, all configuration changes can be done through the namelist. 
+  We provide 3 example of namelist_cfg to mimic ORCA1, OR025 or ORCA12 configurations.
+  By default do not produce any output file. An extensive description of BENCH will be abailable in 
+  Irrmann et al. 2021.
+
 CPL_OASIS
 ---------
 | This test case checks the OASIS interface in OCE/SBC, allowing to set up 
-a coupled configuration through OASIS. See CPL_OASIS/README.md for more information.
+  a coupled configuration through OASIS. See CPL_OASIS/README.md for more information.
 
 TSUNAMI
 ---------
 | just use dynspg_ts to simulate the propagation of an ssh anomaly (cosinus) in a box configuration
-with flat bottom and jpk=2
+  with flat bottom and jpk=2.
 
 DONUT
 -----
-| Donut shaped configuration to test MPI decomposition with bdy
+| Donut shaped configuration to test MPI decomposition with bdy.
+
+C1D_ASICS
+---------
+| 
+
+DOME
+----
+| 
+
+ICB
+----
+| ICB is a very idealized configuration used to test and debug the icb module.
+  The configuration is box with a shallow shelf (40m) on the east and west part of the domain 
+  with a deep central trough (> 100m).
+  ICB are generating using the test capability of the icb model along a E-W line (this can easily be tuned).
+
+STATION_ASF
+-----------
+| this demonstration test case can be used to perform a sanity test of the SBCBLK interface of
+  NEMO.  It will test all the bulk-parameterization algorithms using an idealized
+  forcing that includes a wide range of *SSX / surface atmospheric state*
+  conditions to detect potential error / inconsistencies.  Both a short report and
+  boolean output: *passed* or *failed* is provided as an output.
+
+SWG
+---
+| Square bassin blown with an analytical wind. Vertical structure allows only one mode
+  associated with reduced gravity to develop. This configuration is based on Adcroft & Marshall 1998.
+  Also run with RK3 time stepping.