Adds install guide for running MATLAB in Jupyter Notebooks Using VS Code.

fixes #24
fixes #41

Author: prabhakk-mw

README.md

@@ -15,6 +15,7 @@ Run MATLAB® code in Jupyter® environments such as Jupyter notebooks, JupyterLa
   - [Install](#install)
     - [Install from PyPI](#install-from-pypi)
     - [Build from Source](#build-from-source)
+    - [Using VS Code](#using-vs-code)
     - [Using JupyterHub and The Littlest JupyterHub](#using-jupyterhub-and-the-littlest-jupyterhub)
     - [Using Simulink](#using-simulink)
     - [Troubleshooting](#troubleshooting)
@@ -92,11 +93,15 @@ python -m pip install .
 install-matlab-kernelspec
 ```
 
+### Using VS Code
+
+You can use this package to run MATLAB in Jupyter notebooks using VS Code. For instructions, see [Run MATLAB in Jupyter Notebooks Using VS Code](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/install_guides/vscode/README.md).
+
 ### Using JupyterHub and The Littlest 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).
 
-To use MATLAB with [The Littlest JupyterHub (TLJH)](https://tljh.jupyter.org/en/stable/index.html#), see [MATLAB Integration for Jupyter on The Littlest JupyterHub](https://github.com/mathworks/jupyter-matlab-proxy/jupyter-matlab-proxy/install_guides/the-littlest-jupyterhub/README.md). You might use this if you want to set up JupyterHub on a single server for a small number of users, such as students in a class.
+To use MATLAB with [The Littlest JupyterHub (TLJH)](https://tljh.jupyter.org/en/stable/index.html#), see [MATLAB Integration for Jupyter on The Littlest JupyterHub](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/install_guides/the-littlest-jupyterhub/README.md). You might use this if you want to set up JupyterHub on a single server for a small number of users, such as students in a class.
 
 ### Using Simulink
 

install_guides/the-littlest-jupyterhub/README.md

@@ -1,53 +1,46 @@
 # MATLAB Integration for Jupyter on The Littlest JupyterHub
 
-This guide shows how to set up MATLAB and the [MATLAB Integration for Jupyter](https://github.com/mathworks/jupyter-matlab-proxy) on the [The Littlest JupyterHub (TLJH)](https://tljh.jupyter.org/en/stable/index.html#). You might use this if you want to set up JupyterHub on a single server for a small number of users, such as students in a class.
+This guide shows how to set up MATLAB and the [MATLAB Integration for Jupyter](https://github.com/mathworks/jupyter-matlab-proxy) on the [The Littlest JupyterHub (TLJH)](https://tljh.jupyter.org/en/stable/index.html). You might use TLJH if you want to set up JupyterHub on a single server for a small number of users, such as students in a class.
 
 
 ## Set up TLJH
 
-The [TLJH Documentation](https://tljh.jupyter.org/en/stable/install/index.html) contains instructions for installing TLJH in different environments. 
-
-Once you have a working TLJH stack, you can add MATLAB into your TLJH stack using the MATLAB Plugin for The Littlest JupyterHub.
+The [TLJH Documentation](https://tljh.jupyter.org/en/stable/install/index.html) contains instructions for installing TLJH in different environments. Set up a working TLJH stack.
 
 ## Add MATLAB to TLJH Installation
-This repository contains `tljh-matlab`, the [MATLAB Plugin for The Littlest JupyterHub](https://github.com/mathworks/jupyter-matlab-proxy/jupyter-matlab-proxy/install_guides/the-littlest-jupyterhub/tljh-matlab/README.md). 
-
-Use the plugin to install MATLAB, its dependencies, and the MATLAB integration for Jupyter in TLJH. 
 
-To install the MATLAB plugin, run the `bootstrap` script from your TLJH installation process again, and add the `tljh-matlab` plugin:
+Add MATLAB to your TLJH installation by using the MATLAB Plugin for The Littlest JupyterHub. To install the MATLAB plugin, run the `bootstrap` script from your TLJH installation process again, and include `-- plugin tljh-matlab` plugin:
 
 ```bash
 curl -L https://tljh.jupyter.org/bootstrap.py \
  | sudo python3 - \
    --plugin tljh-matlab
 ```
 
-For more information on installing plugins into a TLJH environment, see [Customizing the Installer *(TLJH Docs)*](https://tljh.jupyter.org/en/latest/topic/customizing-installer.html#customizing-the-installer).
-
-To customize the MATLAB plugin, for example to choose which MATLAB toolboxes to install, see [MATLAB Plugin for The Littlest JupyterHub](https://github.com/mathworks/jupyter-matlab-proxy/tree/main/install_guides/the-littlest-jupyterhub/tljh-matlab/README.md).
+For detailed instructions on using and customizing the plugin, such as the version and toolboxes of MATLAB it installs, see the [MATLAB Plugin for The Littlest JupyterHub](https://github.com/mathworks/jupyter-matlab-proxy/tree/main/install_guides/the-littlest-jupyterhub/tljh-matlab/README.md).
 
-## Setting Up TLJH with MATLAB in Docker: Quick Demo
+## Example: Setting Up TLJH with MATLAB in Docker
 
-Execute the [start-container-with-tljh-matlab.sh](./start-container-with-tljh-matlab.sh) script to efficiently set up a sample TLJH environment with MATLAB & The MATLAB Integration for Jupyter installed within a Docker container.
+Run the [start-container-with-tljh-matlab.sh](./start-container-with-tljh-matlab.sh) script to quickly set up a TLJH environment with MATLAB and the MATLAB Integration for Jupyter installed within a Docker container.
 
 ```bash
 ./start-container-with-tljh-matlab.sh
 ```
 
-Once initialized, your JupyterHub server will be accessible for notebook hosting at **http://Your-FQDN:12000**. You can view it in your browser via **http://localhost:12000/**.
+Your JupyterHub server will be accessible for hosting Jupyter Notebooks at `http://Your-FQDN:12000`. You can view it in your browser at `http://localhost:12000/`.
 
 ![JupyterHub Login Page](https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/tljh.png)
 
 Access JupyterHub using the default credentials: the username is `admin` and the password is `password`.
-You can update these default values either, in the [start-container-with-tljh-matlab.sh](./start-container-with-tljh-matlab.sh) script, or from the Jupyter Admin UI.
+You can update these default values either in the [start-container-with-tljh-matlab.sh](./start-container-with-tljh-matlab.sh) script, or from the Jupyter Admin interface.
 
-To install a different release of MATLAB or to install different MATLAB toolboxes within the TLJH instance, adjust the environment variables in the [.matlab_env](./.matlab_env) file accordingly and re-run `start-container-with-tljh-matlab.sh`.
+To install a different release of MATLAB or to install different MATLAB toolboxes within the TLJH instance, modify the environment variables in the [.matlab_env](./.matlab_env) file accordingly and run `start-container-with-tljh-matlab.sh` again.
 
 ## Learn More
 
-- [The Littlest JupyterHub Official Documentation (TLJH)](https://tljh.jupyter.org/en/stable/index.html).
-- [When to Use the Littlest JupyterHub (TLJH)](https://tljh.jupyter.org/en/stable/topic/whentouse.html).
-- [Plugins (TLJH)](https://tljh.jupyter.org/en/stable/contributing/plugins.html).
+- [The Littlest JupyterHub Official Documentation (TLJH)](https://tljh.jupyter.org/en/stable/index.html)
+- [When to Use the Littlest JupyterHub (TLJH)](https://tljh.jupyter.org/en/stable/topic/whentouse.html)
+- [Plugins (TLJH)](https://tljh.jupyter.org/en/stable/contributing/plugins.html)
 
 
 ----

install_guides/the-littlest-jupyterhub/tljh-matlab/README.md

@@ -1,17 +1,17 @@
 # MATLAB Plugin for The Littlest JupyterHub
 
-A plugin for running [MATLAB® Integration for Jupyter on The Littlest JupyterHub](https://github.com/mathworks/jupyter-matlab-proxy/jupyter-matlab-proxy/install_guides/the-littlest-jupyterhub/README.md).
+This guide shows you now to use the MATLAB Plugin to install [MATLAB on The Littlest JupyterHub](https://github.com/mathworks/jupyter-matlab-proxy/jupyter-matlab-proxy/install_guides/the-littlest-jupyterhub/README.md).
 
 ## Background
 
-The Littlest JupyterHub supports [plugins](https://tljh.jupyter.org/en/latest/contributing/plugins.html) that provide additional features. The MATLAB plugin for TLJH, `tljh-matlab`, installs:
+The Littlest JupyterHub supports [plugins](https://tljh.jupyter.org/en/latest/contributing/plugins.html) that provide additional features. The MATLAB plugin for TLJH installs:
+
 * a specified version of MATLAB, as well as any MATLAB toolboxes
 * the system libraries that MATLAB requires 
 * the [MATLAB Integration for Jupyter](github.com/mathworks/jupyter-matlab-proxy), for running MATLAB in Jupyter notebooks and accessing the MATLAB environment from Jupyter.
 
-## Usage
-To install the MATLAB plugin for TLJH include `--plugin tljh-matlab` in the Installer Script.
-See [Customizing the Installer](https://tljh.jupyter.org/en/latest/topic/customizing-installer.html) for more information.
+## Using the Plugin
+To install the MATLAB plugin for TLJH, include `--plugin tljh-matlab` in the Installer Script.
 
 For example, the following command sets up an `admin_user` with `admin_password` and installs `tljh-matlab`:
 ```bash
@@ -21,8 +21,11 @@ curl -L https://tljh.jupyter.org/bootstrap.py
     --plugin tljh-matlab
 ```
 
-## Customization
-To customize the default values used by the plugin, set the relevant environment variables before using the bootstrap command:
+For more information on customizing the TLJH installer, see [Customizing the Installer (TLJH)](https://tljh.jupyter.org/en/latest/topic/customizing-installer.html).
+
+
+## Customizing MATLAB Installation
+To customize the default values used by the plugin to install MATLAB, set the relevant environment variables before using the bootstrap command:
 
 | Environment Variable Name | Default Values | Notes |
 |---|---|---|
@@ -31,10 +34,10 @@ To customize the default values used by the plugin, set the relevant environment
 | MATLAB_INSTALL_DESTINATION | /opt/matlab/R2024b             | Specify the path to the location where you want to install MATLAB. |
 
 
-For example, to customize the plugin to install MATLAB R2023b and Simulink, run:
+For example, to customize the plugin to install MATLAB R2024b and Simulink, run:
 ```bash
 curl https://tljh.jupyter.org/bootstrap.py
-  | env MATLAB_RELEASE=R2023b MATLAB_PRODUCT_LIST="MATLAB Simulink" \
+  | env MATLAB_RELEASE=R2024b MATLAB_PRODUCT_LIST="MATLAB Simulink" \
     sudo python3 - \
     --admin admin_user:admin_password \
     --plugin tljh-matlab

install_guides/vscode/README.md

@@ -0,0 +1,57 @@
+# Run MATLAB in Jupyter Notebooks Using VS Code
+
+This guide shows how to run MATLAB® in Jupyter notebooks using Visual Studio® Code.
+
+## Setup
+
+1. Install [Jupyter Extension for VS Code](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter).
+
+2. Install [MATLAB Extension for VS Code](https://marketplace.visualstudio.com/items?itemName=MathWorks.language-matlab).
+
+3. Install the [MATLAB Integration for Jupyter](https://github.com/mathworks/jupyter-matlab-proxy) packages in your desired [Python environment (VS Code)](https://code.visualstudio.com/docs/python/environments):
+
+```bash
+python3 -m pip install jupyter-matlab-proxy
+install-matlab-kernelspec
+```
+
+4. Install MATLAB using [MATLAB Package Manager](https://www.mathworks.com/help/install/ug/get-mpm-os-command-line.html). Ensure that MATLAB is available on the system PATH from where you started VS Code.
+
+## Open a Jupyter Notebook and Select the MATLAB Kernel
+
+1. Create a Jupyter Notebook by running the `Create: New Jupyter Notebook` command from the Command Palette (`Ctrl+Shift+P`) or by creating a new `.ipynb` file in your workspace.
+
+2. To start a MATLAB Kernel in a notebook, click **Select Kernel**.
+
+    ![Kernel picker](./img/kernel-picker.png)
+
+3. Click **Jupyter Kernel**.
+
+    ![Click on Jupyter Kernel](./img/click-on-jupyter-kernel.png)
+
+4. Select a MATLAB Kernel from the list of  kernels in your Python environments.
+
+    ![Pick MATLAB Kernel](./img/pick-matlab-kernel.png)
+
+5. You see the name of your selected MATLAB kernel on the top right.
+
+    ![Selected Kernel](./img/selected-kernel.png)
+
+For more general information about using Jupyter Notebooks in VS Code, see [Create or Open a Jupyter Notebook (VS Code)](https://code.visualstudio.com/docs/datascience/jupyter-notebooks#_create-or-open-a-jupyter-notebook).
+
+## Run Cells
+
+To run a cell, click the **Run** button to the left.
+
+![Click to Run Cell](./img/play-button.png)
+
+The output of your code is displayed below.
+
+![Using MATLAB in Jupyter Notebook VSCode](./img/matlab.png)
+
+
+----
+
+Copyright 2025 The MathWorks, Inc.
+
+----