saga.orchestrate

This module implements methods for submitting slurm jobs for all possible option combinations supplied in yaml argument files.

saga.orchestrate.create_jobs(configs, base_dir='./', submit_path='submit.sh', yaml_path='args.yaml', aliases=None, replacements=None)

Parameters

configsdict, required

Map of configuration option names to option values

base_dirstr, required

Path to directory in which to create job directories

submit_pathstr, required

Path to base version of SLURM job submission script

yaml_pathstr, required

Path to base version of yaml file containing arguments for the executable run in the SLURM job submission script

aliasesdict, optional

Map of configuration option names to maps of option values to string aliases

replacementsdict, optional

Map of yaml keys to default values, overriding those in yaml_path and configs

Description

Create job directories for all possible option value combinations from a map of option names to possible values. Each directory will contain an appropriately modified version of the supplied SLURM and yaml files.

saga.orchestrate.submit_jobs(configs, base_dir='./', submit_path='submit.sh', out_path='jobs.txt', aliases=None, dry_run=False)

Parameters

configsdict, required

Map of configuration option names to option values

base_dirstr, required

Path to directory in which to create job directories

submit_pathstr, required

Path to base version of SLURM job submission script

yaml_pathstr, required

Path to base version of yaml file containing arguments for the executable run in the SLURM job submission script

aliasesdict, optional

Map of configuration option names to maps of option values to string aliases

dry_runbool, optional

Option to just print commands to text file and not submit jobs via sbatch

Description

Submit jobs within a job directory structure created by orchestrate.create_jobs().