Changeset 7421 for branches/2016/dev_merge_2016/NEMOGCM/TOOLS/DOMAINcfg/README

Timestamp:

2016-12-01T18:10:41+01:00 (7 years ago)

Author:

flavoni

Message:

#1811 merge dev_CNRS_MERATOR_2016 with dev_merge_2016 branch

Location:

branches/2016/dev_merge_2016/NEMOGCM/TOOLS/DOMAINcfg

Files:

• . (copied) (copied from branches/2016/dev_CNRS_2016/NEMOGCM/TOOLS/DOMAINcfg)
• README (modified) (3 diffs)

branches/2016/dev_merge_2016/NEMOGCM/TOOLS/DOMAINcfg/README

@@ +1 @@
+================================
+= HOW TO COMPILE
+================================
 The DOMAINcfg tool can be compiled using the maketools script in the NEMOGCM/TOOLS directory as follows:
 :::::::::::::::::::::::::::::::::
@@ -7 +10 @@
 DOMAINcfg compiled will create "make_domain_cfg.exe" executable script (the main routine of this tool is make_domain_cfg.f90)
 
-TO RUN DOMAINCFg TOOL:
-copy in src directory all FORCING files of NEMO_v3_6_stable of configuration 
+================================
+= HOW TO RUN
+================================
+just run :
+:::::::::::::::::::::::::::::::::::::::::::::::::
+./make_domain_cfg.exe
+:::::::::::::::::::::::::::::::::::::::::::::::::
+NOTA: it can be run in multiproc mode, but in output there will be domain_cfg_00xx.nc files
+
+================================
+= HOW TO USE
+================================
+::: VERY IMPORTANT PRE-REQUIRED :::
+0) pre-required: this tool needs xios1
+
+  (download http://forge.ipsl.jussieu.fr/ioserver/svn/XIOS/branchs/xios-1.0
+   DOMAINcfg tool is working with revision 703 of xios)
+
+1) copy in DOMAINcfg  directory namelist_cfg all settings (that you had in 3.6_stable) of the configuration for which you want prepare domain_cfg.nc file
+IMPORTANT : keep the namelist_ref committed inchanged. 
+
+NEW OPTION ln_e3_dep in the namelist_ref:
+till nemo_v3.6_stable e3 were done like an analytical derivative of depth function
+now  e3=dk[depth] in discret sens
+
+If you want to create same e3[tuvw] like 3.6 you've to use "ln_e3_dep=.false."
+
+ ln_e3_dep   = .true.    ! =T : e3=dk[depth] in discret sens.
+   !                       !      ===>>> will become the only possibility in v4.0
+   !                       ! =F : e3 analytical derivative of depth function
+   !                       !      only there for backward compatibility test with v3.6
+   !
+
+2) copy in DOMAINcfg directory same input files (of related configuration) required in v3.6_stable.
+
+DOMAINcfg package is EXACTLY what does exist in NEMO version 3.6 to define a model domain (both domain related namelist and initialization).
+DOMAINcfg tool creates a netcdf file "domain_cfg.nc" containing all the ocean domain informations required to define an ocean configuration,
+these files are :
+          
+    domain size
+    domain characteristics (periodic)
+    horizontal mesh
+    Coriolis parameter
+    depth and vertical scale factors
+
 FOR EXAMPLE 
 - for AMM12 : 
@@ -26 +72 @@
             field_def.xml
             iodef.xml
-and just run :
-:::::::::::::::::::::::::::::::::::::::::::::::::
-./make_domain_cfg.exe
-:::::::::::::::::::::::::::::::::::::::::::::::::
-
-DOMAINcfg package is EXACTLY what does exist in NEMO version 3.6 to define a model domain (both domain related namelist and initialization):
-DOMAINcfg tool creates a netcdf file "domain_cfg.nc" containing all the ocean domain informations required to define an ocean configuration,
-these files are :
-          
-    domain size
-    domain characteristics (periodic)
-    horizontal mesh
-    Coriolis parameter
-    depth and vertical scale factors
-
-VERY IMPORTANT::
- 1. pre-required: this tool needs xios1 
-
-  (download http://forge.ipsl.jussieu.fr/ioserver/svn/XIOS/branchs/xios-1.0 
-   DOMAINcfg tool is working with revision 703 of xios) 
-
- 2. namelist_ref and namelist_cfg needed (here committed namelists of ORCA2_LIM)
-
- 3. same input files (of related configuration) required in v3.6 are required here.