README.rst

itk-jupyter-widgets

Interactive Jupyter widgets to visualize images in 2D and 3D.

These widgets are designed to support image analysis with the Insight Toolkit (ITK), but they also work with other spatial analysis tools in the scientific Python ecosystem.

These widgets are built on itk.js and vtk.js.

Installation

To install, use pip:

pip install itkwidgets
jupyter nbextension install --py --sys-prefix itkwidgets
jupyter nbextension enable --py --sys-prefix itkwidgets

Examples

After installation, try the following examples that demonstrate how to visualize:

• 2D ITK Images
• 3D ITK Images
• ImageJ ImgLib2 images (requires conda and a local Fiji installation)
• NumPy array images (processed with SciPy)
• VTK vtkImageData

Examples on Binder --------

• 3D ITK Images

Hacking

For a development installation (requires Node.js):

git clone https://github.com/InsightSoftwareConsortium/itk-jupyter-widgets.git
cd itk-jupyter-widgets
python -m pip install -r requirements-dev.txt -r requirements.txt
python -m pip install -e .
jupyter nbextension install --py --symlink --sys-prefix itkwidgets
jupyter nbextension enable --py --sys-prefix itkwidgets
jupyter nbextension enable --py --sys-prefix widgetsnbextension
python -m pytest

Warning

This project is under active development. Its API and behavior may change at any time. We mean it.