| Name | jupyter-matlab-proxy JSON |
| Version |
0.15.3
JSON |
| download |
| home_page | None |
| Summary | MATLAB Integration for Jupyter |
| upload_time | 2024-10-30 11:26:51 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MATHWORKS CLOUD REFERENCE ARCHITECTURE LICENSE The files in this GitHub repository refer to commercial software products and services, virtual machine images, and related materials of The MathWorks, Inc. (“MathWorks Programs”). MathWorks Programs are separately licensed under the MathWorks Software License Agreement, available in the desktop installation of the MathWorks Programs or in the virtual machine image. The files in this GitHub repository may also refer to third-party software licensed under separate terms provided by such third parties. The following license terms apply only to the files in this GitHub repository, including files in this folder and its subfolders, and do not apply to MathWorks Programs. References to “software” and “code” in the following license terms refer to the files in this GitHub repository. Copyright (c) 2020, The MathWorks, Inc. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. In all cases, the software is, and all modifications and derivatives of the software shall be, licensed to you solely for use in conjunction with MathWorks products and service offerings. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
jupyter
jupyter proxy
jupyter server proxy
jupyterlab
matlab
matlab integration for jupyter
matlab kernel for jupyter
matlab proxy
matlab web desktop
remote matlab web access
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MATLAB Integration _for Jupyter_
[](https://pypi.python.org/pypi/jupyter-matlab-proxy) [](https://codecov.io/gh/mathworks/jupyter-matlab-proxy) [](https://pepy.tech/project/jupyter-matlab-proxy)
Run MATLAB® code in Jupyter® environments such as Jupyter notebooks, JupyterLab, and JupyterHub.
## Table of Contents
1. [Features of MATLAB Integration _for Jupyter_](#features-of-matlab-integration-for-jupyter)
2. [Requirements](#requirements)
3. [Install](#install)
4. [Get Started](#get-started)
1. [Run MATLAB Code in a Jupyter Notebook](#run-matlab-code-in-a-jupyter-notebook)
2. [Open MATLAB in a Browser](#open-matlab-in-a-browser)
3. [Edit MATLAB Files in JupyterLab](#edit-matlab-files-in-jupyterlab)
5. [Limitations](#limitations)
## Features of MATLAB Integration _for Jupyter_
You can use this package to run MATLAB code in Jupyter notebooks and JupyterLab.
<p><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/JupyterKernel.gif"></p>
From your Jupyter notebook or JupyterLab, you can also open the MATLAB development environment in your browser to access more MATLAB features.
<p><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/JupyterMATLABDesktop.gif"></p>
## Requirements
* Supported operating systems:
- Linux®
- MacOS
- Windows® (supported from [v0.6.0](https://github.com/mathworks/jupyter-matlab-proxy/releases/tag/v0.6.0)).
- Windows Subsystem for Linux (WSL 2) [Installation Guide](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/install_guides/wsl2/README.md).
* Python versions: 3.8 | 3.9 | 3.10 | 3.11
* MATLAB R2020b or later, installed and on the system PATH.
```bash
# Confirm MATLAB is on the PATH
which matlab
```
Note: You only need MATLAB installed if you want to execute MATLAB code. You can open Jupyter notebooks containing MATLAB code without having MATLAB installed.
* System dependencies required to run MATLAB:
- The [MATLAB Dependencies](https://github.com/mathworks-ref-arch/container-images/tree/master/matlab-deps) repository contains `base-dependencies.txt` files that list the libraries required to run each release of MATLAB on a given operating system. To see how to use these files, refer to the Dockerfiles in the same folder.
* Linux based systems also require `X Virtual Frame Buffer (Xvfb)`, which you can install with:
```bash
# 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
```
## Install
Install this Python package from the Python Package Index (PyPI) or build it from the source.
### Install from PyPI
```bash
python -m pip install jupyter-matlab-proxy
```
Installing this package will not install MATLAB. To execute MATLAB code in Jupyter, you must have [MATLAB installed](https://www.mathworks.com/help/install/install-products.html) separately.
### Build from Source
Alternatively, you can install this package by building it from the source. This requires Node.js® version 16 or higher. To install Node.js, see [Node.js Downloads](https://nodejs.org/en/download/).
```bash
git clone https://github.com/mathworks/jupyter-matlab-proxy.git
cd jupyter-matlab-proxy
python -m pip install .
```
### Using JupyterHub
To use MATLAB with JupyterHub, install the `jupyter-matlab-proxy` Python package in the Jupyter environment launched by your JupyterHub platform. For example, if your JupyterHub platform launches Docker containers, install this package in the Docker image used to launch those containers, using the instructions for [Using MATLAB Integration _for Jupyter_ in a Docker Container](https://github.com/mathworks-ref-arch/matlab-integration-for-jupyter/tree/main/matlab).
### Using Simulink
This package lets you use Simulink® programmatically by entering commands in a Jupyter notebook. To view a model or use other Simulink features that require the Simulink UI, you can use a VNC to connect your Jupyter environment to a Linux desktop where you have MATLAB and Simulink installed. For instructions, see [MATLAB Jupyter VNC Solution](https://github.com/mathworks/jupyter-matlab-vnc-proxy).
### Troubleshooting
To troubleshoot package installation issues, see [Troubleshooting](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/troubleshooting/troubleshooting.md).
## Get Started
This section shows you how to:
1. [Run MATLAB Code in a Jupyter Notebook](#run-matlab-code-in-a-jupyter-notebook)
2. [Open MATLAB in a Browser](#open-matlab-in-a-browser)
3. [Edit MATLAB files in JupyterLab](#edit-matlab-files-in-jupyterlab)
Install Jupyter Notebook or JupyterLab:
```bash
# For Jupyter Notebook
python -m pip install notebook
# For JupyterLab 4
python -m pip install jupyterlab
```
Note: you can use this package to execute MATLAB code in both JupyterLab 3 and 4, but syntax highlighting is only supported on JupyterLab 4.
Open your Jupyter environment by starting Jupyter Notebook or JupyterLab.
```bash
# For Jupyter Notebook
jupyter notebook
# For JupyterLab
jupyter lab
```
If you are prompted for a token, click the link shown in your terminal to access your Jupyter environment.
After installing this package, you see new MATLAB options in your Jupyter environments.
| Classic Notebook Interface | JupyterLab |
| :---: | :---: |
|<img width="200" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/classic-jupyter_icons.png">|<img width="300" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/jupyterlab_icons_1.png">|
## Run MATLAB Code in a Jupyter Notebook
To open a Jupyter notebook where you can run MATLAB code, click `MATLAB Kernel` in your notebook or JupyterLab.
| Classic Notebook Interface | JupyterLab |
| :---: | :---: |
|<img width="200" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/classic-jupyter-kernel.png"> | <img width="300" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/jupyterlab_kernel_icon.png">|
This opens a Jupyter notebook that supports MATLAB.
<p align="center"><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/jupyterlab-notebook.png"></p>
### Notes
- **Licensing:** When you execute MATLAB code in a notebook for the first time, enter your MATLAB license information in the dialog box that appears. For details, see [Licensing](https://github.com/mathworks/matlab-proxy/blob/main/MATLAB-Licensing-Info.md). The MATLAB session can take a few minutes to start.
- **MATLAB Kernel:** The MATLAB kernel supports tab completion and rich outputs:
* Inline static plot images
* LaTeX representation for symbolic expressions
* Tables formatted using HTML instead of ASCII, in MATLAB R2024a and later:
| Before R2024a | After R2024a |
|--|--|
|<p align="center"><img width="450" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/tables_before_r2024a.png"></p> | <p align="center"><img width="400" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/tables_after_r2024a.png"></p> |
For a technical overview of the MATLAB kernel, see [MATLAB Kernel for Jupyter](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/src/jupyter_matlab_kernel/README.md).
- **Multiple notebooks:** Multiple notebooks running on a Jupyter server share the underlying MATLAB process, so executing code in one notebook affects the workspace in others. If you work in several notebooks simultaneously, be aware they share a workspace. For details, see [MATLAB Kernel for Jupyter](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/src/jupyter_matlab_kernel/README.md).
- **Local functions:** With MATLAB R2022b and later, you can define a local function at the end of the cell where you want to call it:
<p><img width="350" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/local_functions.png"></p>
- **Magic Commands:** You can use predefined magic commands in a Jupyter notebook with the MATLAB kernel, and you can also implement your own. To see a list of predefined magic commands, run `%%lsmagic`. For details about using magic commands, see [Magic Commands for MATLAB Kernel](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/src/jupyter_matlab_kernel/magics/README.md).
## Open MATLAB in a Browser
To access more MATLAB features, you can open the MATLAB development environment in your browser. Click the `Open MATLAB` button in your notebook or JupyterLab.
| Classic Notebook Interface | JupyterLab |
| :---: | :---: |
|<img width="200" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/open_matlab_notebook.png"> | <img width="300" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/open_matlab_jupyterlab.png"> |
Notebooks in JupyterLab also have a `Open MATLAB` button on the toolbar:
<img width="300" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/open-matlab-button.png">
Clicking `Open MATLAB` opens the MATLAB development environment in a new browser tab.
<p align="center"><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/jupyter_matlab_desktop.png"></p>
When you use the package for the first time, enter your MATLAB license information in the dialog box that appears. See [Licensing](https://github.com/mathworks/matlab-proxy/blob/main/MATLAB-Licensing-Info.md) for details.
For technical details about this MATLAB development environment, see [MATLAB in a Browser](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/src/jupyter_matlab_proxy/README.md).
## Edit MATLAB Files in JupyterLab
You can also edit MATLAB `.m` files in JupyterLab. Click the `MATLAB File` button.
<p align="center"><img width="300" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/matlabfile-icon.png"></p>
This opens an untitled `.m` file where you can write MATLAB code with syntax highlighting.
<p align="center"><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/new-matlab-file.png"></p>
* Currently, this package allows you to edit MATLAB `.m` files but not to execute them.
* To open a new MATLAB `.m` file, you can also use the JupyterLab command palette. Press `CTRL+SHIFT+C`, then type `New MATLAB File` and press `Enter`.
## Limitations
* This package has limitations. For example, it does not support certain MATLAB commands. For details, see [Limitations](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/Limitations.md).
* To discuss a technical issue or submit an enhancement request, [create a GitHub issue](https://github.com/mathworks/jupyter-matlab-proxy/issues), or send an email to `jupyter-support@mathworks.com`.
----
Copyright 2021-2024 The MathWorks, Inc.
----
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyter-matlab-proxy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Jupyter, Jupyter Proxy, Jupyter Server Proxy, JupyterLab, MATLAB, MATLAB Integration for Jupyter, MATLAB Kernel for Jupyter, MATLAB Proxy, MATLAB Web Desktop, Remote MATLAB Web Access",
"author": null,
"author_email": "\"The MathWorks Inc.\" <jupyter-support@mathworks.com>",
"download_url": null,
"platform": null,
"description": "# MATLAB Integration _for Jupyter_\n\n[](https://pypi.python.org/pypi/jupyter-matlab-proxy) [](https://codecov.io/gh/mathworks/jupyter-matlab-proxy) [](https://pepy.tech/project/jupyter-matlab-proxy)\n\n\n\nRun MATLAB\u00ae code in Jupyter\u00ae environments such as Jupyter notebooks, JupyterLab, and JupyterHub.\n\n\n## Table of Contents\n1. [Features of MATLAB Integration _for Jupyter_](#features-of-matlab-integration-for-jupyter)\n2. [Requirements](#requirements)\n3. [Install](#install)\n4. [Get Started](#get-started)\n 1. [Run MATLAB Code in a Jupyter Notebook](#run-matlab-code-in-a-jupyter-notebook)\n 2. [Open MATLAB in a Browser](#open-matlab-in-a-browser)\n 3. [Edit MATLAB Files in JupyterLab](#edit-matlab-files-in-jupyterlab)\n5. [Limitations](#limitations)\n\n\n## Features of MATLAB Integration _for Jupyter_\n\nYou can use this package to run MATLAB code in Jupyter notebooks and JupyterLab.\n\n<p><img width=\"600\" src=\"https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/JupyterKernel.gif\"></p>\n\nFrom your Jupyter notebook or JupyterLab, you can also open the MATLAB development environment in your browser to access more MATLAB features.\n\n<p><img width=\"600\" src=\"https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/JupyterMATLABDesktop.gif\"></p>\n\n## Requirements\n\n* Supported operating systems:\n - Linux\u00ae\n - MacOS\n - Windows\u00ae (supported from [v0.6.0](https://github.com/mathworks/jupyter-matlab-proxy/releases/tag/v0.6.0)).\n - Windows Subsystem for Linux (WSL 2) [Installation Guide](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/install_guides/wsl2/README.md).\n\n* Python versions: 3.8 | 3.9 | 3.10 | 3.11\n\n* MATLAB R2020b or later, installed and on the system PATH.\n ```bash\n # Confirm MATLAB is on the PATH\n which matlab\n ```\n Note: You only need MATLAB installed if you want to execute MATLAB code. You can open Jupyter notebooks containing MATLAB code without having MATLAB installed.\n\n* System dependencies required to run MATLAB:\n - The [MATLAB Dependencies](https://github.com/mathworks-ref-arch/container-images/tree/master/matlab-deps) repository contains `base-dependencies.txt` files that list the libraries required to run each release of MATLAB on a given operating system. To see how to use these files, refer to the Dockerfiles in the same folder.\n\n* Linux based systems also require `X Virtual Frame Buffer (Xvfb)`, which you can install with:\n\n ```bash\n # On a Debian/Ubuntu based system:\n $ sudo apt install xvfb\n\n # On a RHEL based system:\n $ yum search Xvfb\n xorg-x11-server-Xvfb.x86_64 : A X Windows System virtual framebuffer X server.\n $ sudo yum install xorg-x11-server-Xvfb\n ```\n\n## Install\n\nInstall this Python package from the Python Package Index (PyPI) or build it from the source.\n\n### Install from PyPI\n\n```bash\npython -m pip install jupyter-matlab-proxy\n```\nInstalling this package will not install MATLAB. To execute MATLAB code in Jupyter, you must have [MATLAB installed](https://www.mathworks.com/help/install/install-products.html) separately.\n\n### Build from Source\n\nAlternatively, you can install this package by building it from the source. This requires Node.js\u00ae version 16 or higher. To install Node.js, see [Node.js Downloads](https://nodejs.org/en/download/).\n```bash\ngit clone https://github.com/mathworks/jupyter-matlab-proxy.git\ncd jupyter-matlab-proxy\npython -m pip install .\n```\n\n### Using JupyterHub\n\nTo use MATLAB with JupyterHub, install the `jupyter-matlab-proxy` Python package in the Jupyter environment launched by your JupyterHub platform. For example, if your JupyterHub platform launches Docker containers, install this package in the Docker image used to launch those containers, using the instructions for [Using MATLAB Integration _for Jupyter_ in a Docker Container](https://github.com/mathworks-ref-arch/matlab-integration-for-jupyter/tree/main/matlab).\n\n### Using Simulink\n\nThis package lets you use Simulink\u00ae programmatically by entering commands in a Jupyter notebook. To view a model or use other Simulink features that require the Simulink UI, you can use a VNC to connect your Jupyter environment to a Linux desktop where you have MATLAB and Simulink installed. For instructions, see [MATLAB Jupyter VNC Solution](https://github.com/mathworks/jupyter-matlab-vnc-proxy).\n\n### Troubleshooting\n\nTo troubleshoot package installation issues, see [Troubleshooting](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/troubleshooting/troubleshooting.md).\n\n\n## Get Started\n\nThis section shows you how to:\n\n1. [Run MATLAB Code in a Jupyter Notebook](#run-matlab-code-in-a-jupyter-notebook)\n2. [Open MATLAB in a Browser](#open-matlab-in-a-browser)\n3. [Edit MATLAB files in JupyterLab](#edit-matlab-files-in-jupyterlab)\n\nInstall Jupyter Notebook or JupyterLab:\n\n ```bash\n # For Jupyter Notebook\n python -m pip install notebook\n\n # For JupyterLab 4\n python -m pip install jupyterlab\n ```\n\nNote: you can use this package to execute MATLAB code in both JupyterLab 3 and 4, but syntax highlighting is only supported on JupyterLab 4.\n\n\nOpen your Jupyter environment by starting Jupyter Notebook or JupyterLab.\n\n ```bash\n # For Jupyter Notebook\n jupyter notebook\n\n # For JupyterLab\n jupyter lab\n ```\n\nIf you are prompted for a token, click the link shown in your terminal to access your Jupyter environment.\n\nAfter installing this package, you see new MATLAB options in your Jupyter environments.\n\n\n| Classic Notebook Interface | JupyterLab |\n| :---: | :---: |\n|<img width=\"200\" src=\"https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/classic-jupyter_icons.png\">|<img width=\"300\" src=\"https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/jupyterlab_icons_1.png\">|\n\n\n## Run MATLAB Code in a Jupyter Notebook\n\nTo open a Jupyter notebook where you can run MATLAB code, click `MATLAB Kernel` in your notebook or JupyterLab.\n\n\n| Classic Notebook Interface | JupyterLab |\n| :---: | :---: |\n|<img width=\"200\" src=\"https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/classic-jupyter-kernel.png\"> | <img width=\"300\" src=\"https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/jupyterlab_kernel_icon.png\">|\n\nThis opens a Jupyter notebook that supports MATLAB.\n\n<p align=\"center\"><img width=\"600\" src=\"https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/jupyterlab-notebook.png\"></p>\n\n\n### Notes\n\n- **Licensing:** When you execute MATLAB code in a notebook for the first time, enter your MATLAB license information in the dialog box that appears. For details, see [Licensing](https://github.com/mathworks/matlab-proxy/blob/main/MATLAB-Licensing-Info.md). The MATLAB session can take a few minutes to start.\n\n- **MATLAB Kernel:** The MATLAB kernel supports tab completion and rich outputs:\n * Inline static plot images\n * LaTeX representation for symbolic expressions\n * Tables formatted using HTML instead of ASCII, in MATLAB R2024a and later:\n | Before R2024a | After R2024a |\n |--|--|\n |<p align=\"center\"><img width=\"450\" src=\"https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/tables_before_r2024a.png\"></p> | <p align=\"center\"><img width=\"400\" src=\"https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/tables_after_r2024a.png\"></p> |\n\n For a technical overview of the MATLAB kernel, see [MATLAB Kernel for Jupyter](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/src/jupyter_matlab_kernel/README.md).\n\n- **Multiple notebooks:** Multiple notebooks running on a Jupyter server share the underlying MATLAB process, so executing code in one notebook affects the workspace in others. If you work in several notebooks simultaneously, be aware they share a workspace. For details, see [MATLAB Kernel for Jupyter](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/src/jupyter_matlab_kernel/README.md).\n- **Local functions:** With MATLAB R2022b and later, you can define a local function at the end of the cell where you want to call it:\n <p><img width=\"350\" src=\"https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/local_functions.png\"></p>\n\n- **Magic Commands:** You can use predefined magic commands in a Jupyter notebook with the MATLAB kernel, and you can also implement your own. To see a list of predefined magic commands, run `%%lsmagic`. For details about using magic commands, see [Magic Commands for MATLAB Kernel](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/src/jupyter_matlab_kernel/magics/README.md).\n\n\n## Open MATLAB in a Browser\n\nTo access more MATLAB features, you can open the MATLAB development environment in your browser. Click the `Open MATLAB` button in your notebook or JupyterLab.\n\n\n| Classic Notebook Interface | JupyterLab |\n| :---: | :---: |\n|<img width=\"200\" src=\"https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/open_matlab_notebook.png\"> | <img width=\"300\" src=\"https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/open_matlab_jupyterlab.png\"> |\n\nNotebooks in JupyterLab also have a `Open MATLAB` button on the toolbar:\n\n<img width=\"300\" src=\"https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/open-matlab-button.png\">\n\nClicking `Open MATLAB` opens the MATLAB development environment in a new browser tab.\n\n<p align=\"center\"><img width=\"600\" src=\"https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/jupyter_matlab_desktop.png\"></p>\n\nWhen you use the package for the first time, enter your MATLAB license information in the dialog box that appears. See [Licensing](https://github.com/mathworks/matlab-proxy/blob/main/MATLAB-Licensing-Info.md) for details.\n\nFor technical details about this MATLAB development environment, see [MATLAB in a Browser](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/src/jupyter_matlab_proxy/README.md).\n\n\n## Edit MATLAB Files in JupyterLab\n\nYou can also edit MATLAB `.m` files in JupyterLab. Click the `MATLAB File` button.\n\n<p align=\"center\"><img width=\"300\" src=\"https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/matlabfile-icon.png\"></p>\n\nThis opens an untitled `.m` file where you can write MATLAB code with syntax highlighting.\n\n<p align=\"center\"><img width=\"600\" src=\"https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/new-matlab-file.png\"></p>\n\n* Currently, this package allows you to edit MATLAB `.m` files but not to execute them.\n* To open a new MATLAB `.m` file, you can also use the JupyterLab command palette. Press `CTRL+SHIFT+C`, then type `New MATLAB File` and press `Enter`.\n\n## Limitations\n\n* This package has limitations. For example, it does not support certain MATLAB commands. For details, see [Limitations](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/Limitations.md).\n\n* To discuss a technical issue or submit an enhancement request, [create a GitHub issue](https://github.com/mathworks/jupyter-matlab-proxy/issues), or send an email to `jupyter-support@mathworks.com`.\n\n\n----\n\nCopyright 2021-2024 The MathWorks, Inc.\n\n----\n\n",
"bugtrack_url": null,
"license": "MATHWORKS CLOUD REFERENCE ARCHITECTURE LICENSE The files in this GitHub repository refer to commercial software products and services, virtual machine images, and related materials of The MathWorks, Inc. (\u201cMathWorks Programs\u201d). MathWorks Programs are separately licensed under the MathWorks Software License Agreement, available in the desktop installation of the MathWorks Programs or in the virtual machine image. The files in this GitHub repository may also refer to third-party software licensed under separate terms provided by such third parties. The following license terms apply only to the files in this GitHub repository, including files in this folder and its subfolders, and do not apply to MathWorks Programs. References to \u201csoftware\u201d and \u201ccode\u201d in the following license terms refer to the files in this GitHub repository. Copyright (c) 2020, The MathWorks, Inc. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. In all cases, the software is, and all modifications and derivatives of the software shall be, licensed to you solely for use in conjunction with MathWorks products and service offerings. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "MATLAB Integration for Jupyter",
"version": "0.15.3",
"project_urls": {
"Homepage": "https://github.com/mathworks/jupyter-matlab-proxy"
},
"split_keywords": [
"jupyter",
" jupyter proxy",
" jupyter server proxy",
" jupyterlab",
" matlab",
" matlab integration for jupyter",
" matlab kernel for jupyter",
" matlab proxy",
" matlab web desktop",
" remote matlab web access"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "41576c5a4430f78af41f29a91e3e77add1028f0d658ca065c3f73e6cb75439e8",
"md5": "72b2e0d7fd81ed7531946949c20dc4a6",
"sha256": "98d613b3686113000f2a2bc7884a50cc1317a3e5b0930b4d212d619a15066ef5"
},
"downloads": -1,
"filename": "jupyter_matlab_proxy-0.15.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "72b2e0d7fd81ed7531946949c20dc4a6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 108241,
"upload_time": "2024-10-30T11:26:51",
"upload_time_iso_8601": "2024-10-30T11:26:51.434218Z",
"url": "https://files.pythonhosted.org/packages/41/57/6c5a4430f78af41f29a91e3e77add1028f0d658ca065c3f73e6cb75439e8/jupyter_matlab_proxy-0.15.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-30 11:26:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mathworks",
"github_project": "jupyter-matlab-proxy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyter-matlab-proxy"
}
