HPC

setJobOptions(options::Dict)

Set the default job options for use with SLURM.

Add every key-value pair in options to the global sbatch_options dictionary, i.e., add and/or overwrite the current sbatch options. A flag is then added to the sbatch command for each key-value pair in options: --key=value. When running simulations, any values in this dictionary that are Function's will be assumed to be functions of the simulation id.

defaultJobOptions()

Return a dictionary with default options for a job script for use with SLURM. See setJobOptions for setting these options and others.

Current defaults are:

• job-name: simulation_id -> "S$(simulation_id)" (use the simulation ID for the job name)
• mem: "1G" (1 GB of memory)

isRunningOnHPC()

Return true if the current environment is an HPC environment, false otherwise.

Currently, this function checks if the sbatch command is available, indicating a SLURM environment.

shellCommandExists(cmd::Union{String,Cmd})

Check if a shell command exists in the current environment.

useHPC([use::Bool=true])

Set the global variable run_on_hpc to use.

Examples

useHPC() # Set to true so `sbatch` is used for running simulations
useHPC(true) # set to true so `sbatch` is used for running simulations
useHPC(false) # Set to false so simulations are run locally