Skip to content

Commit

Permalink
Updates jupyterlab install instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
Prabhakar Kumar committed Feb 7, 2024
1 parent 34f1887 commit 1d8586b
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,22 +65,17 @@ Install this Python package from the Python Package Index (PyPI) or build it fro
### Install from PyPI

```bash
python3 -m pip install jupyter-matlab-proxy
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.

The package lets you execute MATLAB code in both JupyterLab 3 and JupyterLab 4, but syntax highlighting and auto indentation are currently only supported on JupyterLab 3. Install JupyterLab 3 using:
```bash
python3 -m pip install 'jupyterlab>=3.0.0,<4.0.0a0'
```

### 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
python3 -m pip install .
python -m pip install .
```

### Integration with JupyterHub
Expand All @@ -104,16 +99,18 @@ This section shows you how to:
2. [Open MATLAB in a Browser](#open-matlab-in-a-browser)
3. [Edit MATLAB files in JupyterLab](#edit-matlab-files-in-jupyterlab)

Install the Jupyter Notebook or JupyterLab based on your preference
Install Jupyter Notebook or JupyterLab:

```bash
# For Jupyter Notebook
python -m pip install notebook
# For JupyterLab
python -m pip install jupyterlab
# For JupyterLab 3
python -m pip install 'jupyterlab>=3.0.0,<4.0.0a0'
```

Note: the package allows you to execute MATLAB code in both JupyterLab 3 and JupyterLab 4, but syntax highlighting and auto indentation are currently only supported on JupyterLab 3. To upgrade to JupyterLab 4, run `python -m pip install --upgrade jupyterlab`.

Open your Jupyter environment by starting Jupyter Notebook or JupyterLab.

```bash
Expand Down

0 comments on commit 1d8586b

Please sign in to comment.