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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: itkwidgets-1.0a28.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.0a28.tar.gz
Algorithm Hash digest
SHA256 f72c88cb71f4bfc15a6020ef9158980388b841eb61ee398b32d18bb664d0db0e
MD5 4527bf8d531b13e55a355ec5d5b84421
BLAKE2b-256 254782dae6adf24aaae41454c8b334e582af94abea704179dc1520d6d3adc3df

See more details on using hashes here.

File details

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

File metadata

  • Download URL: itkwidgets-1.0a28-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.0a28-py3-none-any.whl
Algorithm Hash digest
SHA256 fbf3eec198bc9b69f7929117abd2dd38ea602432e656f4ee25e70fbd030ada1e
MD5 e97e0f293b25ada3d040178bb24308e8
BLAKE2b-256 d3ea5248ba659ae7c7fc1518aff3b6be93c245b040ead30bc3f1cb8bbca60327

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