Skip to content

Commit 94cb944

Browse files
committed
Add dev install instructions
1 parent d5efeb1 commit 94cb944

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,33 @@ controls available to zoom and rotate the camera:
4040
Shift-drag to pan left/right and up/down.
4141
Touch screen: pinch/extend to zoom, swipe or two-finger rotate.
4242

43-
Currently, to re-run a VPython program in a Jupyter notebook you need to click the circular arrow icon to "restart the kernel" and then click the red-highlighted button, then click in the first cell, then click the run icon. Alternatively, if you insert "scene = canvas()" at the start of your program, you can rerun the program without restarting the kernel.
43+
Currently, to re-run a VPython program in a Jupyter notebook you need to click the circular arrow icon to "restart the kernel" and then click the red-highlighted button, then click in the first cell, then click the run icon. Alternatively, if you insert `scene = canvas()`` at the start of your program, you can rerun the program without restarting the kernel.
4444

4545
Run example VPython programs: [![Binder](http://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/BruceSherwood/vpython-jupyter/7.4.7?filepath=index.ipynb)
4646

47+
## Installation for developers from package source
48+
49+
You should install Cython (`conda install cython` or `pip install cython`) so
50+
that the fast version of the vector class can be generated and compiled. You
51+
may also need to install a compiler (command line tools on Mac, community
52+
edition on Visual Studio on Windows).
53+
54+
If you don't have a compilier vpython should still work, but code that
55+
generates a lot of vectors may run a little slower.
56+
57+
To install vpython from source run this command from the source directory
58+
after you have downloaded it:
59+
60+
```
61+
pip install -e .
62+
```
63+
64+
The `-e` option installs the code with symbolic links so that change you make
65+
show up without needing to reinstall.
66+
67+
If you also need the JupyterLab extension, please see the instructions
68+
in the `labextension` folder.
69+
4770
## vpython build status (for the vpython developers)
4871

4972
[![Build Status](https://travis-ci.com/vpython/vpython-jupyter.svg?branch=master)](https://travis-ci.com/vpython/vpython-jupyter) [![Build status](https://ci.appveyor.com/api/projects/status/mb3y238y1eae7xnh?svg=true)](https://ci.appveyor.com/project/vpython/vpython-jupyter)

0 commit comments

Comments
 (0)