Changeset 5761


Ignore:
Timestamp:
2015-09-24T17:34:59+02:00 (5 years ago)
Author:
nicolasmartin
Message:

Add help section

Location:
branches/2015/dev_r5092_CNRS_SETTE/NEMOGCM/TRUST
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • branches/2015/dev_r5092_CNRS_SETTE/NEMOGCM/TRUST/config/arch_template.cfg

    r5691 r5761  
    1 # Copy to ./${NEMO_HPCC}.cfg, fill in according to your installation 
     1## Copy to ./${NEMO_HPCC}.cfg, fill in according to your machine 
    22 
    3 # Super-computer configuration 
     3## Super-computer configuration 
    44 
    5 # Available softwares: 
    6 CDO=''                    # CDO (Climate Data Operators) (string appears in $LOADEDMODULES or $PATH) 
    7                                              # ex: 'cdo'/'nco'/... 
    8 COMPILER=''               # Fortran compiler (use with `$COMPILER --version`) 
    9                                              # ex: 'ifort'/'gfortran'/'pgfortran'/... 
    10 MPI=''                    # MPI    libraries             (   " "     ""  ""       ""       ""  " " ) 
    11                                              # ex: 'opempi'/'mpich'/... 
    12 NETCDF=''                 # NetCDF    " "                (   " "     ""  ""       ""       ""  " " ) 
    13                                              # ex: 'netcdf42'/'netcdf-parallel'/... 
    145 
    15 # Job commands (works with job ID): 
    16 JOB_SUBM=''               # Submit a job && get his ID in return 
    17                                              # ex: "cmd ${NEMO_TRUS}/batch/${NEMO_HPCC}.sh | awk '{print \$NF}'" 
    18 JOB_LIST=''                  # List all submitted jobs (use with `grep` to determine if a job is completed or not) 
    19 JOB_INFO=''               # Get job informations    (" "  ""  job ID as argument) 
    20 JOB_TIME=''                               # Get real CPU time computation with `eval "${JOB_INFO} ${JOB_ID} | ${JOB_TIME}"` 
    21                                              # ex: "awk '/opa/ END{print \$9}'" 
    22 JOB_DELE=''               # Kill submitted job      (" "  ""  " " "" ""    ""   ) 
     6## Architecture environment 
     7ARCH_ENV=''    ##  (be careful with compliance with XIOS) 
     8                  ## ex: "${DIR_XIOS}/arch/arch-${NEMO_HPCC}.env" 
    239 
    24 # Compiling & computing settings 
    25 [ -z "$NPROC"       ] && NPROC=1          # Processing units for compilation 
    26 [ -z "${TIME_LIMI}" ] && TIME_LIMI=''     # Utmost time in seconds to wait for completed job 
    2710 
    28 # Architecture environment (be careful with compliance with XIOS) 
    29 ARCH_ENV=''                               # ${DIR_XIOS}/arch/arch-${NEMO_HPCC}.env 
     11## Available softwares (pattern to search before release number): 
     12CDO=''         ## CDO (Climate Data Operators) (string appears in $LOADEDMODULES or $PATH) 
     13                  ## ex: 'cdo'/'nco'/... 
     14COMPILER=''    ## Fortran compiler (use with `$COMPILER --version`) 
     15                  ## ex: 'ifort'/'gfortran'/'pgfortran'/... 
     16MPI=''         ## MPI    libraries             (   " "     ""  ""       ""       ""  " " ) 
     17                  ## ex: 'opempi'/'mpich'/... 
     18NETCDF=''      ## NetCDF    " "                (   " "     ""  ""       ""       ""  " " ) 
     19                  ## ex: 'netcdf42'/'netcdf-parallel'/... 
     20 
     21 
     22## Job commands (works with job ID): 
     23JOB_SUBM=''    ## Submit a job && get his ID in return 
     24                  ## ex: "cmd ${NEMO_TRUS}/batch/${NEMO_HPCC}.sh | awk '{print \$NF}'" 
     25JOB_LIST=''    ## List all submitted jobs to determine if a job is completed or not 
     26JOB_INFO=''    ## Get job informations to fill in a log file (job ID as argument) 
     27JOB_TIME=''    ## Get real CPU time computation with `eval "${JOB_INFO} ${JOB_ID} | ${JOB_TIME}"` 
     28                  ## ex: "awk '/opa/ END{print \$9}'" 
     29JOB_DELE=''    ## Kill submitted job (job ID as argument) 
     30 
     31 
     32## Compiling & computation 
     33[ -z "$NPROC"       ] && NPROC=1         ## Processing units for compilation 
     34[ -z "${TIME_LIMI}" ] && TIME_LIMI=''    ## Utmost time in seconds to wait for completed job 
  • branches/2015/dev_r5092_CNRS_SETTE/NEMOGCM/TRUST/config/user_template.cfg

    r5685 r5761  
    1 ## Copy to ./${CFG_USER}.cfg, fill in according to your installation 
     1## Copy to ./${NEMO_USER}.cfg, fill in according to your installation 
    22 
    33## User configuration 
     
    1212 
    1313## NEMO overall installation: 
    14 [ -z "${NEMO_BRAN}" ] && NEMO_BRAN=''     ## NEMO SVN branch        to test 
    15                                              ## ex: 'trunk', 'nemo_v3_6_STABLE', ... 
    16 NEMO_HOME=''                              ## NEMOGCM directory (includes ./ARCH, ./CONFIG, ...) 
    17                                              ## ex: "${DIR_WORK}/NEMO/${NEMO_BRAN}/NEMOGCM", ... 
     14[ -z "${NEMO_BRAN}" ] && NEMO_BRAN=''    ## NEMO SVN branch to test 
     15                                            ## ex: 'trunk', 'nemo_v3_6_STABLE', ... 
     16NEMO_HOME=''                             ## NEMOGCM directory (includes ./ARCH, ./CONFIG, ...) 
     17                                            ## ex: "${DIR_WORK}/NEMO/${NEMO_BRAN}/NEMOGCM", ... 
    1818## ${NEMO_BRAN} must be consistent with URL branch that have been checkout by SVN to build ${NEMO_HOME} 
    1919 
     20 
    2021### Reference/'Trusting' configuration 
    21 [ -z "${REFE_CONF}" ] && REFE_CONF=''     ## Reference configuration to test 
    22                                              ## ex: 'ORCA2_LIM_PISCES', 'GYRE', ... 
    23 TEST_CONF=${REFE_CONF}'_trust'            ## Testing configuration name 
    24 KEYS_ADD=''; KEYS_DEL=''                  ## CPP keys to add or remove from reference configuration 
    25                                              ## ex: "key_mpp_rep key_tide", ... 
     22[ -z "${REFE_CONF}" ] && REFE_CONF=''    ## Reference configuration to test 
     23                                            ## ex: 'ORCA2_LIM_PISCES', 'GYRE', ... 
     24TEST_CONF=''                             ## Testing configuration name 
     25KEYS_ADD=''; KEYS_DEL=''                 ## CPP keys to add or remove from reference configuration 
     26                                            ## ex: 'key_mpp_rep key_tide', ... 
    2627#if [ ${REFE_CONF} == '' ]; then 
    2728#    TEST_CONF='' 
    2829#    KEYS_ADD='key_add ...' && KEYS_DEL='key_del ...' 
     30#elif ... 
     31#else ... 
    2932#fi 
    3033 
     34 
    3135### Inputs 
    32 NEMO_FORC=''                              ## Directory with forcing archive from DODS/ESGF server to extract or 
    33                                           ##    " "     ""  all inputs files to copy into ${TEST_DIR} 
    34 [ -z "${NEMO_TARF}" ] && NEMO_TARF=''     ## Archive inputs name, let blank if not requested 
    35                                              ## ex: 'ORCA2_LIM_nemo_v3.6.tar', 'AMM12_v3.6.tar', ... 
     36NEMO_FORC=''                             ## Directory with forcing archive from DODS/ESGF server to extract or 
     37                                         ##    " "     ""  all inputs files to copy into ${TEST_DIR} 
     38[ -z "${NEMO_TARF}" ] && NEMO_TARF=''    ## Archive inputs name, let blank if not requested 
     39                                            ## ex: 'ORCA2_LIM_nemo_v3.6.tar', 'AMM12_v3.6.tar', ... 
    3640#[ ${REFE_CONF} == '' ] && NEMO_TARF='' 
    3741 
    3842 
    3943## Comparative directories path: 
    40 REFE_DIR=''                  ## "Standard" folder where benchmark result files have been stored for comparison 
    41                                              ## ex: "${DIR_STOR}/${REFE_CONF}/${NEMO_BRAN}" 
    42 TEST_DIR=''                  ## Testing    folder for computation 
    43                                              ## ex: "${DIR_SCRA}/${REFE_CONF}/${NEMO_BRAN}/trusting_${DATE}" 
     44REFE_DIR=''                 ## "Standard" folder where benchmark result files have been stored for comparison 
     45                                            ## ex: "${DIR_STOR}/${REFE_CONF}/${NEMO_BRAN}" 
     46TEST_DIR=''                 ## Testing    folder for computation 
     47                                            ## ex: "${DIR_SCRA}/${REFE_CONF}/${NEMO_BRAN}/trusting_${DATE}" 
    4448 
    4549 
    4650## External softs directories: 
    47 DIR_XIOS=''                     ## ex: '${DIR_WORK}/XIOS/xios-1.0' 
    48 #DIR_OASI=''                       ## ex: '${DIR_WORK}/OASIS' 
     51DIR_XIOS=''                    ## ex: '${DIR_WORK}/XIOS/xios-1.0' 
     52#DIR_OASI=''                      ## ex: '${DIR_WORK}/OASIS' 
    4953 
    5054 
    51 ## Mailing list to inform of a failure (-p|--publish option required) 
     55## Mailing list to inform of a failure (-p|--publish required) 
    5256[ -z "$EMAIL"] && EMAIL='' 
  • branches/2015/dev_r5092_CNRS_SETTE/NEMOGCM/TRUST/trusting.sh

    r5701 r5761  
    5858 
    5959else 
    60     cat ${NEMO_TRUS}/${help_file} 
     60    cat ${NEMO_TRUS}/${trus_help} 
    6161    exit 1 
    6262fi 
  • branches/2015/dev_r5092_CNRS_SETTE/NEMOGCM/TRUST/trusting_help.txt

    r5671 r5761  
    1 ---------------------------------------------------------------------------- 
    2 Usage: trusting [-h] [-d] [-p] configuration 
     1Usage: ./trusting.sh -m $ARCH -u $USER [OPTIONS] 
     2Launch trusting test on $ARCH machine from $USER installation 
     3Example: './trusting.sh -m X64_CURIE -u romr005 -p -b nemo_v3_6_STABLE' 
    34 
    4 # ($ARCH & ./cfg/$ARCH.cfg file and at least arch-$ARCH.fcm file in NEMO ARCH dir are mandatory) 
     5Mandatory (default settings): 
     6    Files to source in ./config ($ARCH.cfg & $USER.cfg) 
     7    -m,--machine    Architecture settings (environment configuration) 
     8    -u,--user       User            ""    (NEMO directories & settings)        
    59 
    6 Options: 
    7    -h, --help, -help 
    8        Print this manual 
    9    -d, --debug 
    10        set -v 
    11    -p, --publish 
    12        Publish on dods server 
     10SVN working copy: 
     11    -b,--branch       SVN branch to test (trunk|nemo_v3_6_STABLE|... 
     12    -v,--version    Action on working copy ('svn status' by default) 
     13               '{'YYYY-MM-DD'}' Update to revision available at this date 
     14               [0-9]*              ""   "" revision number 
     15               HEAD|up|update     ""   "" last revision 
     16               st|status    Show differences with repository 
    1317 
    14 Examples:" 
    15    $ trusting -p IPSLCM5A 
     18NEMO Configuration: 
     19    -a,--archive    Forcing input files archive to extract downloaded from ESGF/DODS server  
     20    -n,--newconf    Testing   configuration created in ./CONFIG 
     21    -r,--refconf    Reference      " "      
    1622 
    17 Notes: 
    18    - To reset the trusting dashboard, type manually : 
    19      $ rm -rf $CCCWORKDIR/trusting/configuration 
    20      $ rm -rf $CCCWORKDIR/../../dods/public/${LOGNAME}/trusting/configuration 
    21    - Output will be saved at : 
    22      $ ls $CCCSTOREDIR/IGCM_OUT 
     23Compiling & computation: 
     24    -j,--job        Number of processes for compiling 
     25    -t,--time       Timeout for computation (s) 
     26 
     27Output control: 
     28    -d,--debug      Verbose output for debugging purpose (`set -vx`) 
     29    -e,--email      Email trusting digest report to following addresses only on failure 
     30    -h,--help       Print this help & exit 
     31    -p,--publish    Share trusting result 
Note: See TracChangeset for help on using the changeset viewer.