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.0a33.tar.gz (7.6 MB view details)

Uploaded Source

Built Distribution

itkwidgets-1.0a33-py3-none-any.whl (25.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for itkwidgets-1.0a33.tar.gz
Algorithm Hash digest
SHA256 1afb0ff64a0318b43459249508a7028003b0f4403244e55aabe7adb0d1bb1aa7
MD5 4625d72d4a2e6c0baded9f7e80a0a5f1
BLAKE2b-256 180d3fc04f1e5f43749efa118159d0286b819b73ad3609150fe49e259f2a626d

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for itkwidgets-1.0a33-py3-none-any.whl
Algorithm Hash digest
SHA256 12c99a07b66b33f688e05b2d508bf8c1d03113bde5b29da3e2a0a5ddc822bd12
MD5 4caf0d52574d476c285449e0dd26ac3e
BLAKE2b-256 eb394a3acf3e0faa2525da7a54bc088dec0adf5d8edea99a15d0a79d295dafa4

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