7.2. create_xml module

make_loghead(ACCNR, MACHINE_ID, RUNDIR_ROOT, RTPWD, REGRESSIONTEST_LOG)[source]

Generate log header information

Parameters:

  • ACCNR (str) – Account to run the job with

  • MACHINE_ID (str) – Machine ID i.e. Hera, Gaea, Jet, etc.

  • RUNDIR_ROOT (str) – Test run directory

  • RTPWD (str) – Baseline directory

  • REGRESSIONTEST_LOG (str) – Regression Test log filename

rocoto_create_compile_task(MACHINE_ID, COMPILE_ID, ROCOTO_COMPILE_MAXTRIES, MAKE_OPT, ACCNR, COMPILE_QUEUE, PARTITION, ROCOTO_XML)[source]

Generate and append compile task into Rocoto XML file

Parameters:

  • MACHINE_ID (str) – Machine ID i.e., Hera, Gaea, Jet, etc.

  • COMPILE_ID (str) – Compile identifier e.g., s2swa_intel

  • ROCOTO_COMPILE_MAXTRIES (str) – Max attempts for compile

  • MAKE_OPT (str) – Make build options

  • ACCNR (str) – Account to run the job with

  • COMPILE_QUEUE (str) – Quality of Service (QOS), i.e., batch, windfall, normal, etc.

  • PARTITION (str) – System partition i.e., xjet, c5

  • ROCOTO_XML (str) – Rocoto XML filename to write to

rocoto_create_entries(RTPWD, MACHINE_ID, INPUTDATA_ROOT, INPUTDATA_ROOT_WW3, INPUTDATA_ROOT_BMIC, RUNDIR_ROOT, NEW_BASELINE, ROCOTO_XML)[source]

Generate header information for Rocoto XML file

Parameters:

  • RTPWD (str) – Baseline directory

  • MACHINE_ID (str) – Machine ID i.e., Hera, Gaea, Jet, etc.

  • INPUTDATA_ROOT (str) – Input data directory

  • INPUTDATA_ROOT_WW3 (str) – WW3 input data directory

  • INPUTDATA_ROOT_BMIC (str) – BMIC input data directory

  • RUNDIR_ROOT (str) – Test run directory

  • NEW_BASELINE (str) – Directory for newly generated baselines

  • ROCOTO_XML (str) – Rocoto XML filename to write to

write_compile_env(SCHEDULER, PARTITION, JOB_NR, COMPILE_QUEUE, RUNDIR_ROOT)[source]

Generate compile task .env file

Parameters:

  • SCHEDULER (str) – Job scheduler, e.g., pbs, slurm

  • PARTITION (str) – System partition, i.e., xjet, c5

  • JOB_NR (str) – Job number

  • COMPILE_QUEUE (str) – Quality of Service (QOS), i.e., batch, windfall, normal, etc.

  • RUNDIR_ROOT (str) – Test run directory

write_metatask_begin(COMPILE_METATASK_NAME, filename)[source]

Write compile task metadata to Rocoto XML file

Parameters:

  • COMPILE_METATASK_NAME (str) – Compile job name e.g., s2swa_intel

  • filename (str) – Rocoto XML filename to append to

write_metatask_end(filename)[source]

Append closing metatask element to Rocoto XML

Parameters:

filename (str) – Rocoto XML filename

write_runtest_env()[source]

Generate run task .env file

xml_loop()[source]

Creates workflow XML file for each test. Reads in baseline_setup.yaml, parses ufs_test.yaml, and sets up Rocoto XML according to the runtime arguments given in ufs_test.sh.