Panel |
---|
borderColor | #EBECF0 |
---|
bgColor | #FAFBFC |
---|
titleColor | black |
---|
borderWidth | 4 |
---|
titleBGColor | #FAFBFC |
---|
borderStyle | solid |
---|
title | Page Content |
---|
|
|
MATLAB Modules
On Linux Cluster, you may list all available MATLAB versions:
Codeblock |
---|
|
> module avail matlab |
MATLAB can be used by loading its module. We highly recommend to choose a particular – better: the newest – version.
Supported Releases of MATLAB and MATLAB Compiler Runtime
MATLAB Release (Patch level) | MATLAB Compiler Runtime | Comment |
---|
R2020a |
Codeblock |
---|
| > module remove intel-mpi
> module load intel-mpi/2018-intel
> module load matlab/R2020a-generic |
|
Codeblock |
---|
| > module remove intel-mpi
> module load intel-mpi/2018-intel
> module load matlab-mcr/R2020a-generic |
| R2020a |
Warnung |
---|
Using the default Intel-MPI module (Version 2019), unintended crashes of parallel MATLAB jobs might occur. Please switch to Intel MPI 2018. |
|
R2019b (Update 5)
|
Codeblock |
---|
| > module load matlab/R2019b_Update5-generic |
|
Codeblock |
---|
| > module load matlab-mcr/R2019b-generic |
| R2019b | recommended version |
R2019a (Update 7) |
Codeblock |
---|
| > module load matlab/R2019a_Update7-generic |
|
Codeblock |
---|
| > module load matlab-mcr/R2019a-generic |
| R2019a |
|
Trouble Loading MATLAB Module
Warnung |
---|
icon | false |
---|
title | The MATLAB module is not visible and cannot be loaded |
---|
|
Check your module environment by listing currently loaded modules. As part of LRZ software stack MATLAB is provided via Spack. A Spack module should be loaded. If not, check for available Spack modules and load the newest module. In order to get access to the list of supported MATLAB releases, you have to load the Spack module spack/release/20.1. Codeblock |
---|
| > module list # list loaded modules
> module avail spack # show all available Spack modules
> module avail spack/release # show available Spack modules (releases only)
> module switch spack/release/20.1 # load Spack (example)
> module avail matlab # check for MATLAB |
|
Hinweis |
---|
title | Fall back to old MATLAB installation |
---|
|
You may also load old installations of MATLAB via an old Spack module. This might be helpful for particular use cases. But, this is a fallback solution! Old software stacks are not supported anymore! Some MATLAB features might not work because setup of MATLAB installation does not match updated system configurations, among others.
|
Useful MATLAB Commands
Run MATLAB via the "matlab" command only or add command-line arguments. Please consider: All MATLAB command-line arguments are case-sensitive!
Codeblock |
---|
|
> matlab arg_1 ... arg_N |
Command-line argument | Meaning |
---|
no argument | Start MATLAB GUI. |
-nodesktop | Start MATLAB without desktop but allow GUI and graphics output. |
-nodisplay | Start MATLAB without any GUI support. |
-singleCompThread | Some intrinsic MATLAB functions automatically exploit multithreading. MATLAB can be forced to disable this feature.
Warnung |
---|
Use this option for any work on the login nodes! |
|
-r myfunc | Run a MATLAB script or function, e. g. myfunc.m. |
Interactive MATLAB Jobs in a Nutshell – the Convenient Way
Usecases
Depending on the purpose, there are different possibilities to use MATLAB interactively:
- MATLAB computations with focus on visualisation: We recommend to use our Remote Visualisation System.
- Pure MATLAB computations: Interactive MATLAB sessions may be started on compute nodes of CoolMUC-2 or CoolMUC-3 by employing interactive Slurm jobs (see Slurm documentation).
Constraints
- Interactive jobs depend on the availability of compute resources. Matlab may not start immediately.
- Matlab will run on 1 compute node.
- The time limit is set to 2 hours (= maximum time for interactive Slurm sessions).
How to Use it
Load desired MATLAB module.
For convenience, load the interactive-MATLAB module in order to use the loaded MATLAB version:
Codeblock |
---|
|
> # use CoolMUC-2:
> module load matlab-inter/coolmuc-2
>
> # use CoolMUC-3:
> module load matlab-inter/coolmuc-3 |
Start interactive MATLAB session. This command will implicitly submit an interactive Slurm job. Probably you have to wait if the interactive partition is fully occupied.
- Exiting MATLAB session will automatically finish the Slurm job.
Common Batch Jobs
Batch jobs are used for all MATLAB production runs. Usually, the resources, consumed by MATLAB applications, are limited to a single CPU core (pure serial job) or a single compute node (parallel job involving either multithreading or the Parallel Computing Toolbox [PCT]). Following table lists job examples for various cases which can be used on CoolMUC-2.
Slurm job script | Matlab script |
---|
Serial batch job Warnung |
---|
No parallelization at all, MATLAB is intended to run on a single core. Please use the "serial" cluster of the Linux Cluster! |
|
---|
Codeblock |
---|
language | bash |
---|
title | matmul_serial.slurm |
---|
linenumbers | true |
---|
collapse | true |
---|
| #!/bin/bash
#SBATCH -o ./out/%x.%j.%N.out
#SBATCH -e ./out/%x.%j.%N.err
#SBATCH -D ./
#SBATCH -J matlab_serial_batch_job
#SBATCH --get-user-env
#SBATCH --export=NONE
#SBATCH --clusters=serial
#SBATCH --partition=serial_std
#SBATCH --nodes=1
#SBATCH --tasks-per-node=1
#SBATCH --cpus-per-task=1
#SBATCH --mem=10000M
#SBATCH --time=0:30:00
# As needed, remove/adjust memory requirement "--mem" in MB
module load slurm_setup
module load matlab/R2019b_Update5-generic
# Example: matrix-matrix multiplication C = A*B
# with A of size NROWA x NCOLA and
# B of size NROWB x NCOLB
NROWA=1000
NCOLA=2000
NROWB=2000
NCOLB=5000
# Run MATLAB
# => Using option -r don't add file extension .m to the function call!
# => MATLAB commandline arguments are case-sensitive!
matlab -nodisplay -singleCompThread \
-r "matmul_serial([$NROWA $NCOLA], [$NROWB $NCOLB]);" |
|
Codeblock |
---|
language | text |
---|
title | matmul_serial.m |
---|
linenumbers | true |
---|
collapse | true |
---|
| function [C, comptime] = matmul_serial(size_A, size_B)
%===============================================================================
% MATLAB EXAMPLE: SERIAL HELLO WORLD
% -> matrix-matrix multiplication C = A*B
%
% INPUT
% size_A, size_B ... 2-element row vectors defining sizes of A and B
% OUTPUT
% C ................ result
% comptime ......... computation time (matrix product only)
%===============================================================================
%===============================================================================
% Check input
%===============================================================================
if nargin~=2
error('Invalid number of input arguments!');
end
if size_A(2)~=size_B(1)
error(sprintf('Dimension mismatch of A (%d columns) and B (%d rows)!',...
size_A(2), size_B(1)));
end
%===============================================================================
% Work
%===============================================================================
% Hello message from compute node
fprintf('Hello from MATLAB process PID=%d running on node %s!\n',...
feature('getpid'),...
strtrim(evalc('system(''hostname'');')));
% generate well-defined matrices
NA = prod(size_A);
NB = prod(size_B);
A = reshape( linspace( 1,NA, NA), size_A );
B = reshape( linspace(NB, 1, NB), size_B );
% compute
tic;
C = A*B;
comptime = toc;
fprintf('serial computation of matrix-matrix product:\n');
fprintf('\ttime = %.2f s\n', comptime); |
|
Parallel job using multithreading Warnung |
---|
MATLAB will run on a single compute node. Please use the partition "cm2_tiny" in cluster "cm2_tiny"!
|
|
---|
Codeblock |
---|
language | bash |
---|
title | matmul_mthread.slurm |
---|
linenumbers | true |
---|
collapse | true |
---|
| #!/bin/bash
#SBATCH -o ./out/%x.%j.%N.out
#SBATCH -e ./out/%x.%j.%N.err
#SBATCH -D ./
#SBATCH -J matlab_threading_batch_job
#SBATCH --get-user-env
#SBATCH --export=NONE
#SBATCH --clusters=cm2_tiny
#SBATCH --partition=cm2_tiny
#SBATCH --nodes=1
#SBATCH --tasks-per-node=1
#SBATCH --cpus-per-task=14
#SBATCH --time=00:30:00
module load slurm_setup
module load matlab/R2019b_Update5-generic
# Example: matrix-matrix multiplication C = A*B
# with A of size NROWA x NCOLA and
# B of size NROWB x NCOLB
NROWA=1000
NCOLA=2000
NROWB=2000
NCOLB=5000
# Run MATLAB
# => Using option -r don't add file extension .m to the function call!
# => MATLAB commandline arguments are case-sensitive!
matlab -nodisplay \
-r "matmul_mthread([$NROWA $NCOLA], [$NROWB $NCOLB]);" |
|
Codeblock |
---|
language | text |
---|
title | matmul_mthread.m |
---|
linenumbers | true |
---|
collapse | true |
---|
| function [C, comptime] = parallel_mthread(size_A, size_B)
%===============================================================================
% MATLAB EXAMPLE: PARALLEL HELLO WORLD USING MULTITHREADING
% -> matrix-matrix multiplication C = A*B
%
% INPUT
% size_A, size_B ... 2-element row vectors defining sizes of A and B
% OUTPUT
% C ................ result
% comptime ......... computation time (matrix product only)
%===============================================================================
%===============================================================================
% Check input
%===============================================================================
if nargin~=2
error('Invalid number of input arguments!');
end
if size_A(2)~=size_B(1)
error(sprintf('Dimension mismatch of A (%d columns) and B (%d rows)!',...
size_A(2), size_B(1)));
end
%===============================================================================
% Manage multithreading
%===============================================================================
% Get number of threads depending on job type (batch job or interactive job).
% In batch jobs 1 MATLAB task will use "nw" threads.
%
% obtain number of threads from Slurm environment variables
cluster = getenv('SLURM_CLUSTER_NAME');
if strcmp(cluster, 'inter')
% interactive job
nw = str2num(getenv('SLURM_JOB_CPUS_PER_NODE'));
elseif strcmp(cluster, 'cm2_tiny') || ...
strcmp(cluster, 'mpp3') || ...
strcmp(cluster, 'ivymuc')
% batch job
nw = str2num(getenv('SLURM_CPUS_PER_TASK'));
else
% default
nw = 1;
end
% set threads
maxNumCompThreads(nw);
%===============================================================================
% Work
%===============================================================================
fprintf('Hello from MATLAB process PID=%d running on node %s!\n',...
feature('getpid'),...
strtrim(evalc('system(''hostname'');')));
% generate well-defined matrices
NA = prod(size_A);
NB = prod(size_B);
A = reshape( linspace( 1,NA, NA), size_A );
B = reshape( linspace(NB, 1, NB), size_B );
% compute
tic;
C = A*B;
comptime = toc;
fprintf('parallel computation (multithreading) of matrix-matrix product:\n');
fprintf('\tnumber of threads = %d\n', nw);
fprintf('\ttime = %.2f s\n', comptime); |
|
Parallel batch job using Parallel Computing Toolbox (PCT) Warnung |
---|
MATLAB will run on a single compute node. Please use the partition "cm2_tiny" in cluster "cm2_tiny"!
|
|
---|
Codeblock |
---|
language | bash |
---|
title | matmul_pct.slurm |
---|
linenumbers | true |
---|
collapse | true |
---|
| #!/bin/bash
#SBATCH -o ./out/%x.%j.%N.out
#SBATCH -e ./out/%x.%j.%N.err
#SBATCH -D ./
#SBATCH -J matlab_pct_batch_job
#SBATCH --get-user-env
#SBATCH --export=NONE
#SBATCH --clusters=cm2_tiny
#SBATCH --partition=cm2_tiny
#SBATCH --nodes=1
#SBATCH --tasks-per-node=4
#SBATCH --cpus-per-task=1
#SBATCH --time=00:30:00
# IMPORTANT
# Default settings of Intel MPI module may disrupt
# functionality of Parallel-Computing-Toolbox!
# Do one of the following solutions:
# (1) Unload module mpi.intel:
module rm mpi.intel
# (2) If Intel MPI module is mandatory, add next line
# export KMP_AFFINITY=granularity=thread,none
module load slurm_setup
module load matlab/R2019b_Update5-generic
# Example: matrix-matrix multiplication C = A*B
# with A of size NROWA x NCOLA and
# B of size NROWB x NCOLB
NROWA=1000
NCOLA=2000
NROWB=2000
NCOLB=5000
# Run MATLAB
# => Using option -r don't add file extension .m to the function call!
# => MATLAB commandline arguments are case-sensitive!
matlab -nodisplay -singleCompThread \
-r "matmul_pct([$NROWA $NCOLA], [$NROWB $NCOLB]);" |
|
Codeblock |
---|
language | text |
---|
title | matmul_pct.m |
---|
linenumbers | true |
---|
collapse | true |
---|
| function [Cglob, comptime] = matmul_pct(size_A, size_B)
%===============================================================================
% MATLAB EXAMPLE: PARALLEL HELLO WORLD USING PCT TOOLBOX
% -> matrix-matrix multiplication C = A*B
%
% INPUT
% size_A, size_B ... 2-element row vectors defining sizes of A and B
% OUTPUT
% C ................ result
% comptime ......... computation time (matrix product only)
%===============================================================================
%===============================================================================
% Check input
%===============================================================================
if nargin~=2
error('Invalid number of input arguments!');
end
if size_A(2)~=size_B(1)
error(sprintf('Dimension mismatch of A (%d columns) and B (%d rows)!',...
size_A(2), size_B(1)));
end
%===============================================================================
% Verify that no parallel pool is initialized by creating/deleting a dummy pool
%===============================================================================
if ~isempty(gcp('nocreate'))
poolobj = gcp('nocreate');
delete(poolobj);
end
%===============================================================================
% Start parallel pool
%===============================================================================
% Get number of workers depending on job type. Start parallel pool via "local"
% cluster object.
%
% obtain number of tasks from Slurm environment variables
cluster = getenv('SLURM_CLUSTER_NAME');
if strcmp(cluster, 'inter')
% interactive job
nw = str2num(getenv('SLURM_JOB_CPUS_PER_NODE'));
elseif strcmp(cluster, 'cm2_tiny') || ...
strcmp(cluster, 'serial') || ...
strcmp(cluster, 'mpp3') || ...
strcmp(cluster, 'ivymuc')
% batch job
nw = str2num(getenv('SLURM_NTASKS'));
else
% default
nw = 1;
end
% disallow Threading
if maxNumCompThreads > 1
maxNumCompThreads(1);
warning('MultiThreading: number of threads has been set to 1!');
end
% create a local cluster object
pc = parcluster('local');
% set number of workers
pc.NumWorkers = nw;
% set the JobStorageLocation to SCRATCH (default: HOME -> not recommended)
pc.JobStorageLocation = strcat(getenv('SCRATCH'));
% start the parallel pool
poolobj = parpool(pc, nw);
%===============================================================================
% Work
%===============================================================================
spmd
fprintf('Hello from MATLAB process PID=%d running on node %s!\n',...
feature('getpid'),...
getenv('HOSTNAME'));
end
% generate well-defined matrices
NA = prod(size_A);
NB = prod(size_B);
A = reshape( linspace( 1,NA, NA), size_A );
B = reshape( linspace(NB, 1, NB), size_B );
% distribute data to workers and do parallel computation
spmd
Aloc = codistributed(A, codistributor2dbc([nw 1]));
Bloc = codistributed(B, codistributor2dbc([1 nw]));
tic;
Cloc = Aloc*Bloc;
t = toc;
end
comptime = max(cell2mat(t(:)));
fprintf('parallel computation (MPI) of matrix-matrix product:\n');
fprintf('\tnumber of tasks (MATLAB workers) = %d\n', nw);
fprintf('\ttime = %.2f s\n', comptime);
Cglob = gather(Cloc);
%===============================================================================
% Close parallel pool
%===============================================================================
delete(poolobj); |
|