matlab-proxy 0.2.7

Python® package enables you to launch MATLAB® and access it from a web browser.

MATLAB Proxy

Copyright (c) 2021 The MathWorks, Inc. All rights reserved.

---

matlab-proxy is a Python® package which enables you to launch MATLAB® and access it from a web browser.

Installation of this package creates an executable matlab-proxy-app, which launches MATLAB and provides a URL to access it.

The MATLAB Proxy is under active development. For support or to report issues, see the Feedback section.

---

Requirements

• Linux® operating system

• MATLAB® R2020b or later is installed and on the system PATH.

  # Confirm MATLAB is on the PATH
  which matlab
  

• The dependencies required to run MATLAB. Refer to the Dockerfiles in the matlab-deps repository for the desired version of MATLAB.

• X Virtual Frame Buffer (Xvfb) Install it on your linux machine using:

  # On a Debian/Ubuntu based system:
  $ sudo apt install xvfb
  

  # On a RHEL based system:
  $ yum search Xvfb
  xorg-x11-server-Xvfb.x86_64 : A X Windows System virtual framebuffer X server.
  
  $ sudo yum install xorg-x11-server-Xvfb
  

• Python versions: 3.6 | 3.7 | 3.8 | 3.9

• Browser Requirements

Installation

PyPI

This repository can be installed directly from the Python Package Index.

python -m pip install matlab-proxy

Building From Sources

Building from sources requires Node.js® version 13 or higher. Click here to install Node.js

git clone https://github.com/mathworks/matlab-proxy.git

cd matlab-proxy

python -m pip install .

Installing the package creates an executable called matlab-proxy-app, which is placed onto your system PATH by pip, usually in: $HOME/.local/bin/

# Confirm it is on the PATH
which matlab-proxy-app

Usage

Once the matlab-proxy package is installed.

• Open a Linux terminal and launch the application with

  env MWI_BASE_URL="/matlab" matlab-proxy-app
  

  MWI_BASE_URL is an environment variable which controls the link on which MATLAB can be accessed. For a detailed listing of all environment variables. See Advanced-Usage.md

  Running the above command will print text out on your terminal, which will contain the URL to access MATLAB. For example:

  MATLAB can be accessed on 
  http://localhost:44549/matlab/index.html
  

• Open the the link above in a web browser. If prompted to do so, enter credentials for a MathWorks account associated with a MATLAB license. If you are using a network license manager, then change to the Network License Manager tab and enter the license server address instead. To determine the appropriate method for your license type, consult MATLAB Licensing Info.

• Wait for the MATLAB session to start. This can take several minutes.

• To manage the MATLAB session, click the tools icon shown below.

• Clicking the tools icon opens a status panel with buttons like the ones below:

The following options are available in the status panel (some options are only available in a specific context):

Option	Description
Start MATLAB Session	Start your MATLAB session. Available if MATLAB is stopped.
Restart MATLAB Session	Restart your MATLAB session. Available if MATLAB is running or starting.
Stop MATLAB Session	Stop your MATLAB session. Use this option if you want to free up RAM and CPU resources. Available if MATLAB is running or starting.
Sign Out	Sign out of MATLAB. Use this to stop MATLAB and sign in with an alternative account. Available if using online licensing.
Unset License Server Address	Unset network license manager server address. Use this to stop MATLAB and enter new licensing information. Available if using network license manager.
Feedback	Send feedback about the MATLAB Proxy. This action opens your default email application.
Help	Open a help pop-up for a detailed description of the options.

Examples

• For usage in a Docker container, see this Dockerfile and its README.
• For usage in a Jupyter environment, see jupyter-matlab-proxy.

Limitations

This package supports the same subset of MATLAB features and commands as MATLAB® Online, except there is no support for Simulink® Online. Click here for a full list of Specifications and Limitations for MATLAB Online.

Feedback

We encourage you to try this repository with your environment and provide feedback. If you encounter a technical issue or have an enhancement request, create an issue here