Interactive 3D graphics for the Jupyter Notebook and JupyterLab, using Three.js and Jupyter Widgets.
Project description
pythreejs
A Python / ThreeJS bridge for Jupyter Widgets.
Installation
Using pip:
pip install pythreejs
or conda:
conda install -c conda-forge pythreejs
For a development install, see the contributing guide.
The extension should then be installed automatically for your Jupyter client.
For JupyterLab
<3, you may also need to ensurenodejsis installed, and rebuild the application:# conda install -c cond-forge 'nodejs>=12' jupyter lab build
Troubleshooting
If the extension is not automatically installed, you can manually enable it
Jupyter Notebook Classic
jupyter nbextension list
jupyter nbextension install --py --symlink --sys-prefix pythreejs
jupyter nbextension enable --py --sys-prefix pythreejs
jupyter nbextension list
You should see:
Known nbextensions:
...
jupyter-js-widgets/extension enabled
- Validating: OK
Note for developers: the
--symlinkargument on Linux or MacOS allows one to modify the JavaScript code in-place. This feature is not available on Windows.
JupyterLab
To perform a source installation:
## ensure you have nodejs install, e.g. with conda
# conda install -c conda-forge 'nodejs>=12'
jupyter labextension list
jupyter labextension install --no-build @jupyter-widgets/jupyterlab-manager
jupyter labextension install --no-build jupyter-datawidgets/extension
jupyter labextension install jupyter-threejs
jupyter labextension list
You should see:
JupyterLab v...
...
jupyterlab-datawidgets v... enabled OK
@jupyter-widgets/jupyterlab-manager v... enabled OK
jupyter-threejs v... enabled OK
This approach is not recommended for JupyterLab 3, which enables federated modules, installed via
pip,condaor other package managers, and does not require rebuilding the entire application.
Uninstallation
Using pip:
pip uninstall pythreejs
or conda:
conda uninstall pythreejs
If you applied any manual steps above, it may be necessary to remove the
Jupyter Notebook Classic
jupyter nbextension disable --py --sys-prefix pythreejs
Jupyter Lab
jupyter labextension uninstall jupyter-threejs
Open Source
This software is licensed under the BSD-3-Clause License.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pythreejs-2.4.2.tar.gz.
File metadata
- Download URL: pythreejs-2.4.2.tar.gz
- Upload date:
- Size: 4.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a568bfdc4c3797c4c2339158928edc7dcf6fa4a267b08e3cec5121e2078b5bd6 |
|
| MD5 | b4064be2f60ee1bb09fcce763fdf3bb0 |
|
| BLAKE2b-256 | 0a2e0ec94286b8eb3fe1200700080e8adb2c8d871bb8db589858a49600d97a7d |
File details
Details for the file pythreejs-2.4.2-py3-none-any.whl.
File metadata
- Download URL: pythreejs-2.4.2-py3-none-any.whl
- Upload date:
- Size: 3.4 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8418807163ad91f4df53b58c4e991b26214852a1236f28f1afeaadf99d095818 |
|
| MD5 | cb04d63cce48967f859aa415a3830440 |
|
| BLAKE2b-256 | d88be2bbeb42068f0c48899e8eddd34902afc0f7429d4d2a152d2dc2670dc661 |
