Skip to content

Installation

The Imaging Server Kit supports Python 3.10 to 3.13.

Installing with pip

Install the imaging-server-kit package with pip:

pip install imaging-server-kit

Optional dependencies

The Napari and QuPath integrations rely on extra packages that are not installed by default. Install them through the corresponding extras:

Command Adds
pip install "imaging-server-kit[napari]" Napari and napari-toolkit, for dock widgets and the Napari plugin
pip install "imaging-server-kit[qupath]" QuBaLab (>=0.2.0) and the Napari extra, for the QuPath integration
pip install "imaging-server-kit[all]" All the above, plus the documentation and test dependencies

Note

The qupath extra requires Python 3.11 or later, because of QuBaLab.

Development version

Clone the repository and install the package in editable mode:

git clone https://github.com/Imaging-Server-Kit/imaging-server-kit.git
cd imaging-server-kit
pip install -e ".[all]"

Next steps

Try the demos to get a first look at what the package can do.