source: trunk/NEMOGCM/SETTE/README @ 2732

Last change on this file since 2732 was 2732, checked in by rblod, 10 years ago

Add a test with AGRIF in sette.sh, just because life is always much more funny when using AGRIF

File size: 3.5 KB
Line 
1usage of SETTE package:
2
3principal script is sette.sh (usage: ./sette.sh)
4
5VERY IMPORTANT : for a verbose debug do:
6./sette.sh 2>&1 | tee out.sette
7this create out.sette file in ${SETTE_DIR}
8
9USER MODIFICATIONS
10 in sette.sh script :
11               COMPILER    : compiler among those available in NEMOGCM/ARCH, needed for makenemo (see below)
12                             can also be pass as an argument, e.g. ./sette.sh ifort_osx
13               makenemo -m : machine (compilator); see ./makenemo -m help (in NEMOGCM/CONFIG directory)
14                        -n : config name (in examples config_name_nproci_nprocj), see ./makenemo -n help
15                        -r : reference configuration (if you don't give it you have to choise directories to install)
16                        add_key : to add list of keys (for example to test reproductibility: add_key mpp_rep)
17                        del_key : to del list of keys
18               and for more details and options of makenemo see ./makenemo -h
19          set_namelist : to set namelist values
20         (example : to set 75 time steps for one test : namelist nn_itend 75)
21         (        : to change cn_icerst_in name : namelist_ice cn_icerst_in  \"test_00101231_restart_icemod\")
22         (      : to activate control print : namelist ln_ctl false )
23               fcm_job.sh needs input: input_CONFIG_NAME TOTAL_NUMBER_OF_PROCS_used TEST_NAME
24         (for example if you compile ORCA2_LIM with key_mpp_mpi
25         and only run short test ===> ./fcm_job input_ORCA2_LIM.cfg 4 SHORT)
26 in param.cfg :
27               EXE_DIR           : directory in which job s executed (by default CONFIG_DIR)
28               FORCING_DIR       : directory in which will be found input.tar file (same name in input_CONFIG_NAME.cfg)
29               INPUT_DIR         : directory in which store input files
30               TMPDIR            : temporary directory NEEDED ONLY FOR IBM machines (put EXP00 directory)
31               OUTPUT_DIR        : directory in which store output files
32          NEMO_VALIDATION_DIR : directory in which create NEMO_VALIDATION tree, and store restart, solver.stat and ocean.output files in
33                            tree NEMO_VALIDATION_DIR/WCONFIG_NAME/WCOMPILER_NAME/TEST_NAME/REVISION_NUMBER(or DATE)
34 in fcm_job.sh :
35               IMPORTANT : control that name of tar file in FORCING directory
36               is the same of that in input_REF_CONFIG.cfg, if not change one.
37               change in "RUN OPA" part the command line (some examples are already written)
38          TEST_NAME by convention is LONG: 10 days run or SHORT: 5 days run
39          so NEMO_VALIDATION tree is coherent,
40          but user can choise a TEST_NAME that represent his own test.
41
42NOTE:
43in case of error you can remove you NEW_CONF directory and all files doing :
44./makenemo -n MY_CONFIG clean_config
45
46if you want recompile nemo but before you want to clean compiled code do :
47./makenemo clean
48
49and if you have already compiled you can re-run all sette.sh and compilation part will be by-passed.
50
51NOTE 2:
52if you want a completly verbose makenemo you can uncomment "set -x" in makenemo script
53and then launch ./sette.sh 2>&1 | tee out.sette
54
55TO ADD NEW CONFIGURATION:
561. makenemo -n NEW_CONFIG (see makenemo -h for help) OR
572. makenemo -n NEW_CONFIG -r REF_CONFIG (if it is based on another reference configuration)
583. 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)
59
60TO ADD NEW MACHINE:
611. add arch-compiler.fcm in NEMOGCM/ARCH directory
622. makenemo -m new_compiler  (see makenemo -h for help)
Note: See TracBrowser for help on using the repository browser.