File tree Expand file tree Collapse file tree 3 files changed +72
-2
lines changed Expand file tree Collapse file tree 3 files changed +72
-2
lines changed Original file line number Diff line number Diff line change
1
+
2
+ Developer install
3
+ =================
4
+
5
+
6
+ To install a developer version of pythreejs, you will first need to clone
7
+ the repository::
8
+
9
+ git clone https://github.com/jovyan/pythreejs
10
+ cd pythreejs
11
+
12
+ Next, install it with a develop install using pip::
13
+
14
+ pip install -e .
15
+
16
+
17
+ If you are not planning on working on the JS/frontend code, you can
18
+ simply install the extensions as you would for a :ref: `normal install<installation> `.
19
+ For a JS develop install, you should link your extensions::
20
+
21
+ jupyter nbextension install [--sys-prefix / --user / --system] --symlink --py pythreejs
22
+
23
+ jupyter nbextension enable [--sys-prefix / --user / --system] --py pythreejs
24
+
25
+ with the `appropriate flag `_. Or, if you are using Jupyterlab::
26
+
27
+ jupyter labextension link ./js
28
+
29
+
30
+ .. links
31
+
32
+ .. _`appropriate flag` : https://jupyter-notebook.readthedocs.io/en/stable/extending/frontend_extensions.html#Installing-and-enabling-extensions
Original file line number Diff line number Diff line change
1
+
2
+ .. _installation :
3
+
4
+ Installation
5
+ ============
6
+
7
+
8
+ The simplest way to install pythreejs is via pip::
9
+
10
+ pip install pythreejs
11
+
12
+ or via conda::
13
+
14
+ conda install pythreejs
15
+
16
+
17
+ If you installed via pip, you will also have to install / configure the
18
+ front-end extension as well. If you are using classic notebook (as opposed to
19
+ Jupyterlab), run::
20
+
21
+ jupyter nbextension install [--sys-prefix / --user / --system] --py pythreejs
22
+
23
+ jupyter nbextension enable [--sys-prefix / --user / --system] --py pythreejs
24
+
25
+ with the `appropriate flag `_. If you are using Jupyterlab, install the extension
26
+ with::
27
+
28
+ jupyter labextension install jupyter-threejs
29
+
30
+ If you are installing using conda, these commands should be unnecessary, but If
31
+ you need to run them the commands should be the same (just make sure you choose the
32
+ `--sys-prefix ` flag).
33
+
34
+
35
+ .. links
36
+
37
+ .. _`appropriate flag` : https://jupyter-notebook.readthedocs.io/en/stable/extending/frontend_extensions.html#Installing-and-enabling-extensions
Original file line number Diff line number Diff line change @@ -17,12 +17,13 @@ Renderer classes
17
17
While the :py:class: `~pythreejs.WebGLRenderer ` class mimics its three.js
18
18
counterpart in only rendering frames on demand (one frame per call to its
19
19
:py:meth: `~pythreejs.WebGLRenderer.render ` method), the :py:class: `~pythreejs.Renderer ` class
20
- sets up an interactive render loop allowing for `interactive controls `_ and `animation `_.
20
+ sets up an interactive render loop allowing for
21
+ :ref: `interactive_controls ` and :ref: `animation `.
21
22
Similarly, a :py:class: `~pythreejs.Preview ` widget allows for a quick visualization of various
22
23
threejs objects.
23
24
24
25
25
- .. _ interactive controls :
26
+ .. _ interactive_controls :
26
27
27
28
Interactive controls
28
29
--------------------
You can’t perform that action at this time.
0 commit comments