CESM CASEROOT env_batch.xml file

Model Version: CESM2.0
HTML created on: 2017-06-21

Description

The case.submit script reads these XML env_batch.xml settings in order to
determine the machine specific batch job submission arguments to be used for a
given job group; case.run, case.test, and case.st_archive..

Interface Tools

CESM2.0 supports 3 job groups; case.run, case.test, and case.st_archive.
The xmlquery and xmlchange script tools
accept the --subgroup command line argument to define one of the 3 job groups.
Batch settings can be modified anytime before case.submit is called.

Variable names delimited by 

{{ }}
are substituted at run-time and should not be modified.

Examples

Navigation Instuctions

Clicking on the blue link will display additional descriptive information.
Click on the "Show Details" button and then cntl+F key to search for specific strings in this file.



File Description Header <header>

      These variables may be changed anytime during a run, they
      control arguments to the batch submit command.

Default Batch Group Settings <group id="config_batch"> :

entry <entry> :
  • attributes :
    • id = BATCH_SYSTEM
    • value = pbs
  • Data Type <type> : char
  • Valid Values <valid_values> : moab,pbs,lsf,slurm,cobalt,cobalt_theta,none
  • Description <desc> : The batch system type to use for this machine.

Default Batch System Settings <batch_system type="pbs"> :

  • Batch Query Command <batch_query> : qstat
    • attributes :
      • args = -f
  • Batch Submission Command <batch_submit> : qsub
  • Batch Directive Prefix <batch_directive> : #PBS
  • Job ID Regular Expression Pattern <jobid_pattern> : ^(\S+)$
  • Job Dependency Command <depend_string> : -W depend=afterok:jobid
  • Job Walltime Format <walltime_format> : %H:%M:%S
    • Batch Job Submission Arguments <submit_args> :
    • Batch Argument <arg> :
      • Attributes :
        • flag = -q
        • name = $JOB_QUEUE
    • Batch Argument <arg> :
      • Attributes :
        • flag = -l walltime=
        • name = $JOB_WALLCLOCK_TIME
    • Batch Argument <arg> :
      • Attributes :
        • flag = -A
        • name = $PROJECT
    Batch Job Submission Directives <direcitves> :
    • <directive> : -N {{ job_id }}
      default=
    • <directive> : -r {{ rerunnable }}
      default=n
    • <directive> : -j oe
      default=
    • <directive> : -m {{ mail_options }}
      default=ae
    • <directive> : -V
      default=

Machine Specific Batch System Settings <batch_system MACH="cheyenne" type="pbs"> :

    Batch Job Submission Directives <direcitves> :
    • <directive> : -S {{ shell }}
      default=/bin/bash
    • <directive> : -l select={{ num_nodes }}:ncpus={{ max_tasks_per_node }}:mpiprocs={{ tasks_per_node }}:ompthreads={{ thread_count }}
      default=
    Batch Submission Default Queue Settings <queues> :
    Note: each job group defines their own job submission settings.
    • Queue Name <queue> : regular
      • Attributes :
        • default = true
        • jobmax = 2592
        • jobmin = 1
        • walltimemax = 1

Group case.run Settings <group id="case.run"> :

entry <entry> :
  • attributes :
    • id = prereq
    • value = $BUILD_COMPLETE and not $TEST
  • Data Type <type> : char
entry <entry> :
  • attributes :
    • id = task_count
    • value = default
  • Data Type <type> : char
entry <entry> :
  • attributes :
    • id = template
    • value = template.case.run
  • Data Type <type> : char
entry <entry> :
  • attributes :
    • id = PROJECT_REQUIRED
    • value = TRUE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : whether the PROJECT value is required on this machine
entry <entry> :
  • attributes :
    • id = PROJECT
    • value = P93300606
  • Data Type <type> : char
  • Description <desc> : project for project-sensitive build and run paths, and job scripts
entry <entry> :
  • attributes :
    • id = BATCH_COMMAND_FLAGS
    • value =
  • Data Type <type> : char
  • Valid Values <valid_values> :
  • Description <desc> : Override the batch submit command this job. Do not include executable or dependencies
entry <entry> :
  • attributes :
    • id = JOB_WALLCLOCK_TIME
    • value = 12:00:00
  • Data Type <type> : char
  • Valid Values <valid_values> :
  • Description <desc> : The machine wallclock setting. Default determined in config_machines.xml can be overwritten by testing
entry <entry> :
  • attributes :
    • id = JOB_QUEUE
    • value = regular
  • Data Type <type> : char
  • Valid Values <valid_values> :
  • Description <desc> : The machine queue in which to submit the job. Default determined in config_machines.xml can be overwritten by testing

Group case.test Settings <group id="case.test"> :

entry <entry> :
  • attributes :
    • id = prereq
    • value = $BUILD_COMPLETE and $TEST
  • Data Type <type> : char
entry <entry> :
  • attributes :
    • id = task_count
    • value = default
  • Data Type <type> : char
entry <entry> :
  • attributes :
    • id = template
    • value = template.case.test
  • Data Type <type> : char
entry <entry> :
  • attributes :
    • id = PROJECT_REQUIRED
    • value = TRUE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : whether the PROJECT value is required on this machine
entry <entry> :
  • attributes :
    • id = PROJECT
    • value = P93300606
  • Data Type <type> : char
  • Description <desc> : project for project-sensitive build and run paths, and job scripts
entry <entry> :
  • attributes :
    • id = BATCH_COMMAND_FLAGS
    • value =
  • Data Type <type> : char
  • Valid Values <valid_values> :
  • Description <desc> : Override the batch submit command this job. Do not include executable or dependencies
entry <entry> :
  • attributes :
    • id = JOB_WALLCLOCK_TIME
    • value = 12:00:00
  • Data Type <type> : char
  • Valid Values <valid_values> :
  • Description <desc> : The machine wallclock setting. Default determined in config_machines.xml can be overwritten by testing
entry <entry> :
  • attributes :
    • id = JOB_QUEUE
    • value = regular
  • Data Type <type> : char
  • Valid Values <valid_values> :
  • Description <desc> : The machine queue in which to submit the job. Default determined in config_machines.xml can be overwritten by testing

Group case.st_archive Settings <group id="case.st_archive"> :

entry <entry> :
  • attributes :
    • id = dependency
    • value = case.run or case.test
  • Data Type <type> : char
entry <entry> :
  • attributes :
    • id = prereq
    • value = $DOUT_S
  • Data Type <type> : char
entry <entry> :
  • attributes :
    • id = task_count
    • value = 1
  • Data Type <type> : char
entry <entry> :
  • attributes :
    • id = template
    • value = template.st_archive
  • Data Type <type> : char
entry <entry> :
  • attributes :
    • id = PROJECT_REQUIRED
    • value = TRUE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : whether the PROJECT value is required on this machine
entry <entry> :
  • attributes :
    • id = PROJECT
    • value = P93300606
  • Data Type <type> : char
  • Description <desc> : project for project-sensitive build and run paths, and job scripts
entry <entry> :
  • attributes :
    • id = BATCH_COMMAND_FLAGS
    • value =
  • Data Type <type> : char
  • Valid Values <valid_values> :
  • Description <desc> : Override the batch submit command this job. Do not include executable or dependencies
entry <entry> :
  • attributes :
    • id = JOB_WALLCLOCK_TIME
    • value = 12:00:00
  • Data Type <type> : char
  • Valid Values <valid_values> :
  • Description <desc> : The machine wallclock setting. Default determined in config_machines.xml can be overwritten by testing
entry <entry> :
  • attributes :
    • id = JOB_QUEUE
    • value = regular
  • Data Type <type> : char
  • Valid Values <valid_values> :
  • Description <desc> : The machine queue in which to submit the job. Default determined in config_machines.xml can be overwritten by testing