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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: itkwidgets-1.0a31.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.0a31.tar.gz
Algorithm Hash digest
SHA256 f74848d1cd2bc41676a33e18c73e279ad9eeab67452f1953cf23ce8b21f1ab00
MD5 618b1bad9de3169bcac2948adbd8f15c
BLAKE2b-256 9c5515df96336bbc7470ed06e81d0666e8343f9681244fa3d8b8b4566da42d98

See more details on using hashes here.

File details

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

File metadata

  • Download URL: itkwidgets-1.0a31-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.0a31-py3-none-any.whl
Algorithm Hash digest
SHA256 c0a7cce703f8f2fce95d26ece9b2626200f2cdf8420c6660204d3d4dd3a8ff65
MD5 b61aa45a67126abb6359746f90bee255
BLAKE2b-256 28e0f273714c9aa8b96f4ccd46f94eabf7c142dfb0bb185a8a6a0d58b9e4bbd0

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