Skip to content

Commit b7d03b5

Browse files
pauldrucePrabhakar Kumar
authored and
Prabhakar Kumar
committed
README updates.
1 parent 7460429 commit b7d03b5

File tree

3 files changed

+6
-35
lines changed

3 files changed

+6
-35
lines changed

limitations.md renamed to Limitations.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Limitations
22

3-
This package has some constraints and limitations:
3+
This package has some constraints and limitations:
44

55
* 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.
66

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

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

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

2121
* 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:
2222
|![truncation-issue](https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/truncation-issue.png)|
@@ -47,6 +47,6 @@ This package has some constraints and limitations:
4747

4848
----
4949

50-
Copyright 2023 The MathWorks, Inc.
50+
Copyright 2023-2024 The MathWorks, Inc.
5151

5252
----

MATLAB-Licensing-Info.md

-29
This file was deleted.

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ From your Jupyter notebook or JupyterLab, you can also open the MATLAB developme
4848
* System dependencies required to run MATLAB:
4949
- 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.
5050

51-
* Linux based systems also require `X Virtual Frame Buffer (Xvfb)`, which you can install with:
51+
* Linux based systems also require `X Virtual Frame Buffer (Xvfb)`, which you can install with:
5252

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

8787
### Using Simulink
8888

89-
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).
89+
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).
9090

9191
### Troubleshooting
9292

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

197197
## Limitations
198198

199-
* 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).
199+
* 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).
200200

201201
* 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]`.
202202

0 commit comments

Comments
 (0)