source: trunk/NEMOGCM/SETTE/README @ 3336

Last change on this file since 3336 was 3336, checked in by clevy, 9 years ago

SETTE bugfixes see ticket #941

File size: 4.3 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          BATCH_COMMAND : command for job submission in batch mode
14          MPI_INTERACT : "yes" if you want to run in interactive mode for MPI run
15                     "no" if you want to run in batch mode for MPI run
16               NOTE : every job using only 1 proc is run in interactive mode
17
18               makenemo -m : machine (compilator); see ./makenemo -m help (in NEMOGCM/CONFIG directory)
19                        -n : config name (in examples config_name_nproci_nprocj), see ./makenemo -n help
20                        -r : reference configuration (if you don't give it you have to choise directories to install)
21                        add_key : to add list of keys (for example to test reproductibility: add_key mpp_rep)
22                        del_key : to del list of keys
23               and for more details and options of makenemo see ./makenemo -h
24
25          set_namelist : to set namelist values
26         (example : to set 75 time steps for one test : namelist nn_itend 75)
27         (        : to change cn_icerst_in name : namelist_ice cn_icerst_in  \"test_00101231_restart_icemod\")
28         (      : to activate control print : namelist ln_ctl false )
29          prepare_exe_dir.sh creates execution directory for each test
30                    : NOTE for EACH JOB EXECUTION it is needed to set TEST_NAME variable
31                TEST_NAME variable gives name to execution directory (created in prepare_exe_dir.sh)
32                IT is mandatory to have different TEST_NAME for each job run if not existing files are re-written (for example namelist)
33
34               prepare_job.sh generates the script to be executed
35         input: INPUT_FILE_CONFIG_NAME NB_PROCS TEST_NAME MPI_FLAG JOB_FILE_NAME
36
37               fcm_job.sh needs input: TOTAL_NUMBER_OF_PROCS_used JOB_FILE_NAME INTERACT_FLAG MPI_FLAG
38         (for example if you compile ORCA2_LIM with key_mpp_mpi
39         and only run short test ===> ./fcm_job input_ORCA2_LIM.cfg 4 SHORT)
40
41 in param.cfg :
42               FORCING_DIR       : directory in which will be found input.tar file (same name in input_CONFIG_NAME.cfg)
43               INPUT_DIR         : directory in which store input files (tar file)
44               TMPDIR            : temporary directory NEEDED ONLY FOR IBM machines (put EXP00 directory)
45          NEMO_VALIDATION_DIR : directory in which create NEMO_VALIDATION tree, and store restart, solver.stat, tracer.stat and ocean.output files in
46                            tree NEMO_VALIDATION_DIR/WCONFIG_NAME/WCOMPILER_NAME/TEST_NAME/REVISION_NUMBER(or DATE)
47 in fcm_job.sh :
48               IMPORTANT : control that name of tar file in FORCING directory
49               is the same of that in input_REF_CONFIG.cfg, if not change one.
50
51               change in "RUN OPA" if [ ${MPI_INTERACT} == "yes" ] mpirun command line (some examples are already written)
52          NOTE: if MPI_INTERACT="no" it is neede a batch_file (see below to create a new one)
53
54NOTE:
55in case of error you can remove you NEW_CONF directory and all files doing :
56./makenemo -n MY_CONFIG clean_config
57
58if you want recompile nemo but before you want to clean compiled code do :
59./makenemo clean
60
61and if you have already compiled you can re-run all sette.sh and compilation part will be by-passed.
62
63NOTE 2:
64if you want a completly verbose makenemo you can uncomment "set -x" in makenemo script
65and then launch ./sette.sh 2>&1 | tee out.sette
66
67TO ADD NEW CONFIGURATION:
681. makenemo -n NEW_CONFIG (see makenemo -h for help) OR
692. makenemo -n NEW_CONFIG -r REF_CONFIG (if it is based on another reference configuration)
703. 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)
71
72TO ADD NEW MACHINE:
731. add arch-compiler.fcm in NEMOGCM/ARCH directory
742. makenemo -m new_compiler  (see makenemo -h for help)
75
76TO ADD NEW BATCH-FILE:
771. see in SETTE/BATCH_TEMPLATE directory existing examples
782. create you own batch file like: batch-${COMPILER}
79(note: sette.sh will copy it in job_batch_template if you run tests in MPI_INTERACT="no")
Note: See TracBrowser for help on using the repository browser.