Metadata-Version: 2.4
Name: k3d
Version: 3.0.1
Dynamic: Author
Dynamic: Author-email
Dynamic: Summary
Dynamic: Project-URL
License: The MIT License
        
        Copyright © 2010-2024 K3D authors
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
License-File: LICENSE.txt
Keywords: Jupyter,JupyterLab,anywidget
Classifier: Framework :: Jupyter
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Requires-Dist: anywidget>=0.9.13
Requires-Dist: deepcomparer
Requires-Dist: ipywidgets<9.0.0,>=7.6.0
Requires-Dist: msgpack
Requires-Dist: numpy
Requires-Dist: traitlets
Requires-Dist: traittypes
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: flask; extra == 'dev'
Requires-Dist: jupyterlab; extra == 'dev'
Requires-Dist: notebook; extra == 'dev'
Requires-Dist: pixelmatch; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest-notebook; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: selenium; extra == 'dev'
Requires-Dist: webdriver-manager; extra == 'dev'
Provides-Extra: examples
Requires-Dist: flask; extra == 'examples'
Requires-Dist: matplotlib; extra == 'examples'
Requires-Dist: mdutils; extra == 'examples'
Requires-Dist: nibabel; extra == 'examples'
Requires-Dist: numba; extra == 'examples'
Requires-Dist: opencv-python; extra == 'examples'
Requires-Dist: pyunpack; extra == 'examples'
Requires-Dist: scikit-image; extra == 'examples'
Requires-Dist: scikit-learn; extra == 'examples'
Requires-Dist: scipy; extra == 'examples'
Requires-Dist: tqdm; extra == 'examples'
Requires-Dist: vtk; extra == 'examples'
Description-Content-Type: text/markdown

# K3D Jupyter

[![Downloads](https://static.pepy.tech/badge/k3d)](https://pepy.tech/project/k3d)
[![Downloads](https://static.pepy.tech/badge/k3d/month)](https://pepy.tech/project/k3d)
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/k3d/badges/downloads.svg)](https://anaconda.org/conda-forge/k3d)
[![CodeQL](https://github.com/K3D-tools/K3D-jupyter/workflows/CodeQL/badge.svg)](https://github.com/K3D-tools/K3D-jupyter/actions)
[![GitHub Sponsor](https://img.shields.io/github/sponsors/K3D-tools?label=Sponsor&logo=GitHub)](https://github.com/sponsors/K3D-tools)

<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, 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, volumes stay
outside the light simulation), and its API and output may still change; `simple` and
`advanced` are the stable choices. See
[Renderers](https://k3d-jupyter.org/user/renderers.html).

Documentation: [https://k3d-jupyter.org](https://k3d-jupyter.org)
</div>

## 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](imgs/advanced_curl_pearls.png)](https://k3d-jupyter.org/user/renderers.html)

`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](imgs/cinematic_dragon.png)](https://k3d-jupyter.org/user/cinematic.html)

`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](imgs/points_cloud.gif)

![streamlines](imgs/streamlines.gif)

![volume_rendering](imgs/vr.gif)

![volume_slide_view](imgs/volume_slide.gif)

![transfer_function_editor](imgs/tf_edit.gif)

### YouTube:

Click to watch at YouTube:

[![Volume renderer](https://i3.ytimg.com/vi/zCeQ_ZXy_Ps/maxresdefault.jpg)](https://www.youtube.com/watch?v=zCeQ_ZXy_Ps)

[![Volume renderer](https://i3.ytimg.com/vi/9evYSq3ieVs/maxresdefault.jpg)](https://www.youtube.com/watch?v=9evYSq3ieVs)

[![Volume renderer](https://i3.ytimg.com/vi/DbCiauTuJrU/maxresdefault.jpg)](https://www.youtube.com/watch?v=DbCiauTuJrU)

[![Volume renderer](https://i3.ytimg.com/vi/wIbBpUlB5vc/maxresdefault.jpg)](https://www.youtube.com/watch?v=wIbBpUlB5vc)

## Try it Now!

Watch: [Interactive showcase gallery](https://k3d-jupyter.org/gallery/index.html)

## 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

<table class="none">
<tr>
<td>
<img src="http://opendreamkit.org/public/logos/Flag_of_Europe.svg" width="128">
</td>
<td>
Research Infrastructure project
This package was created as part of the Horizon 2020 European
<a href="https://opendreamkit.org/">OpenDreamKit</a>
(grant agreement <a href="https://opendreamkit.org/">#676541</a>).
</td>
</tr>
</table>

