Skip to main content

No project description provided

Project description

K3D Jupyter

Downloads Downloads Anaconda-Server Badge CodeQL

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

Showcase:

points_cloud

streamlines

volume_rendering

transfer_function_editor

YouTube:

Click to watch at YouTube:

Volume renderer

Volume renderer

Volume renderer

Volume renderer

Try it Now!

Watch: Interactive showcase gallery

Jupyter version: Binder

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 🥇

Acknowledgments

Research Infrastructure project This package was created as part of the Horizon 2020 European OpenDreamKit (grant agreement #676541).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

k3d-2.16.0.tar.gz (9.5 MB view details)

Uploaded Source

Built Distribution

k3d-2.16.0-py3-none-any.whl (23.1 MB view details)

Uploaded Python 3

File details

Details for the file k3d-2.16.0.tar.gz.

File metadata

  • Download URL: k3d-2.16.0.tar.gz
  • Upload date:
  • Size: 9.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for k3d-2.16.0.tar.gz
Algorithm Hash digest
SHA256 fcaec3e87f7d892f48aac3df8ff50a9fa27ac2752b9c38b345c515d83693cd03
MD5 c923b7270e094a16ddd474b914a40cd4
BLAKE2b-256 915104b781e6f84c26763b487c103696caa429383513abfb3ec35b22cc5751c0

See more details on using hashes here.

File details

Details for the file k3d-2.16.0-py3-none-any.whl.

File metadata

  • Download URL: k3d-2.16.0-py3-none-any.whl
  • Upload date:
  • Size: 23.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for k3d-2.16.0-py3-none-any.whl
Algorithm Hash digest
SHA256 131466b0d580c563abc63d93a1746518f74e0bae4732c95b38840a5f6a1974c9
MD5 261b3ef2b64933fa7e85403b06b586e8
BLAKE2b-256 71b7f63b644a223704a0adc3d46507b9146c9df52fb93965629b5b31eb144fdb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page