glue-k3d

  • Overview
  • Quickstart
  • Exporters
  • Viewers

Overview

glue-k3d is a plugin for the glue visualization software which connects glue to K3D-jupyter. This consists of two main pieces of functionality:

Standalone HTML Exporters

Export glue's 3D VisPy viewers directly to interactive K3D HTML pages. Exported HTML is standalone and can be used with any static file hosting service.

Viewers

Two experimental K3D-powered viewers which can be used with glue-jupyter: a 3D scatter viewer, and a 3D volume viewer. See the examples below for guidance on how to use these in your project.

Quickstart

glue-k3d is not (yet) available via pip, but you can install the package directly from our GitHub repository:

pip install git+https://github.com/glue-viz/glue-k3d.git

HTML Exporters

glue-K3D allows exporting views from glue's 3D VisPy-powered viewers directly to K3D. The exporter is exposed via a viewer tool in the "save" tool menu:

This is currently only supported in Qt glue, but Jupyter support is coming soon!

Below, see an example of a K3D figure created using glue! This figure shows a parsec-scale galactic 3D dustmap together with a point cloud representing the shell of the shell of the Local Bubble, whose expansion drives star formation near the Sun.

Viewers

glue-k3d contains two experimental K3D-powered viewers for use with glue-jupyter: a 3D scatter viewer and a 3D volume viewer. For examples of how to use these, see this notebook, which demonstrates necessary imports, viewer creation, and manipulating viewer options.