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

Uploaded Source

Built Distribution

itkwidgets-1.0a35-py3-none-any.whl (33.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for itkwidgets-1.0a35.tar.gz
Algorithm Hash digest
SHA256 c562d1666b6381b27c98d62d9cb7aed5eedc18627750d476d3cf270314ac6e53
MD5 d84c4e003dc49fd56c0c3a9fd30bc96e
BLAKE2b-256 84404f420aeeb30d8210aa796fead630108538a6af83d5d05bbf517bda18a188

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for itkwidgets-1.0a35-py3-none-any.whl
Algorithm Hash digest
SHA256 7c2ae5c29432684edcecce0ec00e70841b409ec702c80a9f0e36043e15736c22
MD5 e667f8238c9f323a1c21072e1c208aec
BLAKE2b-256 d1bbf66cc7169eebf53915100925bf54050af6fb1bce643a2663987a794378b7

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