Skip to main content

No project description provided

Project description

itkwidgets

Documentation Status Notebook tests

Interactive widgets to visualize images, point sets, and 3D geometry on the web.

Hello 3D World

Getting Started

Environment Setup

The EnvironmentCheck.ipynb checks the environment that you are running in to make sure that all required dependencies and extensions are correctly installed. Ideally run first before any other notebooks to prevent common issues around dependencies and extension loading.

Installation

To install for all environments:

pip install 'itkwidgets[all]>=1.0a23'

Jupyter Notebook

To install the widgets for the Jupyter Notebook with pip:

pip install 'itkwidgets[notebook]>=1.0a23'

Then look for the ImJoy icon at the top in the Jupyter Notebook:

ImJoy Icon in Jupyter Notebook

Jupyter Lab

For Jupyter Lab 3 run:

pip install 'itkwidgets[lab]>=1.0a23'

Then look for the ImJoy icon at the top in the Jupyter Notebook:

ImJoy Icon in Jupyter Lab

Google Colab

For Google Colab run:

pip install 'itkwidgets>=1.0a23'

Example Notebooks

Example Notebooks can be accessed locally by cloning the repository:

git clone -b main https://github.com/InsightSoftwareConsortium/itkwidgets.git

Then navigate into the examples directory:

cd itkwidgets/examples

Usage

In Jupyter, import the view function:

from itkwidgets import view

Then, call the view function at the end of a cell, passing in the image to examine:

view(image)

For information on additional options, see the view function docstring:

view?

See the deployments section for a more detailed overview of additional notebook options as well as other ways to run and interact with your notebooks.

Learn more

Visit the docs for more information on supported notebooks and integrations.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

itkwidgets-1.0a24.tar.gz (7.6 MB view details)

Uploaded Source

Built Distribution

itkwidgets-1.0a24-py3-none-any.whl (24.3 kB view details)

Uploaded Python 3

File details

Details for the file itkwidgets-1.0a24.tar.gz.

File metadata

  • Download URL: itkwidgets-1.0a24.tar.gz
  • Upload date:
  • Size: 7.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.7

File hashes

Hashes for itkwidgets-1.0a24.tar.gz
Algorithm Hash digest
SHA256 9b833cf0472ec25bad05dc56d38689d2124c88354b5343df1f0c30319fbab1df
MD5 095d175be69a4e3bbc4b2b7126534649
BLAKE2b-256 164bda12e14aa6dc73810dd3d68648b276dde93cf7e7cd4eaa75f8f2b1016c59

See more details on using hashes here.

File details

Details for the file itkwidgets-1.0a24-py3-none-any.whl.

File metadata

  • Download URL: itkwidgets-1.0a24-py3-none-any.whl
  • Upload date:
  • Size: 24.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.7

File hashes

Hashes for itkwidgets-1.0a24-py3-none-any.whl
Algorithm Hash digest
SHA256 8457ada1f860253ee9881425b94306d9d8d3d05d13de2e36b0e3e2ddd452270b
MD5 2d519c77383ad20027a9001df925c587
BLAKE2b-256 c9dc3504845528418aff0b71f4b622bb0e8e12adec2d8f2c1ba21d695b9ac6e6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page