Changeset 10750 for NEMO/branches/2019/fix_sette_ticket2239/README

Timestamp:

2019-03-13T19:06:16+01:00 (5 years ago)

Author:

mathiot

Message:

update nn_itend and restart name to fit new time step of ORCA2, add usage to sette.sh, add OVERFLOW in the cfg list in param.cfg and update README (ticket #2239)

File:

• NEMO/branches/2019/fix_sette_ticket2239/README (modified) (6 diffs)

NEMO/branches/2019/fix_sette_ticket2239/README

@@ -2 +2 @@
 
 PRINCIPAL SCRIPT: sette.sh 
-sette.sh is a simple wrapper running test on the reference configuration, test cases and generate the report at the end.
-User need to set up the param.cfg file correctly and download input file before running the script.
+ * sette.sh is a simple wrapper running test on the reference configuration, test cases and generate the report at the end.
+ * sette.sh is able to take a list of configuration in argument (sette.sh -t "CFG1 CFG2 CFG3"). The list of available configurations is available in running ./sette_list_avail_cfg.sh.
+   The default for sette is to run all of the reference and test configurations.
+ * User need to set up the param.cfg file correctly and download input file before running the script.
 
 SECONDARY SCRIPT
-sette_reference-configuration.sh, sette_test-cases.sh: run sette tests on the reference configurations and test cases respectively
-sette_rpt.sh: generate the sette report. See below in USER MODIFICATIONS the usage of the script
-sette_list_avail_rev.sh: generate a listing on all the revision available in the validation directory for each configuration.
+ * sette_reference-configuration.sh: run sette tests on the reference configurations
+ * sette_test-cases.sh             : run sette tests on test cases
+ * sette_rpt.sh                    : generate the sette report. See below in USER MODIFICATIONS the usage of the script
+ * sette_list_avail_rev.sh         : generate a listing on all the revision available in the validation directory for each configuration.
+ * sette_list_avail_cfg.sh         : generate a listing of all the available configurations.
 
 VERY IMPORTANT : for a verbose debug do:
@@ -15 +19 @@
 
 USER MODIFICATIONS
- in sette_cfg-ref.sh and sette_test-cases.sh script :
+ * in sette_cfg-ref.sh and sette_test-cases.sh script :
                OPTIONAL ARGUMENT : compiler among those available in NEMOGCM/ARCH (if nothing will use the one specified in paramd.cfg)
           BATCH_COMMAND_PAR : command for job submission in batch mode parallel (MMIÂ) specified in param.cfg
@@ -48 +52 @@
          and only run short test ===> ./fcm_job 4 SHORT no    yes   )
 
- in param.cfg :
+ * in param.cfg :
                
                COMPILER    : compiler among those available in NEMOGCM/ARCH
@@ -64 +68 @@
                ADD_NODIGNEDZERO    : set "yes" if you need key_nosignedzero to run nemo
 
- in fcm_job.sh :
+ * in fcm_job.sh :
                IMPORTANT : control that name of tar file in FORCING directory
                is the same of that in input_REF_CONFIG.cfg, if not change one.
@@ -71 +75 @@
           NOTE: if INTERACT_FLAG="no" it is needed a batch_file (see below to create a new one)
 
- in sette_rpt.sh : - if no argument are given, the report will be generated on the last changed revision.
+ * in sette_rpt.sh : - if no argument are given, the report will be generated on the last changed revision.
                    - if an argument is given (revision number) the report will be generated for this revision
                    - if 'old' is given as argument the former behavior is applied (the latest revision is check whatever the current revision
@@ -97 +101 @@
 1. add arch-compiler.fcm in NEMOGCM/ARCH directory
 2. makenemo -m new_compiler  (see makenemo -h for help)
+3. add new batch-file
 
 TO ADD NEW BATCH-FILE:
 1. see in SETTE/BATCH_TEMPLATE directory existing examples
 2. create you own batch file like: batch-${COMPILER}
-(note: sette_test-cases.sh and sette_cfg-ref.sh will copy it in job_batch_template if you run tests in INTERACT_FLAG="no")
+   (note: sette_test-cases.sh and sette_cfg-ref.sh will copy it in job_batch_template if you run tests in INTERACT_FLAG="no")