K3D Jupyter

Downloads Downloads Anaconda-Server Badge CodeQL GitHub Sponsor

K3D lets you create 3D plots backed by WebGL with high-level API (surfaces, isosurfaces, voxels, mesh, point clouds, vtk objects, volume renderer, colormaps, etc). The primary aim of K3D-jupyter is to be easy to use as a standalone package like matplotlib, but also to allow interoperation with existing libraries as VTK. K3D can be run as:

  • Jupyter Notebook / JupyterLab widget (anywidget) 🚀
  • Google Colab widget 🎉
  • VS Code notebooks 🧩
  • Standalone HTML/JS 📑

Since 3.0.0 a plot also chooses how it is lit, through plot.renderer: simple (the default rasteriser), advanced (image-based lighting with ambient occlusion) or cinematic (progressive path tracing). cinematic is experimental — it needs WebGL2 with renderable float textures, does not cover every object (volume_slice is not drawn, mip stays outside the light simulation, only the first volume is path traced), and its API and output may still change; simple and advanced are the stable choices. See Renderers.

Documentation: https://k3d-jupyter.org

Showcase:

Two frames from the renderers 3.0.0 added, both produced by the code in this repository — click either one for how it works.

Curl-noise pearls under the advanced renderer

advanced: image-based lighting and ambient occlusion. A million analytic sphere impostors, with the occlusion in the crevices between strands doing the sculpting.

The Stanford dragon, path traced

cinematic: progressive path tracing. 871k triangles read through VTK, 512 samples, lit only by an environment map — the shadow under the belly and the light the floor throws back into the flank are consequences of the simulation, not effects.

points_cloud

streamlines

volume_rendering

volume_slide_view

transfer_function_editor

YouTube:

Click to watch at YouTube:

Volume renderer

Volume renderer

Volume renderer

Volume renderer

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

Since 3.0.0 (the anywidget migration) no extra steps are needed:

!pip install k3d

import k3d and plot - custom widget activation and the text protocol are no longer required.

Installing directly from GitHub

To install directly 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 .

No separate JupyterLab extension step is needed - the widget ships its own frontend module (anywidget).

Code of Conduct

K3D-jupyter follows the Python Software Foundation Code of Conduct in everything we do.

Kudos

  • Jupyter is my ❤️
  • 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 links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for k3d from gravatar.com k3d

Credits

Author: k3d team

License expression

MIT
View SPDX License List

Requires

Python >=3.9

Provides Extra

dev examples

Tags

3d Jupyter JupyterLab anywidget numpy point-cloud visualization volume-rendering webgl

Classifiers

Report project as malware

Download files

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

Source Distribution

k3d-3.1.0.tar.gz (5.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

k3d-3.1.0-py3-none-any.whl (5.1 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: k3d-3.1.0.tar.gz
  • Upload date:
  • Size: 5.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.13

File hashes

Hashes for k3d-3.1.0.tar.gz
Algorithm Hash digest
SHA256 334b8f3a1462f06af9d94aa6f714891d52adbec49ad9706f94a65c462b7afb27
MD5 2e0432528f8ff206404ebbd397ce8865
BLAKE2b-256 0a9dea69c24cf56a4d84e5087198fc194f00dfa4798ca33370143da5fa6b2b6e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: k3d-3.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.13

File hashes

Hashes for k3d-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6a4a1af002065180d9959fd1b7c9d7c4001e4a3a0e4e9d05b88f3c51cc1e9915
MD5 9684e80ba06c66b75d5279721a317e51
BLAKE2b-256 efcb327c4bed9719f1bbed9223194e8777d389daa8e6dc49cef7b10d72007b0e

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

3.1.0 This release

2 files

3.0.3

2 files

3.0.2

2 files

3.0.1

2 files

3.0.0

2 files

2.18.1

2 files

2.18.0

2 files

2.17.0

2 files

2.16.1

2 files

2.16.0

2 files

2.15.3

2 files

2.15.2

2 files

Yanked

2.15.1

2 files

Yanked reason: Bug in code

2.15.0

2 files

2.14.5

2 files

2.14.4

2 files

2.14.3

2 files

2.14.2

2 files

2.14.1

2 files

2.14.0

2 files

2.13.1

2 files

2.13.0

2 files

2.12.0

2 files

2.11.0

2 files

2.10.0

2 files

2.9.7

2 files

2.9.6

2 files

2.9.5

2 files

2.9.4

2 files

2.9.3

2 files

2.9.2

2 files

2.9.1

2 files

2.9.0

2 files

2.8.2

2 files

2.8.1

2 files

2.8.0

2 files

2.7.4

2 files

2.7.3

2 files

2.7.2

2 files

2.7.1

2 files

2.7.0

2 files

2.6.10

2 files

2.6.9

2 files

2.6.8

2 files

2.6.7

2 files

2.6.6

2 files

2.6.5

2 files

2.6.4

2 files

2.6.3

2 files

2.6.2

2 files

2.6.1

2 files

2.6.0

2 files

2.5.5

2 files

2.5.3

2 files

2.5.2

2 files

2.5.1

2 files

2.5.0

2 files

2.4.21

2 files

2.4.20

2 files

2.4.19

2 files

2.4.18

2 files

2.4.17

2 files

2.4.16

2 files

2.4.15

2 files

2.4.14

2 files

2.4.9

2 files

2.4.8

2 files

2.4.7

2 files

2.4.6

2 files

2.4.5

2 files

2.4.4

2 files

2.4.3

2 files

2.4.2

2 files

2.4.1

2 files

2.4.0

2 files

2.0.12

2 files

2.0.11

2 files

2.0.10

2 files

2.0.9

2 files

2.0.8

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page