All three clusters, Puma, Ocelote, and ElGato, use SLURM as a job scheduler rather than PBS Pro. SLURM has several advantages:
- It provides more robust support for a larger number of jobs in queue.
- It is used by national HPC groups (XSEDE and TACC) making it easier for users to scale out to those systems.
- It has more sustainable support.
Allocations and Job Partitions (Queues)
Using SLURM is similar to using PBS. Users will still receive a monthly allocation of CPU hours associated with their PI's group that will be deducted when they run their jobs in standard. Users will also be able to use windfall to run jobs without consuming their monthly allocations. Jobs run using windfall will be subject to preemption when resources are requested by higher-priority jobs.
To request a specific partition (standard, windfall, or high_priority), see Job Partition Requests below.
This table shows the resources available in each node that are used in the Slurm script:
Compute Resources then Example Resource Requests
Modules and Software
The process of finding, loading, and using software as modules will not change on the new system. Users will still be able to utilize the standard commands described in the Software section in our User Guide. However, in a departure from our previous systems, modules are not available to load and utilize on the login nodes. To load, use, and test software for job submissions, users will need to request an interactive session. Interactive sessions may be requested by simply using the command "interactive" (see section below).
When you are on a login node, you can request an interactive session on a compute node. This is useful for checking available modules, testing submission scripts, compiling software, and running programs directly from the command line. To get an interactive session, we have a built in command that will allow you to quickly and easily do so by simply entering:
Submitting this actually runs the following:
salloc --job-name=interactive --mem-per-cpu=4GB --nodes=1 --ntasks=1 --time=01:00:00 --account=windfall --partition=windfall
If you find that this session is insufficient,
interactive has built-in customization flags. For example, if you want to get a session faster, add your PI's account name to use the standard partition:
interactive -a account_name
Are you using X11 forwarding?
interactive -a account_name -x
interactive [-x] [-N nodes] [-n ncpus per node] [-Q optional qos] [-t hh::mm:ss] [-a account to charge]
Any time you submit an
interactive command, it will always print the full salloc being executed for verification and copying/editing/pasting.
To request a GPU, you will include the resource name using the
--gres SLURM directive. For example, if you wanted to request an interactive session with one GPU, you could run:
salloc --job-name=interactive --mem-per-cpu=4GB --nodes=1 --ntasks=1 --time=01:00:00 --account=windfall --partition=windfall --gres=gpu:1
In a batch script, you would include the number of GPUs as an SBATCH directive. For example:
In both cases above, the jobs are requesting 1 GPU. This number can be increased up to 4 on Puma and 2 on Ocelote depending on the number of GPUs you need for your workflow.
Note that on Ocelote there are two models of GPU's, K80 and P100. If you don't specify which one, you could get either. So for ocelote, we recommend:
High Memory Nodes
Puma has two high memory nodes available with 3TB of RAM each. These nodes have a ratio of 32GB of RAM per CPU, so a job requesting N CPUs would be allocated N*32GB of RAM. To request one, you may either explicitly set
--constraint=hi_mem in your job script. For example, the following directives:
#SBATCH --ntasks=1 #SBATCH --cpus-per-task=5 #SBATCH --mem-per-cpu=32gb
would run a job on one of the high memory nodes with 160GB of RAM. The following would request identical resources:
#SBATCH --ntasks=1 #SBATCH --cpus-per-task=5 #SBATCH --constraint=hi_mem
PBS → SLURM Rosetta Stone
In general, SLURM can translate and execute scripts written for PBS. This means that if you submit a PBS script written for Ocelote or ElGato on Puma (with the necessary resource request modifications), your script will likely run. However, there are a few caveats that should be noted:
- You will need to submit your job with the new SLURM command, e.g.
- There may be some PBS directives that do not directly translate to SLURM which cannot be interpreted
- The environment variables specific to PBS and SLURM are different. If your job relies on these, you will need to update them. Common examples are
To get acquainted with the new scheduling system, refer to the following list of common PBS commands, directives, and environment variables and their SLURM counterparts. For a PDF version, click here.
|Batch submission of jobs to run without user input|
|Request an interactive job|
|Submit a job for realtime execution. Can also be used to submit an interactive session|
|Show all jobs|
|Check status of a specific job|
|Check status of jobs specific to user|
|Check history of a completed job|
|Delete a specific job|
|Delete all user jobs|
|View information about nodes and queues|
|Places a hold on a job to prevent it from being executed|
|Releases a hold placed on a job allowing it to be executed|
|Specify group name where hours are charged|
|Set job queue|
|Set job walltime|
Select N nodes
|PBS: Select N cpus|
SLURM: Each task is assume to require one cpu. Optionally, you may include cpus-per-task if more are required. Requests NxM cpus
Note: Puma has 94 cpus available on each node
|Select N gb of memory per node|
|Select N gb of memory per cpu|
Note: Puma defaults to 5GB per cpu
|Array job submissions where N and M are integers|
|Optional: Request a GPU|
|Optional: Set job name|
|Optional: Combine stdout and error|
|Optional: Separate stdout and stderr |
(SLURM: %j is a stand-in for $SLURM_JOB_ID)
|Optional: Standard output filename|
|Optional: Error filename|
|Optional: Combine all output into single file. Note: If this is selected, each job run will append to that filename, including preexisting files with that name|
|Optional: Export single environment variable var to job|
|Optional: Export all environment variables to job|
|Optional: Do not export working environment to job|
|Optional: Request email notifications|
Beware of mail bombing yourself
|Optional: email address used for notifications|
|Optional: Request exclusive access to node|
|Job submission directory|
|Index to differentiate tasks in an array|
|Hostname where job was submitted|
|List of nodes allocated to current job|
SLURM partition requests are slightly different from PBS. Use the following table as a guide for how to use the partition that is relevant to you:
|standard||Consumes your group's standard allocation.|
|windfall||Does not consume your group's standard allocation. Jobs may be interrupted and restarted by higher-priority jobs. The |
|high_priority||Available for groups who have purchased compute resources. The partition flag is left as standard and requires the additional |
SLURM Output Filename Patterns
Unlike PBS, SLURM offers ways to make your job's output filenames more customizable through the use of character replacements. A table is provided below as a guide with some examples. Variables may be used or combined as desired. Note: character replacements may also be used with other SBATCH directives such as error filename, input filename, and job name.
|Variable||Meaning||Example Slurm Directive(s)||Output|
|A job array's main job ID||12345.out|
|A job array's index number||12345_1.out|
|Job ID plus stepid||12345.out|
|Hostname of the first compute node allocated to the job||r1u11n1.out|
Single serial job submission
When submitting jobs with named output files (i.e. with the line #SBATCH -o=Job.out) as arrays, SLURM will write every array element to that filename leaving you with only the output of the last completed job in the array. Use one of the following SLURM directives in your script to prevent this behavior:
Differentiates output files using array indices. Similar to PBS default. See SLURM Output Filename Patterns above for more information.
Code Block language bash theme Confluence
Appends the output from all tasks in an array to the same output file. Warning: if a file exists with that name prior to running your job, the output will be appended to that file
Code Block language bash theme Confluence
For openmpi the important variables are set by default, so you do not need to include them in your scripts.
export SBATCH_GET_USER_ENV=1 export OMPI_MCA_btl_openib_cpc_include=rdmacm export OMPI_MCA_btl_openib_if_include=bnxt_re1 export OMPI_MCA_btl_openib_rroce_enable=1 export OMPI_MCA_btl=vader,self,openib export OMPI_MCA_oob_tcp_if_include=eth1
For Intel MPI, these variables are set for you:
export I_MPI_FABRICS=shm:ofi export FI_PROVIDER=verbs export FI_VERBS_IFACE=eth1
If you're using Intel MPI with mpirun and are getting errors, try replacing
mpirun -np $NPROCESSES with:
srun -n $NPROCESSES --mpi=pmi2