Files Generated After Packaging MATLAB Functions

When you create a deployable component using MATLAB® Compiler SDK™, files that correspond to the build target are generated in the output folder. Depending on which packaging method you use, files may be located in various subfolders in the output folder. For more details on the available packaging methods, see Choose Deployment Option. For a list of files generated by MATLAB Compiler™, see Files Generated After Packaging MATLAB Functions.

The compiler.build family of functions place output files in a folder named after the main file and target type. For instance, magicsquarePythonPackage.

The Compiler apps generate a folder named after the compiler task and place output files in a subfolder named build. The apps optionally create a package subfolder if you create an installer. The installer installs all of the binary artifacts required for distributing a compiled component and optionally installs MATLAB Runtime. You can also generate an installer using the compiler.package.installer function. Distribute the installer to users who do not have MATLAB installed on their machines.

If you do not create an installer, you can manually distribute the set of files required to integrate the component according to the component type. For information on which files to distribute in order to develop and run applications that use your component, see Distribute MATLAB Compiler SDK Files to Application Developers.

Since R2025a: For information on files generated using a prior version of the Compiler apps, see Files Generated After Packaging MATLAB Functions (R2024b).

Files Generated by MATLAB Compiler SDK

MATLAB Compiler SDK generates the following files in the build output folder. The intermediate artifacts not listed here are generated as a result of packaging of the MATLAB files. They are not significant to the user.

All Targets

The following files are generated for all deployment targets.

FileDescription
buildresult.json

JSON file containing information on runtime dependencies included in the package. The information corresponds to the RuntimeDependencies property of the compiler.build.Results object. (since R2025a)

GettingStarted.html

HTML file containing packaging information and next steps.

includedSupportPackages.txt

Lists all support files included in the package.

mccExcludedFiles.log

Log file that contains a list of any toolbox functions that were not included in the package. For information on excluding data files, see %#exclude.

deploymentLog.html

HTML file containing information on the packaging process.

readme.txt

Contains information on deployment prerequisites and the list of files to package for deployment.

requiredMCRProducts.txt

Contains product IDs of products required to run the package. For more information on product IDs, see matlab.codetools.requiredFilesAndProducts. This file will be removed in a future release.

unresolvedSymbols.txt

Lists dependencies not found during packaging. If this file is not empty, you must locate the required dependencies and place them in the search path before recompiling.

Sample Files (Optional)

For each MATLAB sample file you include during packaging, a sample application in the target language is generated in a folder named samples. For more information, see Create Sample Code to Call Exported Function.

The following target types support sample generation:

  • C++ shared library

  • Java® package

  • .NET assembly

  • Python® package

FileDescription
filenameSample1_api.cpp

C++ sample application.

filenameSample1.java

Java sample application.

filename.cs

C# .NET sample application.

filenameSample1.py

Python sample application.

C Shared Library

FileDescription
filename.lib

Import library for user-written shared library.

filename.h

Header file for user-written shared library.

filename.dll

Code for user-written shared library.

C++ Shared Library

FileDescription
filename.lib

Import library for user-written mwArray API shared library.

This file is generated if you choose the mwArray API during packaging.

filename.h

Header file for user-written mwArray API shared library.

filename.dll

Code for user-written mwArray API shared library.

v2:

  • generic_interface:

    • filename.ctf

    • readme.txt

The folder v2 contains the subfolder generic_interface. It contains a ctf file, which is the deployable archive for the MATLAB Data API library.

The readme.txt file contains packaging information.

The v2 folder is generated if you choose the MATLAB Data API during packaging.

COM Component

FileDescription
_install.bat

File that registers the generated dll file.

filename_1_0.dll

The generated dll that needs to be registered using mwregsvr.exe or regsvr32.exe.

.NET Assembly

FileDescription
filename.dll

File that contains the generated component that can be accessed using mwArray API.

filename_overview.html

HTML overview documentation file for the generated component. It contains requirements for accessing the component and for generating arguments using the mwArray class hierarchy.

filenameNative.dll

File that contains the generated component that can be accessed using native API.

Java Package

FileDescription

doc:

  • html:

    • filename

      • Class1.html

      • Class1Remote.html

      • FilenameMCRFactory.html

      • packageframe.html

      • package-summary.html

      • packagetree.html

    • allclasses-frame.html

    • allclasses-noframe.html

    • constantvalues.html

    • deprecated-list.html

    • help-doc.html

    • index.html

    • index-all.html

    • overview-tree.html

    • package-list

    • script.js

    • stylesheet.css

The folder doc contains another folder html which contains HTML documentation for all classes in the packaged Java application.

filename.jar

Java archive for user-written application.

This file is generated if you choose the MWArray API during packaging.

filename.ctf

Java archive for user-written application.

This file is generated if you choose the MATLAB Data API during packaging.

Python Package

FileDescription

filename:

  • _init_.py

  • filename.ctf

The folder Filename contains the following files:

  • _init_.py — File used during initialization of the Python package.

  • filename.ctf — Deployable archive for the Python package.

pyproject.toml

Configuration file that contains build system requirements and information, which are used by pip to build the package. For details, see https://packaging.python.org/en/latest/guides/writing-pyproject-toml/.

setup.py

File used during installation of the Python package.

MATLAB Production Server Archive

FileDescription
filename.ctf

Deployable archive file for MATLAB Production Server™.

Excel add-in for MATLAB Production Server

FileDescription
_install.bat

The file that registers the generated dll file.

filename.bas

VBA module file that can be imported into a VBA project. This file is generated only if you enable the GenerateVisualBasicFile option.

filename.xla

Excel® add-in that can be added directly to Excel. You do not need both .bas file and .xla file; one of them is sufficient. This file is generated only if you enable the GenerateVisualBasicFile option.

filename.dll

The generated dll that needs to be registered using mwregsvr.exe or regsvr32.exe.

See Also

|

Topics