Documentation

Customize an Application

You can customize an application in several ways: customize the installer, manage files in the project, or add a custom installer path using the Application Compiler app or the Library Compiler app.

Customize the Installer

Change Application Icon

To change the default icon, click the graphic to the left of the Library name or Application name field to preview the icon.

Click Select icon, and locate the graphic file to use as the application icon. Select the Use mask option to fill any blank spaces around the icon with white or the Use border option to add a border around the icon.

To return to the main window, click Save and Use.

Add Library or Application Information

You can provide further information about your application as follows:

  • Library/Application Name: The name of the installed MATLAB® artifacts. For example, if the name is foo, the installed executable is foo.exe, and the Windows® start menu entry is foo. The folder created for the application is InstallRoot/foo.

    The default value is the name of the first function listed in the Main File(s) field of the app.

  • Version: The default value is 1.0.

  • Author name: Name of the developer.

  • Support email address: Email address to use for contact information.

  • Company name: The full installation path for the installed MATLAB artifacts. For example, if the company name is bar, the full installation path would be InstallRoot/bar/ApplicationName.

  • Summary: Brief summary describing the application.

  • Description: Detailed explanation about the application.

All information is optional and, unless otherwise stated, is only displayed on the first page of the installer. On Windows systems, this information is also displayed in the Windows Add/Remove Programs control panel.

Change the Splash Screen

The installer splash screen displays after the installer has started. It is displayed along with a status bar while the installer initializes.

You can change the default image by clicking the Select custom splash screen. When the file explorer opens, locate and select a new image.

You can drag and drop a custom image onto the default splash screen.

Change the Installation Path

This table lists the default path the installer uses when installing the packaged binaries onto a target system.

Windows C:\Program Files\companyName\appName
Mac OS X /Applications/companyName/appName
Linux® /usr/companyName/appName

You can change the default installation path by editing the Default installation folder field under Additional installer options.

A text field specifying the path appended to the root folder is your installation folder. You can pick the root folder for the application installation folder. This table lists the optional custom root folders for each platform:

Windows C:\Users\userName\AppData
Linux /usr/local

Change the Logo

The logo displays after the installer has started. It is displayed on the right side of the installer.

You change the default image in Additional Installer Options by clicking Select custom logo. When the file explorer opens, locate and select a new image. You can drag and drop a custom image onto the default logo.

Edit the Installation Notes

Installation notes are displayed once the installer has successfully installed the packaged files on the target system. You can provide useful information concerning any additional setup that is required to use the installed binaries and instructions for how to run the application.

Determine Data Type of Command-Line Input (For Packaging Standalone Applications Only)

When an executable standalone application is run in the command prompt, the default input type is char. You can keep this default or retain numeric MATLAB variables from the original MATLAB function.

To retain char input type to the executable standalone application, select Treat inputs to the app as a MATLAB character vector. In this case, you must include code to convert char to a numeric MATLAB type in the MATLAB function to be deployed as a standalone application.

To retain numeric MATLAB variables, select the Treat inputs to the app as a numeric MATLAB double option in the Application Compiler App. Thus, you do not need to include code to convert char to a numeric MATLAB type.

Manage Required Files in Compiler Project

The compiler uses a dependency analysis function to automatically determine what additional MATLAB files are required for the application to package and run. These files are automatically packaged into the generated binary. The compiler does not generate any wrapper code that allows direct access to the functions defined by the required files.

If you are using one of the compiler apps, the required files discovered by the dependency analysis function are listed in the Files required for your application to run or Files required for your library to run field.

To add files, click the plus button in the field, and select the file from the file explorer. To remove files, select the files, and press the Delete key.

Caution

Removing files from the list of required files may cause your application to not package or not to run properly when deployed.

Using mcc

If you are using mcc to package your MATLAB code, the compiler does not display a list of required files before running. Instead, it packages all the required files that are discovered by the dependency analysis function and adds them to the generated binary file.

You can add files to the list by passing one or more -a arguments to mcc. The -a arguments add the specified files to the list of files to be added into the generated binary. For example, -a hello.m adds the file hello.m to the list of required files and -a ./foo adds all the files in foo and its subfolders to the list of required files.

Sample Driver File Creation

The following target types support sample driver file creation in MATLAB Compiler SDK™:

  • C++ shared library

  • Java® package

  • .NET assembly

  • Python® package

The sample driver file creation feature in Library Compiler uses MATLAB code to generate sample driver files in the target language. The sample driver files are used to implement the generated shared libraries into an application in the target language. In the app, click Create New Sample to automatically generate a new MATLAB script, or click Add Existing Sample to upload a MATLAB script that you have already written. After you package your functions, a sample driver file in the target language is generated from your MATLAB script and is saved in for_redistribution_files_only\samples. Sample driver files are also included in the installer in for_redistribution.

To automatically generate a new MATLAB file, click Create New Sample. This opens up a MATLAB file for you to edit. The sample file serves as a starting point, and you can edit it as necessary based on the behavior of your exported functions. The sample MATLAB files must follow these guidelines:

  • The sample file code must use only exported functions.

  • Each exported function must be in a separate sample file.

  • Each call to the same exported function must be a separate sample file.

  • The output of the exported function must be an n-dimensional numeric, char, logical, struct, or cell array.

  • Data must be saved as a local variable and then passed to the exported function in the sample file code.

Additional considerations specific to the target language are as follows:

  • C++ mwArray API — varargin and varargout are not supported.

  • .NET — Type-safe API is not supported.

  • Python — Only char, struct, and cell arrays are supported.

To upload a MATLAB file that you have already written, click Add Existing Sample. The MATLAB code should demonstrate how to execute the exported functions. The required MATLAB code can be only a few lines:

input1 = [1 4 7; 2 5 8; 3 6 9];
input2 = [1 4 7; 2 5 8; 3 6 9];
addoutput = addmatrix(input1,input2);
This code must also follow all the same guidelines outlined for the Create New Sample option.

You can also choose not to include a sample driver file at all during the packaging step. If you create your own driver code in the target language, you can later copy and paste it into the appropriate directory once the MATLAB functions are packaged.

Specify Files to Install with Application

The compiler packages files to install along with the ones it generates. By default, the installer includes a readme file with instructions on installing the MATLAB Runtime and configuring it.

These files are listed in the Files installed for your end user section of the app.

To add files to the list, click , and select the file from the file explorer.

JAR files are added to the application class path as if you had called javaaddpath.

Caution

Removing the binary targets from the list results in an installer that does not install the intended functionality.

When installed on a target computer, the files listed in the Files installed for your end user are saved in the application folder.

Additional Runtime Settings

Type of Packaged ApplicationDescriptionAdditional Runtime Settings Options
Standalone Applications
  • Do not display the Windows Command Shell (console) for execution — If you select this option on a Windows platform, when you double-click the application from the file explorer, the application window opens without a command prompt.

  • Create log file — Generate a MATLAB log file for the application. The packaged application can't create a log file if installed in the C: folder on Windows because the application does not have write permission in that folder.

Excel Add-Ins
  • Register the component for the current user (Recommended for non-admin users) — This option enables registering the component for the current user account. It is provided for users without admin rights.

  • Create log file — Generate a MATLAB log file for the application. The packaged application can't create a log file if installed in the C: folder on Windows because the application does not have write permission in that folder.

See Also

|

Related Topics