SLURM Demo - Revision history

Ajshen at 03:33, 29 June 2026

2026-06-29T03:33:09Z

← Older revision		Revision as of 03:33, 29 June 2026
Line 1:		Line 1:

			[[Category:Remote Server Access]]
			[[Category:Wright Cluster]]
			[[Category:PSC]]

	This page will walk you through submitting a job using SLURM. It will also cover basic Linux usage.		This page will walk you through submitting a job using SLURM. It will also cover basic Linux usage.

Jacobg2: /* Additional Information */

2025-08-27T17:36:44Z

Additional Information

← Older revision		Revision as of 17:36, 27 August 2025
Line 63:		Line 63:

	== Additional Information ==		== Additional Information ==
	~~Requesting Additional Resources~~

	SLURM allows you to request multiple CPU cores, a specified amount of RAM, and even GPUs if they are available. Requesting more than 1 CPU is especially important when paralyzing tasks.Below is an example submit script that shows how to declare each.		====== Requesting Additional Resources ======
			SLURM allows you to request multiple CPU cores, a specified amount of RAM, and even GPUs if they are available. Requesting more than 1 CPU is especially important when paralyzing tasks. Below is an example submit script that shows how to declare each.<syntaxhighlight lang="bash">
			!/bin/bash

	~~#!/bin/bash~~		SBATCH --partition selectedpartition
	#SBATCH --partition selectedpartition		SBATCH --ntasks 1
	#SBATCH --ntasks 1

	# number of CPUs you need:		##number of CPUs you need:
	#SBATCH --cpus-per-task 1		SBATCH --cpus-per-task 6

	# Amount of RAM in GB		##Amount of RAM in GB
	#SBATCH --mem 1G		SBATCH --mem 10G

	# Number of GPUs		##Number of GPUs
	#SBATCH --gres=gpu:1		SBATCH --gres=gpu:1
			</syntaxhighlight>For more information about SLURM, [https://info.stat.cmu.edu/index.php?title=Slurm visit this page here].

Jacobg2 at 17:33, 27 August 2025

2025-08-27T17:33:36Z

← Older revision		Revision as of 17:33, 27 August 2025
Line 60:		Line 60:
	cat nameofyourerrfile.err		cat nameofyourerrfile.err
	</syntaxhighlight>		</syntaxhighlight>


			== Additional Information ==
			Requesting Additional Resources

			SLURM allows you to request multiple CPU cores, a specified amount of RAM, and even GPUs if they are available. Requesting more than 1 CPU is especially important when paralyzing tasks.Below is an example submit script that shows how to declare each.

			#!/bin/bash
			#SBATCH --partition selectedpartition
			#SBATCH --ntasks 1

			# number of CPUs you need:
			#SBATCH --cpus-per-task 1

			# Amount of RAM in GB
			#SBATCH --mem 1G

			# Number of GPUs
			#SBATCH --gres=gpu:1

Jacobg2: /* 3 - Submit SLURM Job with an Error */

2025-08-27T17:26:07Z

3 - Submit SLURM Job with an Error

← Older revision		Revision as of 17:26, 27 August 2025
Line 55:		Line 55:
	#SBATCH --error=yourjoberrorfile_%j.err</syntaxhighlight>		#SBATCH --error=yourjoberrorfile_%j.err</syntaxhighlight>

	To see an example, ~~submit the~~ job ~~that has~~ a syntax error ~~in your SLURM demo directory~~.<syntaxhighlight lang="bash">		To see an example, run "submit_err.sh". This job runs a Python script with a syntax error.<syntaxhighlight lang="bash">
	sbatch submit_err.sh		sbatch submit_err.sh
	</syntaxhighlight>View the contents of the error output file.<syntaxhighlight lang="bash">		</syntaxhighlight>View the contents of the error output file.<syntaxhighlight lang="bash">
	cat nameofyourerrfile.err		cat nameofyourerrfile.err
	</syntaxhighlight>		</syntaxhighlight>

Jacobg2: /* 3 - Submit SLURM Job with an Error */

2025-08-27T16:55:32Z

3 - Submit SLURM Job with an Error

← Older revision		Revision as of 16:55, 27 August 2025
Line 52:		Line 52:
	In addition to the regular output file, SLURM produces a dedicated file that contains any errors in your script. In some cases this is the only file that will contain any output.		In addition to the regular output file, SLURM produces a dedicated file that contains any errors in your script. In some cases this is the only file that will contain any output.

	~~Modify~~ the error file in your own ~~submit~~.sh. <syntaxhighlight lang="bash">		Rename the error file in your own submit_err.sh. Modify the line shown below. <syntaxhighlight lang="bash">
	#SBATCH --error=yourjoberrorfile_%j.err</syntaxhighlight>		#SBATCH --error=yourjoberrorfile_%j.err</syntaxhighlight>

	To see an example, submit the job ~~with~~ a syntax error in your SLURM demo directory.<syntaxhighlight lang="bash">		To see an example, submit the job that has a syntax error in your SLURM demo directory.<syntaxhighlight lang="bash">
	sbatch submit_err.sh		sbatch submit_err.sh
	</syntaxhighlight>View the contents of the error output file.<syntaxhighlight lang="bash">		</syntaxhighlight>View the contents of the error output file.<syntaxhighlight lang="bash">
	cat nameofyourerrfile.err		cat nameofyourerrfile.err
	</syntaxhighlight>		</syntaxhighlight>

Jacobg2: /* 3 - Submit SLURM Job with an Error */

2025-08-27T16:53:21Z

3 - Submit SLURM Job with an Error

← Older revision		Revision as of 16:53, 27 August 2025
Line 51:		Line 51:
	====== This section will demonstrate submitting a job using SLURM that produces an error. ======		====== This section will demonstrate submitting a job using SLURM that produces an error. ======
	In addition to the regular output file, SLURM produces a dedicated file that contains any errors in your script. In some cases this is the only file that will contain any output.		In addition to the regular output file, SLURM produces a dedicated file that contains any errors in your script. In some cases this is the only file that will contain any output.

			Modify the error file in your own submit.sh. <syntaxhighlight lang="bash">
			#SBATCH --error=yourjoberrorfile_%j.err</syntaxhighlight>

	To see an example, submit the job with a syntax error in your SLURM demo directory.<syntaxhighlight lang="bash">		To see an example, submit the job with a syntax error in your SLURM demo directory.<syntaxhighlight lang="bash">
Line 57:		Line 60:
	cat nameofyourerrfile.err		cat nameofyourerrfile.err
	</syntaxhighlight>		</syntaxhighlight>

	~~Modify the error file in your own submit.sh. <syntaxhighlight lang="bash">~~
	~~#SBATCH --error=yourjoberrorfile_%j.err</syntaxhighlight>~~

Jacobg2: /* 1 - Copy SLURM Demo Files */

2025-08-27T16:52:59Z

1 - Copy SLURM Demo Files

← Older revision		Revision as of 16:52, 27 August 2025
Line 9:		Line 9:
	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
	ssh statdsuser@ood.stat.cmu.edu		ssh statdsuser@ood.stat.cmu.edu
	</syntaxhighlight>2 - Copy the SLURM ~~Demo~~ folder to your home directory. Do not run these files without moving them to your own working directory.<syntaxhighlight lang="bash">		</syntaxhighlight>2 - Copy the SLURM demo folder to your home directory. Do not run these files without moving them to your own working directory.<syntaxhighlight lang="bash">
	cp -r /share/slurmdemo ~/slurmdemo		cp -r /share/slurmdemo ~/slurmdemo
	</syntaxhighlight>3 - Navigate to your new SLURM Demo directory.<syntaxhighlight lang="bash">		</syntaxhighlight>3 - Navigate to your new SLURM Demo directory.<syntaxhighlight lang="bash">
Line 20:		Line 20:

	====== This section will demonstrate submitting a job using SLURM. ======		====== This section will demonstrate submitting a job using SLURM. ======
	1 - Modify the “submit_bash.sh” script. Make sure that you are in the correct directory that has the SLURM files from the section above.		1 - Modify the “submit_bash.sh” script. Make sure that you are in the correct directory that has the SLURM demo files from the section above.

	* ''You may use any text editor (vim, vi, nano, etc). In this example nano will be used.''<syntaxhighlight lang="bash">		* ''You may use any text editor (vim, vi, nano, etc). In this example nano will be used.''<syntaxhighlight lang="bash">
Line 37:		Line 37:
	3 - Run the submit script.<syntaxhighlight lang="bash">		3 - Run the submit script.<syntaxhighlight lang="bash">
	sbatch submit_bash.sh		sbatch submit_bash.sh
	</syntaxhighlight>4 - Once you submit your job, you can view the status of it by running the command below. This will show your jobs ~~olny~~.<syntaxhighlight lang="bash">		</syntaxhighlight>4 - Once you submit your job, you can view the status of it by running the command below. This will only show your jobs.<syntaxhighlight lang="bash">
	squeue -u $USER		squeue -u $USER
	</syntaxhighlight>5 - To view every running job, run the command below.<syntaxhighlight lang="bash">		</syntaxhighlight>5 - To view every running job, run the command below.<syntaxhighlight lang="bash">
Line 43:		Line 43:
	</syntaxhighlight>		</syntaxhighlight>

	6 - Once your job has finished, view the output file ~~once the script is finished~~. Use your unique output file name as modified in step 2.<syntaxhighlight lang="bash">		6 - Once your job has finished, view the contents of your output file. Use your unique output file name as modified in step 2.<syntaxhighlight lang="bash">
	cat yourjoboutputfile_%j.out		cat yourjoboutputfile_%j.out
	</syntaxhighlight>		</syntaxhighlight>

Jacobg2: /* This section will demonstrate submitting a job using SLURM that produces an error. */

2025-08-27T16:46:07Z

This section will demonstrate submitting a job using SLURM that produces an error.

← Older revision		Revision as of 16:46, 27 August 2025
Line 52:		Line 52:
	In addition to the regular output file, SLURM produces a dedicated file that contains any errors in your script. In some cases this is the only file that will contain any output.		In addition to the regular output file, SLURM produces a dedicated file that contains any errors in your script. In some cases this is the only file that will contain any output.

	To see an example, submit the job with a syntax error.<syntaxhighlight lang="bash">		To see an example, submit the job with a syntax error in your SLURM demo directory.<syntaxhighlight lang="bash">
	sbatch submit_err.sh		sbatch submit_err.sh
	</syntaxhighlight>View the contents of the error output file.<syntaxhighlight lang="bash">		</syntaxhighlight>View the contents of the error output file.<syntaxhighlight lang="bash">

Jacobg2 at 16:45, 27 August 2025

2025-08-27T16:45:19Z

← Older revision		Revision as of 16:45, 27 August 2025
Line 52:		Line 52:
	In addition to the regular output file, SLURM produces a dedicated file that contains any errors in your script. In some cases this is the only file that will contain any output.		In addition to the regular output file, SLURM produces a dedicated file that contains any errors in your script. In some cases this is the only file that will contain any output.

	~~Modify the error file in your own submit.sh. <syntaxhighlight lang="bash">~~		To see an example, submit the job with a syntax error.<syntaxhighlight lang="bash">
	~~#SBATCH --error=yourjoberrorfile_%j.err~~
	~~</syntaxhighlight>~~To see an example, submit the job with a syntax error.<syntaxhighlight lang="bash">
	sbatch submit_err.sh		sbatch submit_err.sh
	</syntaxhighlight>View the contents of the error output file.<syntaxhighlight lang="bash">		</syntaxhighlight>View the contents of the error output file.<syntaxhighlight lang="bash">
	cat nameofyourerrfile.err		cat nameofyourerrfile.err
	</syntaxhighlight>		</syntaxhighlight>

			Modify the error file in your own submit.sh. <syntaxhighlight lang="bash">
			#SBATCH --error=yourjoberrorfile_%j.err</syntaxhighlight>

Jacobg2: /* This section will demonstrate submitting a job using SLURM that produces an error. */

2025-08-27T16:39:02Z

This section will demonstrate submitting a job using SLURM that produces an error.

← Older revision		Revision as of 16:39, 27 August 2025
Line 50:		Line 50:

	====== This section will demonstrate submitting a job using SLURM that produces an error. ======		====== This section will demonstrate submitting a job using SLURM that produces an error. ======
			In addition to the regular output file, SLURM produces a dedicated file that contains any errors in your script. In some cases this is the only file that will contain any output.

			Modify the error file in your own submit.sh. <syntaxhighlight lang="bash">
			#SBATCH --error=yourjoberrorfile_%j.err
			</syntaxhighlight>To see an example, submit the job with a syntax error.<syntaxhighlight lang="bash">
			sbatch submit_err.sh
			</syntaxhighlight>View the contents of the error output file.<syntaxhighlight lang="bash">
			cat nameofyourerrfile.err
			</syntaxhighlight>