quick_start_guide.md

Quick Start Guide

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.0a55'

Jupyter Notebook

To install the widgets for the Jupyter Notebook with pip:

pip install 'itkwidgets[notebook]>=1.0a55'

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.0a55'

Then look for the ImJoy icon at the top in the Jupyter Notebook:

Google Colab

For Google Colab run:

pip install 'itkwidgets>=1.0a55'

Command Line (CLI)

pip install 'itkwidgets[cli]>=1.0a55'
playwright install --with-deps chromium

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

Notebook

In Jupyter, import the {py:obj}view <itkwidgets.viewer.view> function:

from itkwidgets import view

Then, call the {py:obj}view <itkwidgets.viewer.view> function at the end of a cell, passing in the image to examine:

view(image)

For information on additional options, see the {py:obj}view <itkwidgets.viewer.view> function docstring:

view?

CLI

itkwidgets path/to/image -b # open viewer in browser -OR-

itkwidgets path/to/image    # display preview in terminal

For information on additional options, see the help:

itkwidgets --help

See the deployments section for a more detailed overview of additional options as well as other ways to run and interact with the itkwidgets.