Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

Start and Stop MATLAB Engine for Python

Start MATLAB Engine for Python

  • Start Python® at the operating system prompt.

  • Import the matlab.engine package into your Python session.

  • Start a new MATLAB® process by calling start_matlab. The start_matlab function returns a Python object, eng, which allows you to pass data and call functions executed by MATLAB.

import matlab.engine
eng = matlab.engine.start_matlab()

Run Multiple Engines

Start each engine separately. Each engine starts and communicates with its own MATLAB process.

eng1 = matlab.engine.start_matlab()
eng2 = matlab.engine.start_matlab()

Stop Engine

Call either the exit or the quit function.

eng.quit()

If you exit Python with an engine still running, Python automatically stops the engine and its MATLAB process.

Start Engine with Startup Options

Start the engine and pass the options as an input argument string to matlab.engine.start_matlab. For example, start MATLAB with the desktop.

eng = matlab.engine.start_matlab("-desktop")

You can define multiple startup options with a single string. For example, start the desktop and set the numeric display format to short.

eng = matlab.engine.start_matlab("-desktop -r 'format short'")

You also can start the desktop after you start the engine.

import matlab.engine
eng = matlab.engine.start_matlab()
eng.desktop(nargout=0)

Start Engine Asynchronously

Start the engine asynchronously. While MATLAB starts, you can enter commands at the Python command line.

import matlab.engine
future = matlab.engine.start_matlab(async=True)

Create the MATLAB instance so you can perform computations in MATLAB.

eng = future.result()

See Also

Related Topics

Was this topic helpful?