itk-jupyter-widgets
===================

.. image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
:target: https://github.com/InsightSoftwareConsortium/itk-jupyter-widgets/blob/master/LICENSE
:alt: License

.. image:: https://img.shields.io/pypi/v/itkwidgets.svg
:target: https://pypi.python.org/pypi/itkwidgets
:alt: PyPI

.. image:: https://circleci.com/gh/InsightSoftwareConsortium/itk-jupyter-widgets.svg?style=shield
:target: https://circleci.com/gh/InsightSoftwareConsortium/itk-jupyter-widgets
:alt: Build status

.. image:: https://mybinder.org/badge.svg
:target: https://mybinder.org/v2/gh/InsightSoftwareConsortium/itk-jupyter-widgets/master?filepath=examples%2F3DImage.ipynb

Interactive `Jupyter <https://jupyter.org/>`_ widgets to visualize images in 2D and 3D.

.. image:: https://i.imgur.com/ERK5JtT.png
:width: 800px
:alt: Monkey brain volume rendering

These widgets are designed to support image analysis with the `Insight Toolkit
(ITK) <https://itk.org/>`_, but they also work with other spatial analysis tools
in the scientific Python ecosystem.

These widgets are built on
`itk.js <https://github.com/InsightSoftwareConsortium/itk-js>`_ and
`vtk.js <https://github.com/Kitware/vtk-js>`_.

.. image:: https://thumbs.gfycat.com/ShyFelineBeetle-size_restricted.gif
:width: 640px
:alt: itk-jupyter-widgets demo
:align: center

Installation
------------

To install, use pip::

pip install itkwidgets

Examples
--------

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

- `2D ITK Images <https://github.com/InsightSoftwareConsortium/itk-jupyter-widgets/blob/master/examples/2DImage.ipynb>`_
- `3D ITK Images <https://github.com/InsightSoftwareConsortium/itk-jupyter-widgets/blob/master/examples/3DImage.ipynb>`_
- `Dask Array images <https://github.com/InsightSoftwareConsortium/itk-jupyter-widgets/blob/master/examples/DaskArray.ipynb>`_
- `ImageJ ImgLib2 images <https://github.com/InsightSoftwareConsortium/itk-jupyter-widgets/blob/master/examples/ImageJImgLib2.ipynb>`_ (requires `conda <https://conda.io/>`_ and a local `Fiji <https://fiji.sc/>`_ installation)
- `NumPy array images <https://github.com/InsightSoftwareConsortium/itk-jupyter-widgets/blob/master/examples/NumPyArray.ipynb>`_ (processed with SciPy)
- `NumPy array images <https://github.com/InsightSoftwareConsortium/itk-jupyter-widgets/blob/master/examples/scikit-image.ipynb>`_ (processed with scikit-image)
- `VTK vtkImageData <https://github.com/InsightSoftwareConsortium/itk-jupyter-widgets/blob/master/examples/vtkImageData.ipynb>`_

Examples on Binder
--------

- `2D ITK Images <https://mybinder.org/v2/gh/InsightSoftwareConsortium/itk-jupyter-widgets/master?filepath=examples%2F2DImage.ipynb>`_
- `3D ITK Images <https://mybinder.org/v2/gh/InsightSoftwareConsortium/itk-jupyter-widgets/master?filepath=examples%2F3DImage.ipynb>`_
- `Dask Array images <https://mybinder.org/v2/gh/InsightSoftwareConsortium/itk-jupyter-widgets/master?filepath=examples/DaskArray.ipynb>`_
- `NumPy array images <https://mybinder.org/v2/gh/InsightSoftwareConsortium/itk-jupyter-widgets/master?filepath=examples/NumPyArray.ipynb>`_ (processed with SciPy)
- `NumPy array images <https://mybinder.org/v2/gh/InsightSoftwareConsortium/itk-jupyter-widgets/master?filepath=examples/scikit-image.ipynb>`_ (processed with scikit-image)

Troubleshooting
---------------

If you experience the notebook warning::

IOPub data rate exceeded.
The notebook server will temporarily stop sending output
to the client in order to avoid crashing it.
To change this limit, set the config variable
`--NotebookApp.iopub_data_rate_limit`.

Set the notebook configuration value::

jupyter notebook --NotebookApp.iopub_data_rate_limit=1e12

Hacking
-------

For a development installation (requires `Node.js <https://nodejs.org/en/download/>`_)::

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

The above commands will setup your system for development with the Jupyter
Notebook. To develop for Jupyter Lab, additionally run::

jupyter labextension install @jupyter-widgets/jupyterlab-manager
jupyter labextension install ./js

.. warning::

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


Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.32.6)

3 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for bnmajor from gravatar.com bnmajor Avatar for itkrobot from gravatar.com itkrobot Avatar for thewtex from gravatar.com thewtex

Credits

Author: Matthew McCormick

Tags

ipython jupyter jupyterlab-extension widgets itk imaging visualization 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

itkwidgets-0.10.2.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

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

itkwidgets-0.10.2-py2.py3-none-any.whl (3.2 MB view details)

Uploaded Python 2Python 3

File details

Details for the file itkwidgets-0.10.2.tar.gz.

File metadata

  • Download URL: itkwidgets-0.10.2.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for itkwidgets-0.10.2.tar.gz
Algorithm Hash digest
SHA256 451b8a26536e6a8823742896ae8a357a8eabbbdbfd0842c1265f94a9d1a8573e
MD5 523e1337132f0f76e5661c87e7070a7e
BLAKE2b-256 b76e11963bb3babdeeb4b42602e72902a97b6bd1d81e8089d928f3dc46a4a382

See more details on using hashes here.

File details

Details for the file itkwidgets-0.10.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for itkwidgets-0.10.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d8c7d5ed3a61af59cc41b73a5d22a035464449ab9d3d82ca52e99f0d8e8173e1
MD5 4d586598ca3d8abf6494ac15e909938e
BLAKE2b-256 856f5bd3e0c3aa1471f937b3f0892485d51d92010654293d363835478d972ab1

See more details on using hashes here.

Release history Release notifications | RSS feed

1.0a55 pre-release

1.0a54 pre-release

1.0a53 pre-release

1.0a52 pre-release

1.0a51 pre-release

1.0a50 yanked

Reason this release was yanked:

This was released with the wrong version.

1.0a49 pre-release

1.0a48 pre-release

1.0a47 pre-release

1.0a46 pre-release

1.0a45 pre-release

1.0a44 pre-release

1.0a43 pre-release

1.0a42 pre-release

1.0a41 pre-release

1.0a40 pre-release

1.0a39 pre-release

1.0a38 pre-release

1.0a37 pre-release

1.0a36 pre-release

1.0a35 pre-release

1.0a34 pre-release

1.0a33 pre-release

1.0a32 pre-release

1.0a31 pre-release

1.0a30 pre-release

1.0a29 pre-release

1.0a28 pre-release

1.0a27 pre-release

1.0a26 pre-release

1.0a25 pre-release

1.0a24 pre-release

1.0a23 pre-release

1.0a22 pre-release

1.0a21 pre-release

1.0a20 pre-release

1.0a19 pre-release

1.0a18 pre-release

1.0a17 pre-release

1.0a16 pre-release

1.0a15 pre-release

1.0a14 pre-release

1.0a13 pre-release

1.0a12 pre-release

1.0a11 pre-release

1.0a10 pre-release

1.0a9 pre-release

1.0a8 pre-release

1.0a7 pre-release

1.0a6 pre-release

1.0a5 pre-release

1.0a4 pre-release

1.0a3 pre-release

1.0a1 pre-release

1.0a0 pre-release

0.32.6

0.32.5

0.32.4

0.32.3

0.32.2

0.32.1

0.32.0

0.31.4

0.31.3

0.31.2

0.30.1

0.30.0

0.29.0

0.28.1

0.28.0

0.28.0.dev0 pre-release

0.27.5

0.27.4

0.27.3

0.27.2

0.27.1

0.27.0

0.26.1

0.26.0

0.25.3

0.25.2

0.25.1

0.25.0

0.24.2

0.24.1

0.24.0

0.23.1

0.23.0

0.22.0

0.21.1

0.20.0

0.19.0

0.18.0

0.17.1

0.17.0

0.16.3

0.16.2

0.16.1

0.16.0

0.15.2

0.15.1

0.15.0

0.14.0

0.13.2

0.13.1

0.13.0

0.12.2

0.12.1

0.12.0

0.11.0

This release

0.10.2

0.10.0

0.9.0

0.8.0

0.7.0

0.6.1

0.6.0

0.5.1

0.5.0

0.4.0

0.3.0

0.2.1

0.2.0

0.1.0

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page