User Tools

Site Tools


matlab_usage

Back To Main Page

Matlab Details and Tips

Default startup.m settings

If you need to replace the default CfN settings in your startup.m file, see /share/admin/matlab-startup-common.m on chead.

Matlab Search Path

To customize the Matlab search path, change your ~/matlab/startup.m file, or use the MATLABPATH environment variable:

https://www.mathworks.com/help/matlab/matlab_env/add-folders-to-matlab-search-path-at-startup.html

Add the definition to your ~/.bash_profile file to have it load whenever you login.

Matlab via qsub batch jobs

You may need to run Matlab scripts in a qsub job. It's fairly easy. This command will run a series of Matlab commands from the command line (shell), which we can use in a qsub job script:

matlab -nodisplay -r "a=[1 2 3]; disp(a); disp(a+1); exit" 

Explanation:

  • -nodisplay - this option tells Matlab to run in command-line mode, i.e. with no GUI windows
  • -r - this option tells Matlab to run the follow text as commands. This could be just the name of the matlab script (.m file) you want to run, for example. This text is the same as you would enter on the command line in the Matlab GUI window. Put a semicolon between commands.
  • exit - add 'exit' as the last command (e.g. after calling your matlab script) to make sure matlab exits when the script is finished

So if you put the above text in a file called matlabjob and run:

qsub matlabjob

you'll get the following output in your matlabjob.o<jobid> file (where <jobid> will be the job id of your run of qsub):

                                                < M A T L A B (R) >
                                      Copyright 1984-2013 The MathWorks, Inc.
                                        R2013a (8.1.0.604) 64-bit (glnxa64)
                                                 February 15, 2013

 
To get started, type one of these: helpwin, helpdesk, or demo.
For product information, visit www.mathworks.com.
 
   1     2     3

   2     3     4
   

Parallel-processing / Multi-threading Considerations

Matlab is known to be greedy about how many CPU cores it uses. When it sees, for example, 16 cores on the machine where it's running, it will generally use 16 threads for its own code that is multi-threaded. The cluster will automatically set the number of threads for matlab to use according to how many cores/slots you requested for your job. This is done in two ways:

  • Single core/slot: a wrapper around the 'matlab' routine will pass the -singleCompThread option to matlab at startup. This is a reliable way to ensure you only use one thread in matlab.
  • Multiple cores/slots: your startup.m file calls a script that uses maxNumCompThreads to set the number of threads to match the number of cores/slots for your job. However, this is unreliable because matlab will ignore this in some cases - see below.

WARNING If you notice matlab running very slowly during heavy computation (e.g. much slower than when you prototyped on your own machine), it may be because matlab is using more threads than you have cores/slots assigned to your job.

In this case, the slowdown happens because SGE 'binds' your job to a set number of cores on the compute node so it doesn't take more computing resources than it's been allocated. But matlab sees more cores on the node so allocates more computational threads. These threads then are all competing on a smaller number of cores for processing time and memory access, slowing things down.

What to do: you should request more cores to lessen the computational bottleneck. Anecdotally, 4-8 cores may relieve the problem. Or, you can request a single core for your job, and matlab will be put into single-thread mode and will not try to use multiple computational threads. This latter approach is particularly good for large batch jobs.

See more discussion in details of parallel processing.

Parallel Toolbox Considerations

Number of Workers

When using Matlab's Parallel Toolbox, you generally must specify the number of workers to match the number of SGE slots requested by your job. To programmatically retrieve the number of slots/cores you requested for the current job, you can use the NSLOTS shell environment variable, or the matlab 'maxNumCompThreads' command.

NOTE: Your jobs (qsub or qlogin) run on a single compute node for easier parallel processing, and each compute node has only 16 cores. So you don't want to ask for more than 16 slots (and thus matlab workers) for a job. But also note that asking for 16 slots meaning waiting for a compute node to be completely free before you can start your job.

NOTE: 'Workers' is not the same as 'number of threads'. Workers are like mini jobs that process something. By default they each use one thread/core. Implicit multithreading in Matlab is controlled (although not very reliably) by maxNumCompThreads, for inherently parallel operations like matrix multiplication.

See more discussion in details of parallel processing.

Issue with MATLABPOOL in Multiple Matlab sessions

Why am I unable to start a local MATLABPOOL from multiple MATLAB sessions that use
a shared preference directory using Parallel Computing Toolbox?

See the discussion here, and in particular the solution provided in the comment by Andreas.

matlab_usage.txt · Last modified: 2018/02/06 20:44 by mgstauff