Job script generator for Slurm

This site assists in creating job scripts for the Slurm workload manager.
This tool is currently experimental at U-M and does not yet perform input validation or bounds checking, although future versions will.
Please send input or feedback to hpc-support@umich.edu
For more details about migrating to Slurm please see our Torque to Slurm guide.
Enter the details of your job in the form below and then click on the make script button below.
After the script is made, you can copy and paste to another file or use the download button to save a local copy as a plain text file.

Select cluster using button or follow documentation link to learn more greatlakes (documentation)
lighthouse (documentation)

Job Name

It is a good idea to give your job a meaningful name. This will help you identify it when listing the job queue.

Account

Specify the account to which this job should be charged. For example, "training" or "lsa". To see a list of your accounts run "my_accounts"

Job Type

Single Core

Suitable for single CPU core jobs only (not parallel).

Single Node (Multithreaded or SMP)

Suitable for shared-memory multithreaded jobs. Note: these jobs cannot use more than one node and cannot use more cores than the number of cores on a node.

Multiple Node (MPI)

Suitable for distributed parallel jobs that use MPI. May use more than one cluster node.

Enter the maximum number of CPU cores needed by your job.

Memory in Gigabytes

Single Core and Single Node jobs

For Single Core and Single Node jobs this is the total memory allocated for the job, irrespective of the number of CPU cores. If you leave this blank then your job will be allocated 1 gigabyte of memory.

Multiple Node

For Multiple Node jobs this specifies the amount of memory allocated to each CPU core requested by the job. The total memory used is equal to the number of cores in the job multiplied by the amount of memory requested. If you leave this blank then your job will be allocated 1 gigabyte per CPU core.

For example if you request 2 CPU cores and 4GB of memory per core, the total memory used by the job is 8GB.

Email

Send yourself an email when the job:

starts running
ends successfully
ends with an error

Use this email address:

You can be notified by email when your job starts running or when it ends (either successfully or with an error).

You can specify an address to receive the email. If you leave it blank the email will be sent to your umich email address associated with your user login.

Walltime

Days

Hours

Minutes

Enter the maximum amount of time needed by your whole job. On greatlakes this should not exceed 14 days (336 hours).

Directory

Run the job from:

The same directory where it is launched.
Your home directory.
The directory with this name:

Each job is run from a given directory on the computer's filesystem - this is called the working directory in Unix terminology.

You need to set the working directory correctly so that your job can find its input files and generate its output files in the appropriate location.

In most cases it is desirable to set this to the directory where the job was launched, but you might also like it to be your home directory, or from some other specific directory on the computer.

If you specify the directory, it must be an absolute reference (i.e. /home/uniqname/mydir) or relative to the launch directory.

Modules

Enter the modules that you would like to load:

The modules utility sets up your Unix environment for particular versions of specified programs. It is possible to use more than one module in your job (just list all the ones you need on separate lines).

For example to use version 3.2 of the application foo, you should load the module called: foo/3.2

Alternatively, consider adding your frequently used software to your default module set To see a full listing of the cluster software use "module spider" or reference the software pages at: https://arc-ts.umich.edu/software/

Command

Enter the command (or commands) that you want to run, one per line.

Note: MPI jobs need to prefix the command with either srun or mpirun as appropriate.

The job script

Click on the button to make your script. If you change any of the values in the form above you can re-generate the script by clicking the button again.