Main Content

mcr-root

Location of a MATLAB Runtime installation

Syntax

--mcr-root path

Description

mcr-root specifies the path to a MATLAB® Runtime installation on a system that has a MATLAB Production Server™ installed.

You can configure a server instance to use multiple MATLAB Runtime versions by specifying multiple mcr-root properties. To do so, specify the mcr-root property with the path to each MATLAB Runtime installation on a separate line, starting from the latest version to the oldest. The server instance scans the list of specified mcr-root properties in order from first to last, then chooses the first MATLAB Runtime installation capable of processing a server request. A MATLAB Runtime installation can process a server request if it is compatible with the deployable archive containing the MATLAB function being evaluated. When you configure the server to use multiple MATLAB Runtime versions, the server uses dynamic worker pool management, where it starts the worker processes in response to demand, and stops them in response to system resource utilization. Specifying multiple MATLAB Runtime installations of the same version has no effect on server performance.

Note

An installation of MATLAB Production Server supports MATLAB Runtime versions up to six releases back.

Note

  • Specify the path to a MATLAB Runtime installation on a local file system when configuring a server instance. Specifying a path on network partition might cause worker processes to fail.

  • All values for mcr-root must be for the same operating system and hardware combination.

For a server environment deployed in the cloud, the deployment sets the mcr-root property to support multiple MATLAB Runtime versions.

Parameters

path

Path to the root folder of the MATLAB Runtime installation.

Note

The special value mCRuNsETtOKEN indicates to the mps-start command that a server is not configured to use a MATLAB Runtime. Running the mps-start command without configuring MATLAB Runtime results in an error.

Examples

  • For on-premises server instances created using the command line, update the server configuration property in the main_config server configuration file.

  • For on-premises server instances created using the dashboard, use the dashboard to update the server configuration property.

Configure Using Command Line

Use Latest Version of MATLAB Runtime

In the main_config file, set the mcr-root property to the following:

--mcr-root /usr/local/MATLAB/MATLAB_Runtime/R2023a
Use Two Versions of MATLAB Runtime

In the main_config file, set the mcr-root property to the following:

--mcr-root /usr/local/MATLAB/MATLAB_Runtime/R2023a
--mcr-root /usr/local/MATLAB/MATLAB_Runtime/v98

Configure Using Dashboard

Use Latest Version of MATLAB Runtime

In the dashboard, in the Settings tab of your server instance, under Core, for the MATLAB Runtime property, enter the following:

/usr/local/MATLAB/MATLAB_Runtime/R2023a
Use Two Versions of MATLAB Runtime

In the dashboard, in the Settings tab of your server instance, under Core, for the MATLAB Runtime property, enter the following:

/usr/local/MATLAB/MATLAB_Runtime/R2023a
/usr/local/MATLAB/MATLAB_Runtime/v98