An elegant Python interface for visualization on the web platform to interactively generate insights into multidimensional images, point sets, and geometry.
Project description
itkwidgets
ITKWidgets is an elegant Python interface for visualization on the web platform to interactively generate insights into multidimensional images, point sets, and geometry.
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:
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:
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.
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
Built Distribution
File details
Details for the file itkwidgets-1.0a48.tar.gz.
File metadata
- Download URL: itkwidgets-1.0a48.tar.gz
- Upload date:
- Size: 10.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.18
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9f62fca7ac6843affe015c8e62bfad08c051cc500de4f40762725580e1f2f560 |
|
| MD5 | 6eafc776fc0173b5f27b9ae869fd6e6a |
|
| BLAKE2b-256 | ab673cceb5ae9e3f5ecdd1c8d8aa5439c505944ddca6cc500aa080ea1a8d7172 |
File details
Details for the file itkwidgets-1.0a48-py3-none-any.whl.
File metadata
- Download URL: itkwidgets-1.0a48-py3-none-any.whl
- Upload date:
- Size: 44.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.18
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a5b81ad24dbeaa4484179bfeb334e5994b60ba82d13e4273698dc9a530520bfc |
|
| MD5 | 66219ed915c531a1c6c7f64f102cb3d5 |
|
| BLAKE2b-256 | e8f89b73f5ea3f694d49e716bcf6f70c9f48830e0a0e7793e13b3abb8214fd6a |
