You can package MATLAB® files to create a toolbox to share with others. These files can include
MATLAB code, data, apps, examples, and documentation. When you create a toolbox,
MATLAB generates a single installation file (
enables you or others to install your toolbox.
To create a toolbox installation file:
In the Environment section of the Home tab, select Package Toolbox from the Add-Ons menu.
In the Package a Toolbox dialog box, click the button and select your toolbox folder. It
is good practice to create the toolbox package from the folder level above
your toolbox folder. The
.mltbx toolbox file contains
information about the path settings for your toolbox files and folders. By
default, any of the included folders and files that are on your path when
you create the toolbox appear on their paths after the end users install the
In the dialog box, add the following information about your toolbox.
|Toolbox Information Field||Description|
Enter the toolbox name, if necessary. By default,
the toolbox name is the name of the toolbox folder. The
Toolbox Name becomes the
Enter the toolbox version number in the
|Author Name, Email, and Company|
Enter contact information for the toolbox author. To save the contact information, click Set as default contact.
To select an image that represents your toolbox, click Select toolbox image.
|Summary and Description|
Enter the toolbox summary and description. It is good practice to keep the Summary text brief and to add detail to the Description text.
To ensure MATLAB detects the expected components, review the toolbox contents. The following sections of the Package a Toolbox dialog box appear after you select a toolbox folder.
|Package a Toolbox Dialog Box Section||Description|
|Toolbox Files and Folders|
List of the folders and files contained in your toolbox. The listed files and folders are only those files that are located in the top level of the toolbox folder. You cannot navigate through the folders in the Toolbox Packaging dialog box.
By default, if
your toolbox contains a P-code file and a MATLAB code file (
To exclude other files or folders from the toolbox, register them in the text file that is displayed when you click Exclude files and folders. It is good practice to exclude any source control files related to your toolbox.
Add-ons — List of add-ons required for your toolbox. Selected add-ons are downloaded and installed when the toolbox is installed. MATLAB auto-populates this list with the add-ons it thinks the toolbox requires and selects them all by default. You can choose to omit any add-ons you do not want to install with your toolbox.
If MATLAB is unable to find the installation information for an add-on in the list, you must enter a download URL. The download URL is the location where MATLAB can download and install the add-on. When the toolbox is installed, MATLAB installs the add-on using the specified URL.
External Files — List of the files required for your toolbox that are located outside the toolbox folder. MATLAB auto-populates this list with the files it thinks the toolbox requires and selects them all by default. You can choose to omit any files you do not want in your toolbox.
MATLAB Path — List of folders that are added to the user’s MATLAB path when they install a toolbox. By default, the list includes any of the toolbox folders that are on your path when you create the toolbox. You can exclude folders from being added to the user’s path by clearing them from the list. To manage the path for when a toolbox is installed, click Manage the current MATLAB path. To reset the list to the default list, click Reset to the current MATLAB path.
Java Class Path — List of Java® files that are added to the user’s Java class path when they install a toolbox. Upon toolbox installation, the JAR files are added to the dynamic path for the duration of the MATLAB session. When the toolbox user restarts MATLAB, the JAR files are added to the static path.
Installation of Additional Software — List of additional software ZIP files that are installed on the user's system when they install a toolbox.
Specify these fields:
When the user installs a
toolbox, MATLAB installs all additional software in the
If your toolbox contains code that
refers to the installation folder of the specified
additional software, make these references portable to
other computers. Replace the references with calls to
the generated function
with this code:
mysoftwarelocation = 'C:\InstalledSoftware\mysoftware\'
To enable testing of the toolbox on your computer before packaging the toolbox, click the
mysoftwarelocation = mytoolbox.getInstallationLocation('mysoftware')
MATLAB uses the information in the Toolbox Portability section when the user installs the toolbox. If the compatibility check fails because the user has an unsupported platform or MATLAB version, MATLAB displays a warning. However, the user still can install the toolbox.
Platform Compatibility—List of platforms that support the toolbox. Consider if your toolbox has third-party software or hardware requirements that are platform specific. MATLAB Online™ cannot interact with hardware, including devices used for image acquisition and instrument control.
Release Compatibility—List of MATLAB releases that support the toolbox.
Products—List of MathWorks® products required by your toolbox. Create this list manually.
|Examples, Apps, and Documentation|
Examples—Published MATLAB examples associated with your toolbox. To
Alternatively, you can manually publish code files to HTML in MATLAB and then include the code files and the HTML files in your toolbox folder.
To create different categories for your
examples, place the examples in different subfolders
within your toolbox folder. When you add your toolbox
folder to the Package a Toolbox dialog box, MATLAB creates a
Apps—Published MATLAB installable apps associated with your
toolbox. The Package a Toolbox tool recognizes apps
Getting Started Guide—Quick start guide for
your toolbox. For the Package a Toolbox tool to
recognize a Getting Started Guide, include the guide as
a live script named
Alternatively, you can generate and
Users of your toolbox can view the Getting Started Guide through the Options menu for the toolbox in the Add-On Manager. For more information, see Get and Manage Add-Ons.
Help Browser Integration—Custom
documentation associated with your toolbox. For the
Package a Toolbox tool to recognize custom
documentation, include an
Alternatively, you can generate
Package your toolbox.
To save your toolbox, click Package at
the top of the Package a Toolbox dialog box. Packaging your
toolbox generates a
.mltbx file in your
current MATLAB folder.
To save your toolbox and share it on MATLAB Central File Exchange, select Package and
Share from the Package menu
at the top of the Package a Toolbox dialog box. This option
.mltbx file in your current
MATLAB folder and opens a web page for your toolbox
submission to File Exchange. MATLAB populates the File Exchange submission form with
information about the toolbox. Review and submit the form to
share your toolbox on File Exchange.
When you create a toolbox, MATLAB generates a
.prj file that contains
information about the toolbox and saves it frequently. It is good practice
to save this associated
.prj file so that you can quickly
create future revisions of your toolbox.
To share your toolbox with others, give them the
All files you added when you packaged the toolbox are included in the
.mltbx file. When the end users install your toolbox, they do
not need to be concerned with the MATLAB path or other installation details. The
manages these details for end users.
For information on installing, uninstalling, and viewing information about toolboxes, see Get and Manage Add-Ons.
You can share your toolbox with others by attaching the
file to an email message, or using any other method you typically use to share
files—such as uploading to MATLAB Central File
Exchange. If you upload your toolbox to File Exchange, your users can
download the toolbox from within MATLAB. For more information, see Get and Manage Add-Ons.
Alternatively, you can upload your toolbox to File Exchange when you package it. Select Package and Share from the Package menu at the top of the Package a Toolbox dialog box.
.mltbx files can contain any files you specify,
MATLAB Central File Exchange places additional limitations on
submissions. If your toolbox contains any of the following, it cannot be
submitted to File Exchange:
Other binary executable files, such as DLLs or ActiveX® controls. (Data and image files are typically acceptable.)