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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: itkwidgets-1.0a34.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.0a34.tar.gz
Algorithm Hash digest
SHA256 3221e39817582ea6aa53989a00522c31afa29d0d116dbb3ba82439638c1470b6
MD5 1e94539a4a9a12cffbd35a197bb0fea2
BLAKE2b-256 2f659c8f3daa364a79e690f4e63cfe29f2ca4e262668d16ac63252509a6d5484

See more details on using hashes here.

File details

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

File metadata

  • Download URL: itkwidgets-1.0a34-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.0a34-py3-none-any.whl
Algorithm Hash digest
SHA256 c6e4d6e71d6ef45d5b94b2eda8849e6e5b5572d504039d906c02136d8cdfd407
MD5 d04b6801ebc4c6f241612ba2c5dad60e
BLAKE2b-256 6d776cde7231ff13ccc2174324fcadff4c0bf920cfdd4a09879cf6bd4d294f11

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