New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
Changeset 5799 for branches/2015/dev_r5092_CNRS18_TRUST/NEMOGCM/TRUST/config/arch_template.cfg – NEMO

Ignore:
Timestamp:
2015-10-16T16:38:37+02:00 (9 years ago)
Author:
nicolasmartin
Message:

dev_r5092_CNRS18_TRUST Establishing common environment for installing & running trusting, consolidation of scripts & continuation of templates & help section improvments

File:
1 edited

Legend:

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

    r5788 r5799  
    1 ## HPC configuration template 
     1## (Super)Computer configuration template 
    22##--------------------------------------------------- 
    33 
    44## Copy to root (./config) and rename it by keeping '.cfg' extension, then fill in according to your (super)computer 
    5 ## Will be called by its name without the extension 
     5## Rules for completion: 
     6   ## Undefined variables (=)   are mandatory 
     7   ## Void         " "    (='') " " optional 
     8## Look into other  configuration file for examples 
     9## It will be called by its name without the extension 
    610 
    711 
    8 ## Mandatory  
     12## Default settings 
    913##--------------------------------------------------- 
    1014 
    11 ## (Super)Computer environment 
    12 ARCH_ENV=''          ## *.env, *.path or modulesfile to source (let void if $PATH has already been setted) 
    13                           ## ex: "${DIR_XIOS}/arch/arch-${TRUS_HPCC}.env" 
     15## (Super)Computer environment (can be void if $PATH is already setted) 
     16   ## If `module` command is available, arch-${TRUS_HPCC}.env will be sourced. 
     17   ## If not (scheduled jobs by `cron`/`at` commands), it will be arch-${TRUS_HPCC}.path or any file given 
     18TRUS_ENVI=${TRUS_XIOS}/arch/arch-${TRUS_HPCC}     # ${TRUS_XIOS} is defined from user configuration file 
    1419 
    15 ## Job commands (use with `eval ${JOB_....}`), may need to use "\${JOB_ID}" variable as the job ID returned from submission: 
    16 JOB_SUBM=''          ## Submit a job and get his ID in return (will became ${JOB_ID}) 
    17                  ## ex: `llsubmit ${TRUS_DIR}/batch/${TRUS_HPCC}.sh | grep -oe '\<[0-9]*\>'`, use absolute path 
    18 JOB_STAT=''          ## Test state of the submitted job (true -> pending/running or false -> completed/crashed) 
    19                              ## ex: "llq | grep \${JOB_ID}" 
    20 JOB_KILL=''          ## Kill the submitted job 
    21                              ## ex: "llcancel   \${JOB_ID}" 
     20## Number of compiling processes 
     21[ -z "${TRUS_NPRO}" ] && TRUS_NPRO=1 
    2222 
    23 ## Compiling (number of tasks) and computation (timeout in s) 
    24 [ -z "${TRUS_NPRO}"     ] && TRUS_NPRO='1' 
    25 [ -z "${TIMEOUT}" ] && TIMEOUT='10800' 
    26  
    27 ## $CDO command to compare 2 datasets in argument 
    28 CDOD=''                 ## Essential to check a difference between NetCDF restart files 
     23## Command to compare 2 netCDF restart files in argument (think to load software in $PATH by any way) 
     24TRUS_CDOD='cdo diffn' 
    2925 
    3026 
    31 ## Interest when monitoring HPC center 
     27## Job commands 
    3228##--------------------------------------------------- 
    3329 
    34 ## Software releases (string pattern to match just before the number in $LOADEDMODULES or $PATH): 
    35 STR_CDOD=''          ## CDO (Climate Data Operators) 
    36                           ## ex: 'cdo'||'nco'||... 
    37 STR_LMPI=''          ## MPI    libraries             
    38                           ## ex: 'openmpi'||'mpich'||... 
    39 STR_NCDF=''          ## NetCDF    " "                
    40                           ## ex: 'netcdf'||'netcdf-parallel'||... 
     30## Use with `eval ${JOB_....}` because they will certainly need to have job ID as argument ("\${JOB_ID}") 
     31## It will be taken on the fly from standard output returned at the submission of the job 
    4132 
    42 ## Fortran compiler version (use with `$COMPILER --version`) 
    43 CMPF=''             ## ex: 'ifort'||'gfortran'||'pgfortran'||... 
     33TRUS_JSUB=   ## Submit a job and get his ID in return (assigned to ${JOB_ID}). Use absolute path, 
     34                 ## ./batch folder has been created to contain your submission script but it won't be copied into ${TRUS_TEST} 
     35             ## ex: `llsubmit ${TRUS_DIRE}/batch/${TRUS_HPCC}.sh | grep -oe '\<[0-9]*\>'` 
     36TRUS_JSTA=      ## Test state of the submitted job (true -> pending/running or false -> completed/crashed) 
     37                    ## ex: "llq | grep \${JOB_ID}" 
     38TRUS_JKIL=      ## Kill the submitted job 
     39                    ## ex: "llcancel   \${JOB_ID}" 
     40 
     41## Computational performances of finished job 
     42TRUS_JTIM=''    ## Get CPU elapsed time 
     43                    ## ex: `grep IdrisMemMPI NEMO_CI_\${JOB_ID} | cut -d, -f1 | awk '{print \$(NF-1),\$NF}'` 
     44TRUS_JPME=''       ## Get max physical memory 
     45                    ## ex: `grep IdrisMemMPI NEMO_CI_\${JOB_ID} | cut -d, -f3 | awk '{print \$3     ,\$4 }'` 
     46TRUS_JVME=''       ## Get " " virtual    ""   
     47 
     48## Get job informations to fill in a logfile during computation 
     49TRUS_JINF=''       ## ex: "llq -x \${JOB_ID}" 
    4450 
    4551 
    46 ## Optional (can be void if no alternative or need) 
     52## Available softwares/librairies 
    4753##--------------------------------------------------- 
    4854 
    49 ## Computational performances of finished job (use with `eval ${JOB_....}`) 
    50 JOB_INFO=''          ## Get job informations to fill in a logfile during computation 
    51                              ## ex: "llq -x     \${JOB_ID}" 
    52 JOB_TIME=''          ## Get CPU elapsed time 
    53                              ## ex: `grep IdrisMemMPI NEMO_CI_\${JOB_ID} | cut -d, -f1 | awk '{print \$(NF-1),\$NF}'` 
    54 JOB_PMEM=''          ## Get max physical memory 
    55                              ## ex: `grep IdrisMemMPI NEMO_CI_\${JOB_ID} | cut -d, -f3 | awk '{print \$3,\$4}'` 
    56 JOB_VMEM=''          ## Get " " virtual    ""   
     55## Fortran compiler version (use with `${TRUS_CMPF} --version`) 
     56TRUS_CMPF=''     ## ex: 'ifort'|'gfortran'|'pgfortran'|... 
     57 
     58## Software releases (string pattern to match just before the number in $PATH): 
     59TRUS_CDOR=''       ## CDO (Climate Data Operators) 
     60                      ## ex: 'cdo'|'nco'|... 
     61TRUS_MPIR=''       ## MPI    libraries             
     62                      ## ex: 'openmpi'|'mpich'|... 
     63TRUS_CDFR=''    ## NetCDF    " "                
     64                      ## ex: 'netcdf'|'netcdf-parallel'|... 
     65 
     66 
     67## Personal settings 
     68##--------------------------------------------------- 
     69 
     70## Timeout for computation (s) 
     71[ -z "${TRUS_TOUT}" ] && TRUS_TOUT= 
Note: See TracChangeset for help on using the changeset viewer.