Skip to content

Commit 59bb0c9

Browse files
jcoadymwcraig
authored andcommitted
Create README.md
1 parent a8a00d9 commit 59bb0c9

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

labextension/vpython/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# vpython
2+
3+
VPython labextension
4+
5+
6+
## Prerequisites
7+
8+
* JupyterLab ^0.35.0
9+
* VPython Package >=7.4.8 (pip install vpython) or (conda install -c vpython vpython)
10+
11+
## Installation
12+
13+
```bash
14+
jupyter labextension install vpython
15+
```
16+
17+
## Development
18+
19+
For a development install use the instructions for creating a custom jupyter labextension as a guide:
20+
21+
https://jupyterlab.readthedocs.io/en/stable/developer/extension_tutorial.html#extension-tutorial
22+
23+
but taylor the instructions for creating a vpython labextension.
24+
25+
```bash
26+
jlpm install
27+
jlpm add @jupyterlab/application
28+
jlpm add @jupyterlab/apputils
29+
jlpm add @jupyterlab/coreutils
30+
jlpm add @jupyterlab/docregistry
31+
jlpm add @jupyterlab/notebook
32+
jlpm add @phosphor/disposable
33+
jlpm add script-loader
34+
35+
cp -r ../../vpython/vpython_{libraries,data} .
36+
jlpm run build
37+
jupyter labextension install .
38+
```
39+
40+
To rebuild the package and the JupyterLab app:
41+
42+
```bash
43+
jlpm run build
44+
jupyter lab build
45+
```

0 commit comments

Comments
 (0)