Awesome
K3D Jupyter
<div> <img src="https://k3d-jupyter.org/_static/logo.png" width="25%" align="right">K3D lets you create 3D plots backed by WebGL with high-level API (surfaces, isosurfaces, voxels, mesh, cloud points, vtk objects, volume renderer, colormaps, etc). The primary aim of K3D-jupyter is to be easy for use as stand alone package like matplotlib, but also to allow interoperation with existing libraries as VTK. K3D can be run as:
- Jupyter Notebook extension ๐
- Jupyter Lab extension ๐
- Google Colab extension ๐งช [still experimental]
- Standalone HTML/JS ๐
Documentation: https://k3d-jupyter.org
</div>Showcase:
YouTube:
Click to watch at YouTube:
Try it Now!
Watch: Interactive showcase gallery
Installation
PyPI
To install from PyPI use pip:
$ pip install k3d
Conda/Anaconda
To install from conda-forge use:
$ conda install -c conda-forge k3d
Google Colab
First you need to install k3d:
!pip install k3d
!jupyter nbextension install --py --user k3d
!jupyter nbextension enable --py --user k3d
After that you need to activate custom widgets and switch k3d to text protocol:
import k3d
from google.colab import output
output.enable_custom_widget_manager()
k3d.switch_to_text_protocol()
Installing directly from GitHub
To install directy from this repository (requires git and node.js + npm to build):
$ pip install git+https://github.com/K3D-tools/K3D-jupyter
This also makes possible installing the most up-to-date development version (same requirements):
$ pip install git+https://github.com/K3D-tools/K3D-jupyter@devel
To install any historical version, replace devel
above with any tag or commit hash.
Source
For a development installation (requires npm and node.js),
$ git clone https://github.com/K3D-tools/K3D-jupyter.git
$ cd K3D-jupyter
$ pip install -e .
Then, if required, JupyterLab installation:
$ jupyter labextension install ./js
Code of Conduct
K3D-jupyter follows the Python Software Foundation Code of Conduct in everything we do.
Kudos
- Travis is โค๏ธ
- OpenDreamKit is ๐
- Three.js is ๐ฅ