Call MATLAB from Python
MATLAB Engine API for Python provides a package for Python to call MATLAB as a computational engine. The engine supports the reference implementation (CPython). For supported version information, see Versions of Python Compatible with MATLAB Products by Release.
To install and start the engine, see Get Started with MATLAB Engine API for Python.
To call Python functions from MATLAB, see Call Python from MATLAB.
Engine applications require an installed version of MATLAB; you cannot run the MATLAB engine on a machine that only has MATLAB Runtime.
Functions
Classes
Topics
Installing
- Install MATLAB Engine API for Python
MATLAB Engine API for Python allows you to call MATLAB functions and execute MATLAB commands from within a Python environment. To use the MATLAB engine, you must have a supported version of Python installed on your machine, and you must install MATLAB Engine API for Python as a Python package.
Getting Started
- Get Started with MATLAB Engine API for Python
MATLAB Engine API for Python provides a Python package namedmatlabthat enables you to call MATLAB functions from Python. - Start and Stop MATLAB Engine for Python
Options for starting the MATLAB Engine for Python. - Call MATLAB Functions from Python
How to return an output argument from a MATLAB function. How to read multiple outputs from a function. What to do when the MATLAB function does not return an output argument. - Get Help for MATLAB Functions from Python
From Python, you can access supporting documentation for all MATLAB functions.
Session Management
- Connect Python to Running MATLAB Session
How to connect the MATLAB Engine for Python to a shared MATLAB session that is already running on your local machine.
Using MATLAB Workspace
- Use MATLAB Engine Workspace in Python
This example shows how to add variables to the MATLAB engine workspace in Python.
Data Exchange and Mapping
- Use MATLAB Arrays in Python
This example shows how to create a MATLAB array in Python and pass it as the input argument to the MATLABsqrtfunction. - MATLAB Arrays as Python Variables
ThematlabPython module provides array classes to represent arrays of MATLAB numeric types as Python variables so that MATLAB arrays can be passed between Python and MATLAB. - Pass Data Between MATLAB and Python
When you return MATLAB data to Python, MATLAB Engine API for Python converts the data into the equivalent Python data type. - Use MATLAB Handle Objects in Python
This example shows how to create an object from a MATLAB handle class and call its methods in Python. - Default Numeric Types in MATLAB and Python
By default, a number in MATLAB has a double-precision type. - Use MATLAB Dictionaries in Python
MATLAB Engine API for Python converts a Pythondictto a MATLAB dictionary and a MATLAB dictionary to a Pythondict. - Use MATLAB Tables and Timetables in Python
Convert between MATLAB tables and timetables and Python pandas DataFrames. - How MATLAB Handles Datetime and Duration Types in Python
Convert between MATLABdatetimeanddurationvalues and Pythondatetimeandnumpytypes.
Calling MATLAB Functions
- Call User Scripts and Functions from Python
This example shows how to call a MATLAB script to compute the area of a triangle from Python. - Sort and Plot MATLAB Data from Python
This example shows how to sort data about patients into lists of smokers and nonsmokers in Python and plot blood pressure readings for the patients with MATLAB. - Call MATLAB Functions Asynchronously from Python
This example shows how to call the MATLABsqrtfunction asynchronously from Python and retrieve the square root later. - Redirect Standard Output and Error to Python
This example shows how to redirect standard output and standard error from a MATLAB function to PythonStringIOobjects.
Troubleshooting
Limitations to MATLAB Engine API for Python
MATLAB Engine API for Python does not support these features.
Troubleshoot MATLAB Errors in Python
When a MATLAB function raises an error, the MATLAB Engine for Python stops the function and catches the exception raised by MATLAB.
