Learn R Programming

batchtools (version 0.9.0)

makeClusterFunctionsSlurm: ClusterFunctions for Slurm Systems

Description

Job files are created based on the brew template template.file. This file is processed with brew and then submitted to the queue using the sbatch command. Jobs are killed using the scancel command and the list of running jobs is retrieved using squeue. The user must have the appropriate privileges to submit, delete and list jobs on the cluster (this is usually the case).

The template file can access all resources passed to submitJobs as well as all variables stored in the JobCollection. It is the template file's job to choose a queue for the job and handle the desired resource allocations.

Note that you might have to specify the cluster name here if you do not want to use the default, otherwise the commands for listing and killing jobs will not work.

Usage

makeClusterFunctionsSlurm(template = findTemplateFile("slurm"),
  clusters = NULL)

Arguments

template
[character(1)] Path to a brew template file that can be used for the job description. Alternatively, the template as a single string (including at least one newline “\n”). Defaults to a heuristic which looks for a template file in the following locations and picks the first one found:
  1. “batchtools.slurm.tmpl” in the current working directory.
  2. “slurm.tmpl” in the user config directory (see user_config_dir); on linux is is usually “~/.config/batchtools/slurm.tmpl”.
  3. “.batchtools.slurm.tmpl” in the home directory.
  4. “slurm.default.tmpl” in the package installation directory in the subfolder “templates” (this probably does not exist for your cluster system or needs adaptation).
clusters
[character(1)] If multiple clusters are managed by one Slurm system, the name of one cluster has to be specified. If only one cluster is present, this argument may be omitted. Note that you should not select the cluster in your template file via #SBATCH --clusters.

Value

[ClusterFunctions].

See Also

Other ClusterFunctions: makeClusterFunctionsDocker, makeClusterFunctionsInteractive, makeClusterFunctionsLSF, makeClusterFunctionsMulticore, makeClusterFunctionsOpenLava, makeClusterFunctionsSGE, makeClusterFunctionsSSH, makeClusterFunctionsSocket, makeClusterFunctionsTorque, makeClusterFunctions