Changeset 5788 for branches/2015/dev_r5092_CNRS18_TRUST/NEMOGCM/TRUST/config/user_template.cfg

Timestamp:

2015-10-12T20:28:35+02:00 (9 years ago)

Author:

nicolasmartin

Message:

dev_r5092_CNRS18_TRUST Several enhancements (global variables rename, notification mail object, add job performances, templates description, script to install new minimal branch to test) to improve accessibility for NEMO users & bugfixes (tar creation, modulefiles)

File:

• branches/2015/dev_r5092_CNRS18_TRUST/NEMOGCM/TRUST/config/user_template.cfg (modified) (1 diff)

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

@@ -1 @@
-## Copy to ./${NEMO_USER}.cfg, fill in according to your installation
+## User configuration
+##---------------------------------------------------
 
-## User configuration
-##-------------------
+## Copy to root (./config) and rename it by keeping '.cfg' extension, then fill in according to your installation
+## Will be called by its name without extension
 
 
-## Global Directories:
-#DIR_WORK=''
-#DIR_SCRA=''
-#DIR_STOR=''
+## Mandatory
+##---------------------------------------------------
+
+## Few settings can be changed from directly from command line to reduce the creation of user configuration file
+## See `./trusting.sh [-h|--help]`
+
+## Directories path
+TRUS_BHMK=''           ## Benchmark folder where target files for comparison have been stored
+                         ## Inputs  (all) : CPP_*, namelist_*, *.xml et inputs_file.txt (formed by first test)
+                         ## Outputs (any) : *.stat, ocean.output, restarts
+TEST_DIR=''       ## Testing folder for computation
+                         ## ex: ".../trusting_${DATE}"
+TRUS_WKCY=''          ## Working copy of branch test
+                         ## ex: ".../NEMOGCM"
+DIR_XIOS=''       ## XIOS installation
+
+## NEMO configurations
+TRUS_REFE=''          ## Reference configuration to test
+TRUS_TEST=''          ## Testing configuration name
+
+## Forcing files
+TRUS_FORC=''          ## Directory with forcing archive to extract (combined use with ${TRUS_TARF}) or
+                      ##    " "     ""  all inputs files to copy into ${TEST_DIR}
 
 
-## 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", ...
-## ${NEMO_BRAN} must be consistent with URL branch that have been checkout by SVN to build ${NEMO_HOME}
+## Possible use 
+##---------------------------------------------------
+
+## Archive inputs name, let void if not requested
+TRUS_TARF=''
+
+## CPP keys to add or remove from reference configuration
+KEYS_ADD=''
+KEYS_DEL=''
 
 
-### Reference/'Trusting' configuration
-[ -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
+## Optional (can be void if no alternative or need)
+##---------------------------------------------------
 
-
-### 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', ...
-#[ ${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}"
-
-
-## External softs directories:
-DIR_XIOS=''                    ## ex: '${DIR_WORK}/XIOS/xios-1.0'
-#DIR_OASI=''                      ## ex: '${DIR_WORK}/OASIS'
-
-
-## Mailing list to inform of a failure (-p|--publish required)
-[ -z "$EMAIL"] && EMAIL=''
+## Mailing list to notify of a failure (-p|--prod required)
+TRUS_MAIL=''