You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Use MATLAB® Package Manager (`mpm`) to install MATLAB, Simulink®, and other MathWorks® products or support packages from the operating system command line.
4
4
5
-
MATLAB® Package Manager (`mpm`) is a command-line package manager for installing MATLAB, Simulink®, and other MathWorks® products or support packages.
5
+
To get `mpm`for Linux, Windows, or macOS, see [Get MATLAB Package Manager](https://www.mathworks.com/help/install/ug/get-mpm-os-command-line.html).
6
6
7
-
To get started:
8
-
1. Download `mpm` for your operating system: [Linux](#linux) | [Windows](#windows) | [macOS](#macos)
9
-
2. Run `mpm` from the command line or from a Dockerfile.
10
-
11
-
## Download MATLAB Package Manager
12
-
### Linux
13
-
Verify that this required software is installed:
14
-
* All third-party packages required to run the `mpm` command: `ca-certificates`
15
-
* All MATLAB dependencies. To view the list of dependencies, in the [MATLAB Dependencies](https://github.com/mathworks-ref-arch/container-images/tree/master/matlab-deps) repository, open the `<release>/<system>/base-dependencies.txt` file for your MATLAB release and operating system.
16
-
17
-
From a Linux terminal, use `wget` to download the latest version of `mpm`.
18
-
19
-
wget https://www.mathworks.com/mpm/glnxa64/mpm
20
-
21
-
Give the downloaded file executable permissions so that you can run `mpm`.
22
-
23
-
chmod +x mpm
24
-
25
-
### Windows
26
-
From a Windows PowerShell prompt, use `Invoke-WebRequest` to download the latest version of `mpm`.
`mpm` is downloaded to your `Downloads` folder. Navigate to that folder.
44
-
45
-
cd ~/Downloads
46
-
47
-
Give the downloaded file executable permissions so that you can run `mpm`.
48
-
49
-
chmod +x mpm
50
-
51
-
## Syntax
52
-
53
-
### Install Products
54
-
55
-
`mpm install --release=<release> --products <product1> ... <productN>` installs products `<product1> ... <productN>` from release `<release>` to the default installation folder. [Example](#install-products-to-default-folder)
56
-
57
-
`mpm install --release=<release> --products <product1> ... <productN> <installOptions>` sets additional [product installation options](#product-installation-options). For example, you can specify the install source or destination, whether to install documentation and examples, and whether to install the GPU libraries for use with Parallel Computing Toolbox™. [Example](#install-products-using-optional-command-line-inputs)
58
-
59
-
`mpm install --inputfile </full/path/to/file>` install products using the `</full/path/to/file>` input file. You can download a template input file for your desired release from the [mpm-input-files](mpm-input-files) folder. You must specify `--inputfile` without any other options. [Example](#install-products-using-input-file)
60
-
61
-
#### Product Installation Options
62
-
63
-
| Option | Description |
7
+
For information on using `mpm`, see these command reference pages:
8
+
| Command | Description |
64
9
| ------ | ----------- |
65
-
`--release <release>` | <p>Release to install.</p><ul><li>To install the latest version of a release, specify the release name. Example: `R2024a`</li><li>To install a specific update release, specify the release name with an update number suffix. Example: `R2024aU4`</li><li>To install a release without updates, specify the release name with an update 0 or general release suffix. Example: `R2024aU0`, `R2024aGR`</li></ul><p>**Example**: `--release R2024a`</p>
66
-
`--products <product1 ... productN>` | <p>Products to install, specified as a list of product names separated by spaces.</p><p>`mpm` can install most MathWorks products and support packages. For the full list of correctly formatted product names, download the template input file for your desired release from the [mpm-input-files](mpm-input-files) folder and view the product and support package lists.</p><p>You do not need to specify all required products. If a product or support package requires another product to be installed, `mpm` installs it automatically.</p><p>For information on products `mpm` cannot install, see [Limitations](#limitations).</p><p>**Example:**`--products MATLAB Simulink Fixed-Point_Designer` installs MATLAB, Simulink, and Fixed-Point Designer.</p><p>**Example:**`--products Deep_Learning_Toolbox` installs Deep Learning Toolbox and its required product, MATLAB, automatically.</p>
67
-
`--inputfile </full/path/to/file>` | <p>Full path to the input file used to install products.</p><p>Download a template input file for your desired release from the [mpm-input-files](mpm-input-files) folder and customize it for your installation. For example, you can specify the products and support packages to install and the desired installation folder.</p><p>You must specify `--inputfile` without any other options.</p><p>**Example:**`--inputfile /home/<USER>/matlab/mpm_input_r2024a.txt`</p>
68
-
`--destination </full/path/to/destination>` | <p>Full path to the installation destination folder.</p><p>If you are adding products or support packages to an existing MATLAB installation, specify the full path to where MATLAB is installed. `mpm` determines the folder to which to install support packages based on the MATLAB installation folder.</p><p>If you do not set `--destination`, then `mpm` installs to these locations by default, where `<release>` is the specified `--release` option.</p><p>**Linux:**`/usr/share/matlab`</p><p>**Windows:**`C:\Program Files\MATLAB\<release>`<ul><li>If the Windows machine already includes a MATLAB installation for the specified release, then `mpm` uses the installation folder of that MATLAB release as the default destination.</li></ul></p><p>**macOS:**`/Applications/MATLAB/<release>`</p>
69
-
`--source </full/path/to/source>` | <p>Full path to the installation source. You can specify one of these sources:</p><ul><li>**Downloaded product files.** For more details, see [Download Products Without Installing](https://www.mathworks.com/help/install/ug/download-without-installing.html). *(R2018b and later releases)*</li><li>**A mounted ISO image (Linux and Windows only).** For an example, see [Install Products from Mounted ISO Image](#install-products-from-mounted-iso-image). *(R2022a and later releases)*</li></ul><p>If you do not set `--source`, then `mpm` downloads the product files from MathWorks.</p>
70
-
`--doc` | <p>Include documentation with the MATLAB installation. *(R2022a and R2022b only)*</p><p>In R2022a and later releases, the documentation is not included by default, and MATLAB defaults to the web documentation. To include the documentation in R2022a and R2022b releases, use the `--doc` option. In R2021b and earlier releases, the documentation is included by default, and the `--doc` option is not required.</p><p>To include the documentation in R2023a and later releases, use [mpm install-doc](#install-documentation).</li></ul></li></ul></p>
71
-
`--no-gpu` | <p>Skip installation of GPU libraries when you install Parallel Computing Toolbox. *(R2023a and later releases)*</p><p>If you do not intend to use GPU computing in MATLAB, specify this option to reduce the size of the install. You can install the GPU libraries later by calling a GPU function such as `gpuArray` or `gpuDevice` in MATLAB.</p>
72
-
`--no-jre` | <p>Skip installation of the default Java Runtime Environment (JRE) used by MATLAB so that you can set a custom JRE. You must set a supported JRE or MATLAB will not run. For details, see:<ul><li>[Set Custom JRE for MATLAB on Linux](https://www.mathworks.com/matlabcentral/answers/130360)</li><li>[Set Custom JRE for MATLAB on Windows](https://www.mathworks.com/matlabcentral/answers/130359)</li><li>[Set Custom JRE for MATLAB on macOS](https://www.mathworks.com/matlabcentral/answers/103056)</li></ul></p>
73
-
74
-
### Install Documentation
75
-
*R2023a and later releases*
76
-
77
-
`mpm install-doc --matlabroot <matlabroot> --source </full/path/to/source>` installs documentation and examples for the MATLAB installation at `<matlabroot>` from the ISO or DMG image mounted at `</full/path/to/source>`. [Example](#install-documentation-and-examples)
78
-
79
-
`mpm install-doc --matlabroot <matlabroot>` installs documentation and examples by calling the `mpm` executable included within mounted documentation ISO or DMG images. For details on this workflow, see [Install Documentation on Permanently Offline Computers](https://www.mathworks.com/help/install/ug/install-documentation-on-offline-machines.html).
80
-
81
-
`mpm install-doc ... --destination </full/path/to/destination>` sets the documentation installation folder to `</full/path/to/destination>`, using either of the previous syntaxes.
82
-
83
-
#### Documentation Installation Options
84
-
85
-
| Option | Description |
86
-
| ------ | ----------- |
87
-
`--matlabroot </full/path/to/matlabroot>` | <p>Full path to the folder in which MATLAB is installed.</p>
88
-
`--source </full/path/to/source>` | <p>Full path to the mounted documentation ISO.</p><p>If you do not set `--source`, then `mpm` installs the documentation to `$PWD/archives`.</p><p>To download a documentation ISO, see [Install Documentation on Offline Machines](https://www.mathworks.com/help/install/ug/install-documentation-on-offline-machines.html).</p>
89
-
`--destination </full/path/to/destination>` | <p>Full path to the documentation installation folder.</p>
90
-
91
-
### Get Help and Version Information
92
-
93
-
`mpm --help` or `mpm -h` displays command-line help for `mpm`. Example: `./mpm --help`
94
-
95
-
`mpm --version` or `mpm -v` displays `mpm` version information. Example: `./mpm --version`
96
-
97
-
## Examples
98
-
99
-
### Install Products to Default Folder
100
-
101
-
Install MATLAB R2024a, Simulink, and Signal Processing Toolbox™ to the default folder. Navigate to the folder containing the `mpm` binary file and run this command.
Install products and support packages for MATLAB R2024a by specifying installation options in a file.
137
-
138
-
From the [mpm-input-files](mpm-input-files) folder, open the `R2024a` folder and download the `mpm_input_r2024a.txt` input file.
139
-
140
-
Open the file. Configure the MATLAB installation by uncommenting lines that start with a single `'#'` and updating their values. Update these sections:
141
-
142
-
*SPECIFY DESTINATION FOLDER*
143
-
144
-
Uncomment the `destinationFolder` line and set an installation folder. For example:
145
-
146
-
Linux or macOS:
147
-
```
148
-
destinationFolder=/home/<USER>/matlab
149
-
```
150
-
Windows:
151
-
```
152
-
destinationFolder="C:\Users\<USER>\matlab"
153
-
```
154
-
155
-
*INSTALL PRODUCTS*
156
-
157
-
Uncomment the `product.MATLAB` and `product.Simulink` lines for installing MATLAB And Simulink.
158
-
159
-
```
160
-
product.MATLAB
161
-
# ...
162
-
product.Simulink
163
-
```
164
-
165
-
*INSTALL SUPPORT PACKAGES*
166
-
167
-
Uncomment the `product.Deep_Learning_Toolbox_Model_for_ResNet-50_Network` line to install a Deep Learning Toolbox™ support package. `mpm` will automatically install this support package's required product, Deep Learning Toolbox.
Install products from an ISO image mounted to a drive on your computer. This example runs on Linux and Windows only. On macOS, installing products from a mounted DMG image is not supported.
186
-
187
-
From [MathWorks Downloads](https://www.mathworks.com/downloads), get an ISO image containing MATLAB and Simulink products.
188
-
189
-
Mount the image. For instructions, see [this MATLAB Answers post](https://www.mathworks.com/support/search.html/answers/94021-how-do-i-install-mathworks-products-using-an-iso-image.html).
190
-
191
-
Install products from this image by specifying the path to the image in the `source` option. For example:
Download a documentation ISO or DMG image from [Install Documentation on Permanently Offline Machines](https://www.mathworks.com/help/install/ug/install-documentation-on-offline-machines.html).
205
-
206
-
Mount the image. For instructions, see [this MATLAB Answers post](https://www.mathworks.com/support/search.html/answers/94021-how-do-i-install-mathworks-products-using-an-iso-image.html).
207
-
208
-
Install the documentation and examples, specifying the MATLAB installation folder and the path to the mounted ISO or DMG image.
-`mpm` supports installing products and support packages for these releases only:
221
-
- Products - R2017b or later
222
-
- Support Packages - R2019a or later
223
-
- Not all MathWorks products are available for all operating systems and architectures that MATLAB supports:
224
-
-[Products Not Available for Linux](https://www.mathworks.com/support/requirements/matlab-linux.html)
225
-
-[Products Not Available for Mac](https://www.mathworks.com/support/requirements/matlab-mac.html)
226
-
-[Products Not Available for Apple silicon Macs](https://www.mathworks.com/support/requirements/apple-silicon.html)
227
-
-`mpm` cannot install these products:
228
-
- IEC Certification Kit
229
-
- DO Qualification Kit
230
-
- Simulink Code Inspector™
231
-
232
-
For alternative ways to install these products, see [Install Products](https://www.mathworks.com/help/install/install-products.html).
233
-
234
-
-`mpm` cannot install these support packages:
235
-
- Image Acquisition Toolbox™ Support Package for GenICam™ Interface
236
-
- Image Acquisition Toolbox Support Package for GigE Vision® Hardware
237
-
- Simulink Coder™ Support Package for BBC micro:bit
238
-
- MATLAB Support Package for IP Cameras
239
-
- New Desktop for MATLAB
240
-
- MATLAB Support Package for Parrot® Drones
241
-
- MATLAB Support Package for Ryze Tello Drones
242
-
- Simulink Real-Time™ Target Support Package
243
-
244
-
To install these support packages within MATLAB, see [Get and Manage Add-Ons](https://www.mathworks.com/help/matlab/matlab_env/get-add-ons.html).
245
-
246
-
-`mpm` supports installing specific update releases only for R2021b and later. For R2021a and earlier, `mpm` always installs the latest update release.
247
-
248
-
- On macOS, installing products from a mounted DMG image is not supported.
10
+
[`mpm install`](https://www.mathworks.com/help/install/ug/mpminstall.html) | Install products and support packages
11
+
[`mpm download`](https://www.mathworks.com/help/install/ug/mpmdownload.html) | Download products and support packages
[`mpm --help`](https://www.mathworks.com/help/install/ug/mpmhelp.html) | Get help using MATLAB Package Manager
14
+
[`mpm --version`](https://www.mathworks.com/help/install/ug/mpmversion.html) | Get MATLAB Package Manager version information
249
15
250
-
- On Windows, uninstalling products that were installed using `mpm` is not supported.
16
+
For information on using `mpm` in the MATLAB Dockerfile, see [Create a MATLAB Container Image](https://github.com/mathworks-ref-arch/matlab-dockerfile/blob/main/README.md).
251
17
252
18
## Feedback and Support
253
19
@@ -265,16 +31,16 @@ If you encounter a technical issue or have an enhancement request, create an iss
265
31
-**Changed**: `mpm` now omits installing products that are already installed instead of issuing an error.
266
32
267
33
### 2024.1.1 - March 27, 2024
268
-
-**Added**: Specify the `--no-jre` option that allows you to skip installing the default Java Runtime Environment (JRE) used by MATLAB and set a custom JRE instead. For information on which JREs are supported, see [Versions of OpenJDK Compatible with MATLAB by Release](https://www.mathworks.com/support/requirements/openjdk.html) on the MathWorks website.
34
+
-**Added:** Specify the `--no-jre` option that allows you to skip installing the default Java Runtime Environment (JRE) used by MATLAB and set a custom JRE instead. For information on which JREs are supported, see [Versions of OpenJDK Compatible with MATLAB by Release](https://www.mathworks.com/support/requirements/openjdk.html) on the MathWorks website.
269
35
270
36
### 2023.12.1 - December 14, 2023
271
-
-**Added**: Support for Windows
272
-
-**Added**: Support for macOS
37
+
-**Added:** Support for Windows
38
+
-**Added:** Support for macOS
273
39
274
40
### 2023.10.0.1 - October 26, 2023
275
-
-**Added**: Install hardware and software support packages.
276
-
-**Added**: Install required products automatically. For example, if you specify `--product Simulink`, then `mpm` installs both Simulink and the required product MATLAB.
277
-
-**Added**: Install products by specifying options in an input file.
41
+
-**Added:** Install hardware and software support packages.
42
+
-**Added:** Install required products automatically. For example, if you specify `--product Simulink`, then `mpm` installs both Simulink and the required product MATLAB.
43
+
-**Added:** Install products by specifying options in an input file.
0 commit comments