Welcome to ITKPythonPackage’s documentation!

This project provides a setup.py script to build ITK Python wheels and infrastructure to build ITK external module Python wheels.

ITK is an open-source, cross-platform system that provides developers with an extensive suite of software tools for image analysis.

To install the stable ITK Python package:

python -m pip install --upgrade pip
python -m pip install itk

The Python packages are built daily. To install the latest build from the ITK Git master branch:

python -m pip install --upgrade pip numpy
python -m pip install itk --upgrade --no-index \
  -f https://github.com/InsightSoftwareConsortium/ITKPythonPackage/releases/tag/latest

For more information on ITK’s Python wrapping, see an introduction in the ITK Software Guide. There are also many downloadable examples documented in Sphinx.

Contents

• Quick start guide
  • Installation
  • Usage
  • Mixing ITK and NumPy
  • Examples
• Build ITK Module Python packages
  • Prerequisites
  • Create the module
  • GitHub automated CI package builds
  • Automated platform scripts
  • Upload the packages to PyPI
• Build ITK Python packages
  • Prerequisites
  • Automated platform scripts
  • Manual builds
• Miscellaneous

Indices and tables

• Index
• Module Index
• Search Page