Skip to content

Commit

Permalink
README updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
pauldruce authored and Prabhakar Kumar committed Sep 2, 2024
1 parent 7460429 commit b7d03b5
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 35 deletions.
6 changes: 3 additions & 3 deletions limitations.md → Limitations.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Limitations

This package has some constraints and limitations:
This package has some constraints and limitations:

* Notebooks running on the same server share the same MATLAB process and workspace. It is currently not possible to have separate workspaces for each notebook.

Expand All @@ -16,7 +16,7 @@ This package has some constraints and limitations:

* Commands that create animations. For example: `movie`.

* **For MATLAB R2022a and earlier,** `lasterr` and `lasterror` do not capture MATLAB errors from execution in notebooks.
* **For MATLAB R2022a and earlier,** `lasterr` and `lasterror` do not capture MATLAB errors from execution in notebooks.

* Notebook results are truncated when there are more than 10 rows or 30 columns of results from MATLAB. This is represented by a `...` at the end of the result. For example:
|![truncation-issue](https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/truncation-issue.png)|
Expand Down Expand Up @@ -47,6 +47,6 @@ This package has some constraints and limitations:

----

Copyright 2023 The MathWorks, Inc.
Copyright 2023-2024 The MathWorks, Inc.

----
29 changes: 0 additions & 29 deletions MATLAB-Licensing-Info.md

This file was deleted.

6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ From your Jupyter notebook or JupyterLab, you can also open the MATLAB developme
* 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:
* Linux based systems also require `X Virtual Frame Buffer (Xvfb)`, which you can install with:

```bash
# On a Debian/Ubuntu based system:
Expand Down Expand Up @@ -86,7 +86,7 @@ To use MATLAB with JupyterHub, install the `jupyter-matlab-proxy` Python package

### 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).
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

Expand Down Expand Up @@ -196,7 +196,7 @@ This opens an untitled `.m` file where you can write MATLAB code with syntax hig

## 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).
* 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 `[email protected]`.

Expand Down

0 comments on commit b7d03b5

Please sign in to comment.