source: trunk/NEMOGCM/SETTE/README @ 2569

usage of SETTE package:

principal script is sette.sh (usage: ./sette.sh)

VERY IMPORTANT : for a verbose debug do:
./sette.sh 2>&1 | tee out.sette
this create out.sette file in ${SETTE_DIR}

USER MODIFICATIONS
 in sette.sh script :
               SETTE_DIR : base directory for SETTE
               makenemo -m : machine (compilator); see ./makenemo -m help (in NEMOGCM/CONFIG directory)
                        -n : config name (in examples config_name_nproci_nprocj), see ./makenemo -n help
                        -r : reference configuration (if you don't give it you have to choise directories to install)
                        add_key : to add list of keys (for example to test reproductibility: add_key mpp_rep)
                        del_key : to del list of keys
               and for more details and options of makenemo see ./makenemo -h
          set_namelist : to set namelist values 
         (example : to set 75 time steps for one test : namelist nn_itend 75)
         (      : to change cn_icerst_in name : namelist_ice cn_icerst_in  \"test_00101231_restart_icemod.nc\")
         (      : to activate control print : namelist ln_ctl \".false.\" )
               fcm_job.sh needs input: input_CONFIG_NAME and TOTAL NUMBER OF PROCS used
         (for example if you compile ORCA2_LIM with nproci=2 and nprocj=2 ===> ./fcm_job input_ORCA2_LIM.cfg 4)
 in param.cfg :
               EXE_DIR     : directory in which execute jobs (by default CONFIG_DIR)
               FORCING_DIR : directory where to get input tar file
               INPUT_DIR   : directory in which store input files
               TMPDIR      : temporary directory NEEDED ONLY FOR IBM machines (put EXP00 directory)
               OUTPUT_DIR  : directory in which store output files
 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.
               change in "RUN OPA" part the command line (some examples are already written)


NOTE:
in case of error you can remove you NEW_CONF directory and all files doing :
./makenemo -n MY_CONFIG clean_config

if you want recompile nemo but before you want to clean compiled code do :
./makenemo clean

and if you have already compiled you can re-run all sette.sh and compilation part will be by-passed.

NOTE 2: 
if you want a completly verbose makenemo you can uncomment "set -x" in makenemo script
and then launch ./sette.sh 2>&1 | tee out.sette

TO ADD NEW CONFIGURATION:
1. makenemo -n NEW_CONFIG (see makenemo -h for help) OR
2. makenemo -n NEW_CONFIG -r REF_CONFIG (if it is based on another reference configuration)
3. for fcm_job.sh creates a new input_NEW_CONFIG.cfg if you need tar file (if you use same tar file of GYRE, ORCA2_LIM or ORCA2_LIM_PISCES you can use it)

TO ADD NEW MACHINE:
1. add arch-compiler.fcm in NEMOGCM/ARCH directory
2. makenemo -m new_compiler  (see makenemo -h for help)