MATLAB-Sapelo2 - Revision history

Shtsai: /* Running Program */

2026-04-14T16:10:22Z

Running Program

← Older revision		Revision as of 12:10, 14 April 2026
Line 26:		Line 26:
	For more information on Environment Modules on Sapelo2 please see the [[Lmod]] page.		For more information on Environment Modules on Sapelo2 please see the [[Lmod]] page.

	* Version ~~R2023a~~ is installed in /apps/gb/MATLAB/~~R2023a~~. In order to use this version of MATLAB, please first load the matlab/~~R2023a~~ module with		* Version R2023b is installed in /apps/gb/MATLAB/R2023b. In order to use this version of MATLAB, please first load the matlab/R2023b module with
	<pre class="gcommand">		<pre class="gcommand">
	ml matlab/~~R2023a~~		ml matlab/R2023b
	</pre>		</pre>

Line 58:		Line 58:
	interact		interact

	ml matlab/~~R2023a~~		ml matlab/R2023b

	matlab -nodisplay		matlab -nodisplay
Line 67:		Line 67:
	interact -p abc_p -c 4 --mem 20gb		interact -p abc_p -c 4 --mem 20gb

	ml matlab/~~R2023a~~		ml matlab/R2023b

	matlab -nodisplay		matlab -nodisplay
Line 105:		Line 105:
	cd $SLURM_SUBMIT_DIR		cd $SLURM_SUBMIT_DIR

	ml matlab/~~R2023a~~		ml matlab/R2023b

	matlab -nodisplay < matrixinv.m		matlab -nodisplay < matrixinv.m
Line 125:		Line 125:
	cd $SLURM_SUBMIT_DIR		cd $SLURM_SUBMIT_DIR

	ml matlab/~~R2023a~~		ml matlab/R2023b

	echo 'functionname(arg1,arg2)' \| matlab -nodisplay -nosplash		echo 'functionname(arg1,arg2)' \| matlab -nodisplay -nosplash
Line 166:		Line 166:
	cd $SLURM_SUBMIT_DIR		cd $SLURM_SUBMIT_DIR

	ml matlab/~~R2023a~~		ml matlab/R2023b

	matlab -nodisplay < psine.m		matlab -nodisplay < psine.m
Line 195:		Line 195:
	===Parallel Computing - Using cores from one or more compute nodes ===		===Parallel Computing - Using cores from one or more compute nodes ===

	In order to use the Parallel Computing toolbox to run MATLAB using either cores on a single node, or to use cores on multiple nodes, you need to configure MATLAB and create a new cluster profile. To do this, please login to Sapelo2, start an interactive session with <code>interact</code>, load the matlab module you want to use and start matlab. For example, to configure this for matlab/~~R2023a~~:		In order to use the Parallel Computing toolbox to run MATLAB using either cores on a single node, or to use cores on multiple nodes, you need to configure MATLAB and create a new cluster profile. To do this, please login to Sapelo2, start an interactive session with <code>interact</code>, load the matlab module you want to use and start matlab. For example, to configure this for matlab/R2023b:
	<pre class="gcommand">		<pre class="gcommand">
	interact		interact

	ml matlab/~~R2021a~~		ml matlab/R2023b

	matlab -nodisplay		matlab -nodisplay
Line 245:		Line 245:
	cd $SLURM_SUBMIT_DIR		cd $SLURM_SUBMIT_DIR

	ml matlab/~~R2023a~~		ml matlab/R2023b

	matlab -nodisplay < psine.m		matlab -nodisplay < psine.m

Shtsai: /* Version */

2026-04-14T16:06:14Z

Version

← Older revision		Revision as of 12:06, 14 April 2026
Line 10:		Line 10:
	== Version ==		== Version ==

	~~R2023a,~~ R2023b		R2023b

	== Author / Distributor ==		== Author / Distributor ==

Shtsai at 01:05, 5 April 2026

2026-04-05T01:05:08Z

← Older revision		Revision as of 21:05, 4 April 2026
Line 1:		Line 1:
	[[Category:Sapelo2]][[Category:Software]][[Category:Other]][[Category:Programming]][[Category:Graphics]]		[[Category:Sapelo2]][[Category:Software]][[Category:Other]][[Category:Programming]][[Category:Graphics]]
	=== Category ===		== Category ==

	Other, Programming, Graphics		Other, Programming, Graphics

	=== Program On ===		== Program On ==

	Sapelo2		Sapelo2

	=== Version ===		== Version ==

	R2023a, R2023b		R2023a, R2023b

	=== Author / Distributor ===		== Author / Distributor ==

	The MathWorks (see http://www.mathworks.com)		The MathWorks (see http://www.mathworks.com)

	=== Description ===		== Description ==

	MATLAB is a high-level technical computing language and interactive environment for algorithm development, data visualization, data analysis, and numeric computation.		MATLAB is a high-level technical computing language and interactive environment for algorithm development, data visualization, data analysis, and numeric computation.

	=== Running Program ===		== Running Program ==

	Also refer to [[Running Jobs on Sapelo2]]		Also refer to [[Running Jobs on Sapelo2]]
Line 32:		Line 32:


	====Running MATLAB interactively====		===Running MATLAB interactively===

	Please do not run MATLAB interactively on the Sapelo2 login node, instead please run it using the [[Running_Jobs_on_Sapelo2#How_to_open_an_interactive_session \| interactive partition]] (without GUI) or using [[OnDemand]] (with GUI).		Please do not run MATLAB interactively on the Sapelo2 login node, instead please run it using the [[Running_Jobs_on_Sapelo2#How_to_open_an_interactive_session \| interactive partition]] (without GUI) or using [[OnDemand]] (with GUI).
Line 74:		Line 74:
	For more information on how to run interactive jobs, please see [[Running_Jobs_on_Sapelo2#How_to_open_an_interactive_session \| interactive partition]]		For more information on how to run interactive jobs, please see [[Running_Jobs_on_Sapelo2#How_to_open_an_interactive_session \| interactive partition]]

	====Running MATLAB as a batch job====		===Running MATLAB as a batch job===

	MATLAB can also be run as a batch job, for example in the batch partition. To do this, first create a MATLAB M-file with the MATLAB commands. Then use a job submission file to submit this job to the batch partition.		MATLAB can also be run as a batch job, for example in the batch partition. To do this, first create a MATLAB M-file with the MATLAB commands. Then use a job submission file to submit this job to the batch partition.
Line 135:		Line 135:
	</pre>		</pre>

	====Parallel Computing - Using multiple CPU cores on a single compute node ====		===Parallel Computing - Using multiple CPU cores on a single compute node ===

	The Parallel Computing toolbox allows a user to use many CPU cores. If you want to use cores on the same node for the job you can use the <code>defaultProfile</code>. Here is a simple example using the '''parfor''' loop with 24 MATLAB workers.		The Parallel Computing toolbox allows a user to use many CPU cores. If you want to use cores on the same node for the job you can use the <code>defaultProfile</code>. Here is a simple example using the '''parfor''' loop with 24 MATLAB workers.
Line 193:		Line 193:
	-->		-->

	====Parallel Computing - Using cores from one or more compute nodes ====		===Parallel Computing - Using cores from one or more compute nodes ===

	In order to use the Parallel Computing toolbox to run MATLAB using either cores on a single node, or to use cores on multiple nodes, you need to configure MATLAB and create a new cluster profile. To do this, please login to Sapelo2, start an interactive session with <code>interact</code>, load the matlab module you want to use and start matlab. For example, to configure this for matlab/R2023a:		In order to use the Parallel Computing toolbox to run MATLAB using either cores on a single node, or to use cores on multiple nodes, you need to configure MATLAB and create a new cluster profile. To do this, please login to Sapelo2, start an interactive session with <code>interact</code>, load the matlab module you want to use and start matlab. For example, to configure this for matlab/R2023a:
Line 256:		Line 256:
	</pre>		</pre>

	====Using a MATLAB client installed on your local machine to run jobs on the cluster====		===Using a MATLAB client installed on your local machine to run jobs on the cluster===

	In order to use a MATLAB client installed on your local machine and have it offload work onto the cluster (Sapelo2), you will need to first install some cluster integration files on your local machine. Please note that you need to have the same version of MATLAB client installed on your local machine, as the MATLAB version you will use on the cluster.		In order to use a MATLAB client installed on your local machine and have it offload work onto the cluster (Sapelo2), you will need to first install some cluster integration files on your local machine. Please note that you need to have the same version of MATLAB client installed on your local machine, as the MATLAB version you will use on the cluster.
Line 289:		Line 289:
	</pre>		</pre>

	====Configuring Jobs from within MATLAB on the cluster or on your local machine====		===Configuring Jobs from within MATLAB on the cluster or on your local machine===
	Prior to having MATLAB submit a job to the cluster, we can specify various parameters to pass to our jobs, such as partition, e-mail, walltime, etc. The WallTime, MemUsage, and QueueName (partition name) fields are mandatory in order to submit a job.		Prior to having MATLAB submit a job to the cluster, we can specify various parameters to pass to our jobs, such as partition, e-mail, walltime, etc. The WallTime, MemUsage, and QueueName (partition name) fields are mandatory in order to submit a job.

Line 343:		Line 343:
	</pre>		</pre>

	====Submitting Independent Batch Jobs from within locally installed MATLAB====		===Submitting Independent Batch Jobs from within locally installed MATLAB===
	Use the <code>batch</code> command to submit asynchronous jobs to the cluster. Users can either run a single function or a Matlab script as a batch job. You must make sure the script is in the MATLAB path. If running MATLAB locally, the command <code>userpath</code> displays the location you can save your .m scripts. See the MATLAB documentation for <code>userpath</code> if you would like to add directories to that path. Since your local file system is different from the worker file system(Sapelo2), if you are submitting jobs to Sapelo 2 from local MATLAB you also have to set the 'AutoAddClientPath' option to false. The <code>batch</code> command will return a job object which is used to access the output of the submitted job. See the MATLAB documentation for more help on <code>batch</code>.		Use the <code>batch</code> command to submit asynchronous jobs to the cluster. Users can either run a single function or a Matlab script as a batch job. You must make sure the script is in the MATLAB path. If running MATLAB locally, the command <code>userpath</code> displays the location you can save your .m scripts. See the MATLAB documentation for <code>userpath</code> if you would like to add directories to that path. Since your local file system is different from the worker file system(Sapelo2), if you are submitting jobs to Sapelo 2 from local MATLAB you also have to set the 'AutoAddClientPath' option to false. The <code>batch</code> command will return a job object which is used to access the output of the submitted job. See the MATLAB documentation for more help on <code>batch</code>.

Line 399:		Line 399:
	</pre>		</pre>

	====Submitting Parallel Batch Jobs from within locally installed MATLAB====		===Submitting Parallel Batch Jobs from within locally installed MATLAB===
	Users can also submit parallel workflows with the <code>batch</code> command. Let’s use the following example for a parallel job, which is saved as ''parallel_example.m''.		Users can also submit parallel workflows with the <code>batch</code> command. Let’s use the following example for a parallel job, which is saved as ''parallel_example.m''.

Line 480:		Line 480:
	The job now runs in 4.73 seconds using eight workers. Run code with different number of workers to determine the ideal number to use.		The job now runs in 4.73 seconds using eight workers. Run code with different number of workers to determine the ideal number to use.

	==== Parallel Interactive Jobs using MATLAB on the cluster ====		=== Parallel Interactive Jobs using MATLAB on the cluster ===
	To run an interactive pool job on the cluster, continue to use parpool as you’ve done before. Start an interactive session with qlogin (or with srun), load the matlab module and start MATLAB with <code>matlab -nodislay</code>. In Matlab, run		To run an interactive pool job on the cluster, continue to use parpool as you’ve done before. Start an interactive session with qlogin (or with srun), load the matlab module and start MATLAB with <code>matlab -nodislay</code>. In Matlab, run

Line 504:		Line 504:
	</pre>		</pre>

	====Debugging a MATLAB job====		===Debugging a MATLAB job===
	If a serial job produces an error, call the <code>getDebugLog</code> method to view the error log file. When submitting independent jobs, with multiple tasks, specify the task number.		If a serial job produces an error, call the <code>getDebugLog</code> method to view the error log file. When submitting independent jobs, with multiple tasks, specify the task number.

Line 523:		Line 523:
	</pre>		</pre>

	=== Documentation ===		== Documentation ==

	MATLAB documentation is available at https://www.mathworks.com/help/matlab/		MATLAB documentation is available at https://www.mathworks.com/help/matlab/
Line 538:		Line 538:
	*[http://www.mathworks.com/products/parallel-computing/webinars.html Parallel Computing Webinars]		*[http://www.mathworks.com/products/parallel-computing/webinars.html Parallel Computing Webinars]

	=== Installation ===		== Installation ==

	'''Version 2023a'''		'''Version 2023a'''
Line 547:		Line 547:


	=== System ===		== System ==
	64-bit Linux		64-bit Linux

Moses: /* Running MATLAB as a batch job */

2024-12-10T21:39:54Z

Running MATLAB as a batch job

← Older revision		Revision as of 17:39, 10 December 2024
Line 78:		Line 78:
	MATLAB can also be run as a batch job, for example in the batch partition. To do this, first create a MATLAB M-file with the MATLAB commands. Then use a job submission file to submit this job to the batch partition.		MATLAB can also be run as a batch job, for example in the batch partition. To do this, first create a MATLAB M-file with the MATLAB commands. Then use a job submission file to submit this job to the batch partition.

	~~Sample~~ MATLAB M-file (matrixinv.m):		Below is sample MATLAB M-file (matrixinv.m), which is a MATLAB script:
	<pre class="gscript">		<pre class="gscript">
	n = 500;		n = 500;
Line 112:		Line 112:
	The parameters of the job, such as the maximum wall clock time, maximum memory, email address, the number of cores per task, and the job name need to be modified appropriately.		The parameters of the job, such as the maximum wall clock time, maximum memory, email address, the number of cores per task, and the job name need to be modified appropriately.

	If you are calling a main function defined in a M-file, for example, functionname.m, you might have to use a sample script like this:		If you are calling a main function defined in a MATLAB M-file, for example, functionname.m, you might have to use a sample script like this:
	<pre class="gscript">		<pre class="gscript">
	#!/bin/bash		#!/bin/bash
Line 128:		Line 128:

	echo 'functionname(arg1,arg2)' \| matlab -nodisplay -nosplash		echo 'functionname(arg1,arg2)' \| matlab -nodisplay -nosplash

	</pre>		</pre>

Moses: /* Running Program */

2024-12-10T21:36:21Z

Running Program

← Older revision		Revision as of 17:36, 10 December 2024
Line 89:		Line 89:
	err = norm(z-x)		err = norm(z-x)
	res = norm(A*z-b)		res = norm(A*z-b)

	</pre>		</pre>

	Sample job submission script file (sub.sh) to run a serial (single-core) ~~matlab program~~:		Sample job submission script file (sub.sh) to run a serial (single-core) matrixinv.m:

	<pre class="gscript">		<pre class="gscript">
Line 113:		Line 112:
	The parameters of the job, such as the maximum wall clock time, maximum memory, email address, the number of cores per task, and the job name need to be modified appropriately.		The parameters of the job, such as the maximum wall clock time, maximum memory, email address, the number of cores per task, and the job name need to be modified appropriately.

	If you are ~~using functions~~, you might have to use a sample script like this:		If you are calling a main function defined in a M-file, for example, functionname.m, you might have to use a sample script like this:
	<pre class="gscript">		<pre class="gscript">
	#!/bin/bash		#!/bin/bash

Moses: /* Running MATLAB as a batch job */

2024-12-10T21:31:42Z

Running MATLAB as a batch job

← Older revision		Revision as of 17:31, 10 December 2024
Line 128:		Line 128:
	ml matlab/R2023a		ml matlab/R2023a

	echo functionname \| matlab -nodisplay -nosplash		echo 'functionname(arg1,arg2)' \| matlab -nodisplay -nosplash

	</pre>		</pre>

Chelsea: /* Version */

2024-05-13T16:32:06Z

Version

← Older revision		Revision as of 12:32, 13 May 2024
Line 10:		Line 10:
	=== Version ===		=== Version ===

	R2023a ~~(9.14.0.2286388)~~		R2023a, R2023b

	=== Author / Distributor ===		=== Author / Distributor ===

Shtsai at 13:54, 25 September 2023

2023-09-25T13:54:40Z

← Older revision		Revision as of 09:54, 25 September 2023
Line 10:		Line 10:
	=== Version ===		=== Version ===

	~~R2022b (9.13.0.2080170),~~ R2023a (9.14.0.2286388)		R2023a (9.14.0.2286388)

	=== Author / Distributor ===		=== Author / Distributor ===
Line 25:		Line 25:

	For more information on Environment Modules on Sapelo2 please see the [[Lmod]] page.		For more information on Environment Modules on Sapelo2 please see the [[Lmod]] page.

	* Version R2022b is installed in /apps/gb/MATLAB/R2022b. In order to use this version of MATLAB, please first load the matlab/R2022b module with
	~~<pre class="gcommand">~~
	~~ml matlab/R2022b~~
	~~</pre>~~

	* Version R2023a is installed in /apps/gb/MATLAB/R2023a. In order to use this version of MATLAB, please first load the matlab/R2023a module with		* Version R2023a is installed in /apps/gb/MATLAB/R2023a. In order to use this version of MATLAB, please first load the matlab/R2023a module with
Line 252:		Line 247:
	cd $SLURM_SUBMIT_DIR		cd $SLURM_SUBMIT_DIR

	ml matlab/~~R2021a~~		ml matlab/R2023a

	matlab -nodisplay < psine.m		matlab -nodisplay < psine.m
Line 269:		Line 264:
	The Sapelo2 MATLAB support package can be found on Sapelo2, at the following location:		The Sapelo2 MATLAB support package can be found on Sapelo2, at the following location:

	'''For ~~R2021a~~'''		'''For R2023a'''

	Windows: /apps/gb/MATLAB/UGA.nonshared.~~R2021a~~.zip		Windows: /apps/gb/MATLAB/UGA.nonshared.R2023a.zip

	Linux/macOS: /apps/gb/MATLAB/UGA.nonshared.~~R2021a.tar.gz~~		Linux/macOS: /apps/gb/MATLAB/UGA.nonshared.R2023a.tar.gz


	~~'''For R2021b'''~~

	~~Windows: /apps/gb/MATLAB/UGA.nonshared.R2021b.zip~~

	~~Linux/macOS: /apps/gb/MATLAB/UGA.nonshared.R2021b~~.tar.gz


Line 541:		Line 529:
	MATLAB documentation is available at https://www.mathworks.com/help/matlab/		MATLAB documentation is available at https://www.mathworks.com/help/matlab/

	Some documentation and sample files are available on Sapelo2, in /apps/gb/MATLAB/~~R2021a~~/help		Some documentation and sample files are available on Sapelo2, in /apps/gb/MATLAB/R2023a/help

	To learn more about the MATLAB Parallel Computing Toolbox, check out these resources:		To learn more about the MATLAB Parallel Computing Toolbox, check out these resources:
Line 553:		Line 541:

	=== Installation ===		=== Installation ===

	~~'''Version 2021a'''~~

	~~Installed in /apps/gb/MATLAB/R2021a.~~

	~~Available toolboxes: Almost all toolboxes for which UGA has a license. For details, see the directories in /apps/gb/MATLAB/R2021a/toolbox~~


	~~'''Version 2022b'''~~

	~~Installed in /apps/gb/MATLAB/R2022b.~~

	~~Available toolboxes: Almost all toolboxes for which UGA has a license. For details, see the directories in /apps/gb/MATLAB/R2022b/toolbox~~


	'''Version 2023a'''		'''Version 2023a'''

Shtsai: /* Parallel Computing - Using cores from one or more compute nodes */

2023-09-05T16:51:44Z

Parallel Computing - Using cores from one or more compute nodes

← Older revision		Revision as of 12:51, 5 September 2023
Line 252:		Line 252:
	cd $SLURM_SUBMIT_DIR		cd $SLURM_SUBMIT_DIR

	ml matlab/~~R2023a~~		ml matlab/R2021a

	matlab -nodisplay < psine.m		matlab -nodisplay < psine.m

Shtsai: /* Parallel Computing - Using cores from one or more compute nodes */

2023-09-05T16:51:24Z

Parallel Computing - Using cores from one or more compute nodes

← Older revision		Revision as of 12:51, 5 September 2023
Line 206:		Line 206:
	interact		interact

	ml matlab/~~R2023a~~		ml matlab/R2021a

	matlab -nodisplay		matlab -nodisplay