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.1.tar.gz (9.5 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: k3d-2.16.1.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.1.tar.gz
Algorithm Hash digest
SHA256 d4c6314c90fae1362869909d28c04a86e805b35d320ec78d44255090c568c609
MD5 0b2d618a0093cf08e0d4d1a27dc3e6ed
BLAKE2b-256 00a06dd916856ced070728a0fa8977028af396eac099a8fcf771bbf9bdb36a4a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: k3d-2.16.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d4f848b4bace684a33018711584f50f03e73be7db73a865fe70d833f0b1857b4
MD5 3d8c1f6b05ea195f2d951223df83180a
BLAKE2b-256 3b0edd497bcd3c9d23a22fef3ad82ed0c437f232af8093096e05396852ee7265

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