Changeset 5761 for branches/2015/dev_r5092_CNRS_SETTE/NEMOGCM/TRUST/config/user_template.cfg

Timestamp:

2015-09-24T17:34:59+02:00 (9 years ago)

Author:

nicolasmartin

Message:

Add help section

File:

• branches/2015/dev_r5092_CNRS_SETTE/NEMOGCM/TRUST/config/user_template.cfg (modified) (2 diffs)

branches/2015/dev_r5092_CNRS_SETTE/NEMOGCM/TRUST/config/user_template.cfg

@@ -1 @@
-## Copy to ./${CFG_USER}.cfg, fill in according to your installation
+## Copy to ./${NEMO_USER}.cfg, fill in according to your installation
 
 ## User configuration
@@ -12 +12 @@
 
 ## NEMO overall installation:
-[ -z "${NEMO_BRAN}" ] && NEMO_BRAN=''     ## NEMO SVN branch         to test
-                                             ## ex: 'trunk', 'nemo_v3_6_STABLE', ...
-NEMO_HOME=''                              ## NEMOGCM directory (includes ./ARCH, ./CONFIG, ...)
-                                             ## ex: "${DIR_WORK}/NEMO/${NEMO_BRAN}/NEMOGCM", ...
+[ -z "${NEMO_BRAN}" ] && NEMO_BRAN=''    ## NEMO SVN branch to test
+                                            ## ex: 'trunk', 'nemo_v3_6_STABLE', ...
+NEMO_HOME=''                             ## NEMOGCM directory (includes ./ARCH, ./CONFIG, ...)
+                                            ## ex: "${DIR_WORK}/NEMO/${NEMO_BRAN}/NEMOGCM", ...
 ## ${NEMO_BRAN} must be consistent with URL branch that have been checkout by SVN to build ${NEMO_HOME}
 
+
 ### Reference/'Trusting' configuration
-[ -z "${REFE_CONF}" ] && REFE_CONF=''     ## Reference configuration to test
-                                             ## ex: 'ORCA2_LIM_PISCES', 'GYRE', ...
-TEST_CONF=${REFE_CONF}'_trust'            ## Testing configuration name
-KEYS_ADD=''; KEYS_DEL=''                  ## CPP keys to add or remove from reference configuration
-                                             ## ex: "key_mpp_rep key_tide", ...
+[ -z "${REFE_CONF}" ] && REFE_CONF=''    ## Reference configuration to test
+                                            ## ex: 'ORCA2_LIM_PISCES', 'GYRE', ...
+TEST_CONF=''                             ## Testing configuration name
+KEYS_ADD=''; KEYS_DEL=''                 ## CPP keys to add or remove from reference configuration
+                                            ## ex: 'key_mpp_rep key_tide', ...
 #if [ ${REFE_CONF} == '' ]; then
 #    TEST_CONF=''
 #    KEYS_ADD='key_add ...' && KEYS_DEL='key_del ...'
+#elif ...
+#else ...
 #fi
 
+
 ### Inputs
-NEMO_FORC=''                              ## Directory with forcing archive from DODS/ESGF server to extract or
-                                          ##    " "     ""  all inputs files to copy into ${TEST_DIR}
-[ -z "${NEMO_TARF}" ] && NEMO_TARF=''     ## Archive inputs name, let blank if not requested
-                                             ## ex: 'ORCA2_LIM_nemo_v3.6.tar', 'AMM12_v3.6.tar', ...
+NEMO_FORC=''                             ## Directory with forcing archive from DODS/ESGF server to extract or
+                                         ##    " "     ""  all inputs files to copy into ${TEST_DIR}
+[ -z "${NEMO_TARF}" ] && NEMO_TARF=''    ## Archive inputs name, let blank if not requested
+                                            ## ex: 'ORCA2_LIM_nemo_v3.6.tar', 'AMM12_v3.6.tar', ...
 #[ ${REFE_CONF} == '' ] && NEMO_TARF=''
 
 
 ## Comparative directories path:
-REFE_DIR=''                  ## "Standard" folder where benchmark result files have been stored for comparison
-                                             ## ex: "${DIR_STOR}/${REFE_CONF}/${NEMO_BRAN}"
-TEST_DIR=''                  ## Testing    folder for computation
-                                             ## ex: "${DIR_SCRA}/${REFE_CONF}/${NEMO_BRAN}/trusting_${DATE}"
+REFE_DIR=''                 ## "Standard" folder where benchmark result files have been stored for comparison
+                                            ## ex: "${DIR_STOR}/${REFE_CONF}/${NEMO_BRAN}"
+TEST_DIR=''                 ## Testing    folder for computation
+                                            ## ex: "${DIR_SCRA}/${REFE_CONF}/${NEMO_BRAN}/trusting_${DATE}"
 
 
 ## External softs directories:
-DIR_XIOS=''                     ## ex: '${DIR_WORK}/XIOS/xios-1.0'
-#DIR_OASI=''                       ## ex: '${DIR_WORK}/OASIS'
+DIR_XIOS=''                    ## ex: '${DIR_WORK}/XIOS/xios-1.0'
+#DIR_OASI=''                      ## ex: '${DIR_WORK}/OASIS'
 
 
-## Mailing list to inform of a failure (-p|--publish option required)
+## Mailing list to inform of a failure (-p|--publish required)
 [ -z "$EMAIL"] && EMAIL=''