# Difference between revisions of "Matlab"

(58 intermediate revisions by 7 users not shown) | |||

Line 1: | Line 1: | ||

− | + | {|align=right | |

+ | |__TOC__ | ||

+ | |} | ||

__NOEDITSECTION__ | __NOEDITSECTION__ | ||

− | [[Category:Software]] | + | [[Category:Software]][[Category:Language]][[Category:Math]] |

{|<!--Main settings - REQUIRED--> | {|<!--Main settings - REQUIRED--> | ||

|{{#vardefine:app|matlab}} | |{{#vardefine:app|matlab}} | ||

Line 7: | Line 9: | ||

|{{#vardefine:exe|1}} <!--Present manual instructions for running the software --> | |{{#vardefine:exe|1}} <!--Present manual instructions for running the software --> | ||

|{{#vardefine:conf|}} <!--Enable config wiki page link - {{#vardefine:conf|1}} = ON/conf|}} = OFF--> | |{{#vardefine:conf|}} <!--Enable config wiki page link - {{#vardefine:conf|1}} = ON/conf|}} = OFF--> | ||

− | |{{#vardefine: | + | |{{#vardefine:job|1}} <!--Enable job script wiki page link--> |

|{{#vardefine:policy|}} <!--Enable policy section --> | |{{#vardefine:policy|}} <!--Enable policy section --> | ||

|{{#vardefine:testing|}} <!--Enable performance testing/profiling section --> | |{{#vardefine:testing|}} <!--Enable performance testing/profiling section --> | ||

Line 22: | Line 24: | ||

You can use MATLAB in a wide range of applications, including signal and image processing, communications, control design, test and measurement, financial modeling and analysis, and computational biology. For a million engineers and scientists in industry and academia, MATLAB is the language of technical computing. | You can use MATLAB in a wide range of applications, including signal and image processing, communications, control design, test and measurement, financial modeling and analysis, and computational biology. For a million engineers and scientists in industry and academia, MATLAB is the language of technical computing. | ||

<!--Modules--> | <!--Modules--> | ||

− | == | + | ==Environment Modules== |

− | + | Run <code>module spider matlab</code> or <code>module spider mcr</code> to find out what environment modules are available for the MatLab GUI and for the Matlab Compiler Runtime. Use matlab for compiling your code and mcr for running it. The mcr does not consume matlab licenses. | |

− | == | + | |

− | + | ==Restrictions== | |

+ | MatLab install on HiPerGator is restricted to the toolboxes available under the UF license. The full list of ineligible toolboxes is on the MATLAB website: [https://www.mathworks.com/support/requirements/product-requirements-platform-availability-list.html MATLAB Add-On Availability] | ||

+ | |||

+ | Run <code>matlab_show_license_use</code> after loading a matlab module to see what licenses are available and how many are in use. | ||

+ | |||

==System Variables== | ==System Variables== | ||

− | * HPC_{{ | + | * HPC_{{uc:{{#var:app}}}}_DIR - installation directory |

<!--Additional--> | <!--Additional--> | ||

− | |||

− | |||

{{#if: {{#var: conf}}|==Configuration== | {{#if: {{#var: conf}}|==Configuration== | ||

See the [[{{PAGENAME}}_Configuration]] page for {{#var: app}} configuration details. | See the [[{{PAGENAME}}_Configuration]] page for {{#var: app}} configuration details. | ||

|}} | |}} | ||

− | |||

− | |||

{{#if: {{#var: policy}}|==Usage Policy== | {{#if: {{#var: policy}}|==Usage Policy== | ||

WRITE USAGE POLICY HERE (perhaps templates for a couple of main licensing schemes can be used) | WRITE USAGE POLICY HERE (perhaps templates for a couple of main licensing schemes can be used) | ||

Line 49: | Line 51: | ||

|}} | |}} | ||

==Policies== | ==Policies== | ||

− | # You may not run MatLab nor compiled MatLab executables interactively on | + | # You may not run MatLab nor compiled MatLab executables interactively on the login servers. |

− | + | # Long running (more than 30 minutes) MatLab jobs need to be in compiled form and must be submitted to the batch system. | |

− | # Long running (more than 30 minutes) MatLab jobs | + | # UF Research Computing has no budget for application software and licensing. All MatLab licenses (including the compiler) come from, and are shared with, all of UF campus. For this reason it is sometimes difficult to obtain a license or MatLab may take a long time to start. If your research depends on MatLab and you do not want to be delayed by licensing issues, you should consider purchasing a MatLab license for your personal or group use. |

− | + | ||

− | # | + | ==Available components== |

+ | See the [[Matlab add-ons]] for a full list of licensed Matlab components. | ||

==Compiling MatLab Programs== | ==Compiling MatLab Programs== | ||

− | MatLab programs must be compiled via the MatLab compiler before they can be run in batch mode on | + | MatLab programs must be compiled via the MatLab compiler before they can be run in batch mode on HiPerGator. In order to compile MatLab programs you should |

− | In order to compile MatLab programs you should | ||

− | + | # See [[Development and Testing]] page to learn how to get an interactive developmental session on HiPerGator under SLURM. | |

− | + | # Set up your environment so that the libraries needed by the compiler can be found. | |

− | + | #*<pre>module load matlab</pre> | |

− | + | #*'''Note:''' The module load command should be included in your batch submission script as well since your compiled matlab executable will also need to find the appropriate dynamically loaded libraries. | |

− | '''Note:''' The module load command should be included in your batch submission script as well since your compiled matlab executable will also need to find the appropriate dynamically loaded libraries. | + | # Compile your matlab program (.m) files using the MatLab compiler. |

− | + | #*<pre>mcc -R -singleCompThread -m some_prog.m</pre> | |

− | + | #*'''Note:''' The "<code>-R -singleCompThread</code>" options on the mcc command line will result in a '''single-threaded''' executable. By default, multi-threading is enabled in executables produced by mcc. The result is that one computational thread will be started for each processor in a machine that runs your executable. That's not usually what you want. Unless you know what you are doing and intend to take advantage of multithreading (including requesting the appropriate resources in your submission script) you should use these options and generate a '''single-threaded''' executable. | |

− | |||

− | |||

− | |||

− | |||

− | |||

− | |||

− | |||

− | |||

− | |||

===Example=== | ===Example=== | ||

+ | <div class="mw-collapsible mw-collapsed" style="width:70%; padding: 5px; border: 1px solid gray;"> | ||

+ | ''Expand this section to view Matlab example.'' | ||

+ | <div class="mw-collapsible-content" style="padding: 5px;"> | ||

Let us say that we have a program such as that below in a source file named houdini.m | Let us say that we have a program such as that below in a source file named houdini.m | ||

− | < | + | <pre> |

function [m,t] = houdini(); | function [m,t] = houdini(); | ||

% Doc example, chapter 3. | % Doc example, chapter 3. | ||

Line 87: | Line 83: | ||

t = m .^ 3; % Cube each element of m. | t = m .^ 3; % Cube each element of m. | ||

disp(t); % Display the value of t. | disp(t); % Display the value of t. | ||

− | </ | + | </pre> |

Since we already have the environment setup, we can compile this program. It is recommended that this be done in a separate directory as a number of files are produced. | Since we already have the environment setup, we can compile this program. It is recommended that this be done in a separate directory as a number of files are produced. | ||

− | < | + | <pre> |

mkdir tmp | mkdir tmp | ||

cd tmp | cd tmp | ||

Line 95: | Line 91: | ||

module load matlab | module load matlab | ||

mcc -R -singleCompThread -m houdini.m | mcc -R -singleCompThread -m houdini.m | ||

− | + | ls -l | |

− | |||

− | |||

total 124 | total 124 | ||

-rwxr-xr-x 1 root root 12299 Apr 3 10:08 houdini | -rwxr-xr-x 1 root root 12299 Apr 3 10:08 houdini | ||

Line 109: | Line 103: | ||

-rwxr--r-- 1 root root 1446 Apr 3 10:08 run_houdini.sh | -rwxr--r-- 1 root root 1446 Apr 3 10:08 run_houdini.sh | ||

</pre> | </pre> | ||

− | The MatLab executable '''houdini''' has been generated. | + | The MatLab executable '''houdini''' has been generated, and can be run by typing ./houdini, or by putting that command in a batch submission script. |

+ | </div></div> | ||

+ | ---- | ||

+ | [http://www.mathworks.com/access/helpdesk/help/toolbox/compiler MatLab Compiler Documentation] can be found on the MatLab Website. | ||

+ | |||

+ | ==MATLAB GUI use on HiPerGator== | ||

+ | |||

+ | If you must use the Graphical User Interface for MatLab follow the [[Matlab GUI Example]] documentation, or options in [[GUI Programs]] | ||

+ | |||

+ | ==MATLAB online training== | ||

+ | Please see the Pre-recorded [https://training.it.ufl.edu/training/items/running-matlab-on-hipergator.html MATLAB on HiPerGator Training session] for information on using MATLAB on HiPerGator. | ||

+ | |||

+ | Mathworks also has a number of free [https://www.mathworks.com/services/training.html online training resources]. | ||

− | |||

− | |||

− | |||

− | + | ==Compiled DLL== | |

− | + | If you have compiled a MatLab DLL to use as an executable, it will not run on the cluster. DLL's are Microsoft Windows based dynamically linked libraries that will only work under the Windows operating system. | |

− | |||

− | If you have compiled a DLL to use as an executable, it will not run on the cluster. DLL's are Microsoft Windows based dynamically linked libraries that will only work under the Windows operating system. | ||

− | + | ==Setting a Command Path== | |

− | + | To set a command path in your MatLab program, should add the following code. | |

<pre> | <pre> | ||

− | path(path, '/path/to/ | + | path(path, '/path/to/matlab/binaries') |

</pre> | </pre> | ||

− | This | + | This will add the specified directory to the matlab search path. For more information see the [http://www.mathworks.com/access/helpdesk/help/techdoc/index.html?/access/helpdesk/help/techdoc/ref/path.html&http://www.google.com/search?hl=en&q=matlab+set+path&btnG=Google+Search&aq=f&oq= Matlab] web site. |

==Known Issues== | ==Known Issues== | ||

+ | <div class="mw-collapsible mw-collapsed" style="width:70%; padding: 5px; border: 1px solid gray;"> | ||

+ | ''Expand this section to view common troubleshooting steps.'' | ||

+ | <div class="mw-collapsible-content" style="padding: 5px;"> | ||

===No Licenses Available=== | ===No Licenses Available=== | ||

You may run into an error when using the MatLab compiler such as | You may run into an error when using the MatLab compiler such as | ||

Line 133: | Line 137: | ||

'''Licensed number of users already reached.''' | '''Licensed number of users already reached.''' | ||

− | If so, the number of licenses available for the MatLab compiler has been exceeded. There are only two shared among the entire university so you should expect to see this problem from time to time if you use the MatLab compiler frequently. | + | If so, the number of licenses available for the MatLab compiler has been exceeded. There are only two shared among the entire university so you should expect to see this problem from time to time if you use the MatLab compiler frequently. If the problem persists for more than a few hours, please open a [https://support.rc.ufl.edu support request]. |

===MCR_CACHE_ROOT Directory=== | ===MCR_CACHE_ROOT Directory=== | ||

'''Could not access the MCR component cache''' | '''Could not access the MCR component cache''' | ||

− | This error message means that MatLab is not able to access the MCR cache directory | + | This error message means that MatLab is not able to access the MCR cache directory. When you load the MATLAB module, MCR_CACHE_ROOT is set for you, and you should not encounter this error. If you do, please open a [https://support.rc.ufl.edu support request]. For batch jobs, module load matlab makes use of the $TMPDIR variable and MCR_CACHE_ROOT is set to $TMPDIR/mcr_cache. For non-batch jobs, MCR_CACHE_ROOT is set to /scratch/local/$USER/mcr_cache |

− | + | ||

− | ==Interactive Use== | + | ===Interactive Use=== |

− | See [[ | + | See the GUI section above for information on running the MATLAB GUI on HiPerGator. |

+ | |||

+ | Some Windows users running Xming have reported problems with MATLAB becoming unresponsive, especially after saving a new file. If you run into this problem, we suggest using an alternate X11 server, such as [http://mobaxterm.mobatek.net/ MobaXterm]. Please open a [http://support.rc.ufl.edu support request] if you continue to experience problems. | ||

+ | |||

+ | ===Older Versions=== | ||

+ | In order to use older versions of Matlab that are installed on the cluster, you can list them via the following command: | ||

+ | <pre> | ||

+ | $ module spider matlab | ||

+ | </pre> | ||

+ | If you were to see that an older version of matlab is available, such as version r2012a, you would then load the appropriate module for that version: | ||

+ | <pre> | ||

+ | $ module load matlab/2012a | ||

+ | </pre> | ||

+ | </div></div> |

## Latest revision as of 14:17, 7 April 2023

## Description

MATLAB is a programming environment for algorithm development, data analysis, visualization, and numerical computation. Using MATLAB, you can solve technical computing problems faster than with traditional programming languages, such as C, C++, and Fortran.

You can use MATLAB in a wide range of applications, including signal and image processing, communications, control design, test and measurement, financial modeling and analysis, and computational biology. For a million engineers and scientists in industry and academia, MATLAB is the language of technical computing.

## Environment Modules

Run `module spider matlab`

or `module spider mcr`

to find out what environment modules are available for the MatLab GUI and for the Matlab Compiler Runtime. Use matlab for compiling your code and mcr for running it. The mcr does not consume matlab licenses.

## Restrictions

MatLab install on HiPerGator is restricted to the toolboxes available under the UF license. The full list of ineligible toolboxes is on the MATLAB website: MATLAB Add-On Availability

Run `matlab_show_license_use`

after loading a matlab module to see what licenses are available and how many are in use.

## System Variables

- HPC_MATLAB_DIR - installation directory

## Policies

- You may not run MatLab nor compiled MatLab executables interactively on the login servers.
- Long running (more than 30 minutes) MatLab jobs need to be in compiled form and must be submitted to the batch system.
- UF Research Computing has no budget for application software and licensing. All MatLab licenses (including the compiler) come from, and are shared with, all of UF campus. For this reason it is sometimes difficult to obtain a license or MatLab may take a long time to start. If your research depends on MatLab and you do not want to be delayed by licensing issues, you should consider purchasing a MatLab license for your personal or group use.

## Available components

See the Matlab add-ons for a full list of licensed Matlab components.

## Compiling MatLab Programs

MatLab programs must be compiled via the MatLab compiler before they can be run in batch mode on HiPerGator. In order to compile MatLab programs you should

- See Development and Testing page to learn how to get an interactive developmental session on HiPerGator under SLURM.
- Set up your environment so that the libraries needed by the compiler can be found.
module load matlab

**Note:**The module load command should be included in your batch submission script as well since your compiled matlab executable will also need to find the appropriate dynamically loaded libraries.

- Compile your matlab program (.m) files using the MatLab compiler.
mcc -R -singleCompThread -m some_prog.m

**Note:**The "`-R -singleCompThread`

" options on the mcc command line will result in a**single-threaded**executable. By default, multi-threading is enabled in executables produced by mcc. The result is that one computational thread will be started for each processor in a machine that runs your executable. That's not usually what you want. Unless you know what you are doing and intend to take advantage of multithreading (including requesting the appropriate resources in your submission script) you should use these options and generate a**single-threaded**executable.

### Example

*Expand this section to view Matlab example.*

Let us say that we have a program such as that below in a source file named houdini.m

function [m,t] = houdini(); % Doc example, chapter 3. % Copyright 1997 The MathWorks, Inc. % $Revision: 1.1.6.1 $ m = magic(2); % Assign 2x2 matrix to m. t = m .^ 3; % Cube each element of m. disp(t); % Display the value of t.

Since we already have the environment setup, we can compile this program. It is recommended that this be done in a separate directory as a number of files are produced.

mkdir tmp cd tmp cp ../houdini.m . module load matlab mcc -R -singleCompThread -m houdini.m ls -l total 124 -rwxr-xr-x 1 root root 12299 Apr 3 10:08 houdini -rw-r--r-- 1 root root 63146 Apr 3 10:08 houdini.ctf -rw-r--r-- 1 root root 239 Apr 3 10:06 houdini.m -rw-r--r-- 1 root root 2900 Apr 3 10:08 houdini_main.c -rw-r--r-- 1 root root 6328 Apr 3 10:08 houdini_mcc_component_data.c -rw-r--r-- 1 root root 5461 Apr 3 10:08 houdini.prj -rw-r--r-- 1 root root 1010 Apr 3 10:08 mccExcludedFiles.log -rw-r--r-- 1 root root 6757 Apr 3 10:08 readme.txt -rwxr--r-- 1 root root 1446 Apr 3 10:08 run_houdini.sh

The MatLab executable **houdini** has been generated, and can be run by typing ./houdini, or by putting that command in a batch submission script.

MatLab Compiler Documentation can be found on the MatLab Website.

## MATLAB GUI use on HiPerGator

If you must use the Graphical User Interface for MatLab follow the Matlab GUI Example documentation, or options in GUI Programs

## MATLAB online training

Please see the Pre-recorded MATLAB on HiPerGator Training session for information on using MATLAB on HiPerGator.

Mathworks also has a number of free online training resources.

## Compiled DLL

If you have compiled a MatLab DLL to use as an executable, it will not run on the cluster. DLL's are Microsoft Windows based dynamically linked libraries that will only work under the Windows operating system.

## Setting a Command Path

To set a command path in your MatLab program, should add the following code.

path(path, '/path/to/matlab/binaries')

This will add the specified directory to the matlab search path. For more information see the Matlab web site.

## Known Issues

*Expand this section to view common troubleshooting steps.*

### No Licenses Available

You may run into an error when using the MatLab compiler such as

**Licensed number of users already reached.**

If so, the number of licenses available for the MatLab compiler has been exceeded. There are only two shared among the entire university so you should expect to see this problem from time to time if you use the MatLab compiler frequently. If the problem persists for more than a few hours, please open a support request.

### MCR_CACHE_ROOT Directory

**Could not access the MCR component cache**

This error message means that MatLab is not able to access the MCR cache directory. When you load the MATLAB module, MCR_CACHE_ROOT is set for you, and you should not encounter this error. If you do, please open a support request. For batch jobs, module load matlab makes use of the $TMPDIR variable and MCR_CACHE_ROOT is set to $TMPDIR/mcr_cache. For non-batch jobs, MCR_CACHE_ROOT is set to /scratch/local/$USER/mcr_cache

### Interactive Use

See the GUI section above for information on running the MATLAB GUI on HiPerGator.

Some Windows users running Xming have reported problems with MATLAB becoming unresponsive, especially after saving a new file. If you run into this problem, we suggest using an alternate X11 server, such as MobaXterm. Please open a support request if you continue to experience problems.

### Older Versions

In order to use older versions of Matlab that are installed on the cluster, you can list them via the following command:

$ module spider matlab

If you were to see that an older version of matlab is available, such as version r2012a, you would then load the appropriate module for that version:

$ module load matlab/2012a