Skip to main content

License PyPI Python Version CI codecov

Next generation file format IO — a Python library for OME-Zarr bioimage analysis.

ngio is built for OME-Zarr, a cloud-optimised format that stores large, multi-dimensional microscopy images and their metadata in an efficient, scalable way. It provides an object-based API for opening, exploring and manipulating OME-Zarr images and high-content screening (HCS) plates, along with labels, tables and regions of interest (ROIs) for extracting and analysing specific regions of your data.

Installation

To install ngio, use whichever package manager you already work with — it is published on both PyPI and conda-forge.

pip install ngio                    # pip
uv add ngio                         # uv project (or: uv pip install ngio)
pixi add ngio                       # pixi, from conda-forge (--pypi for PyPI)
mamba install -c conda-forge ngio   # mamba/conda

Then work through the quickstart.

Key features

  • Object-based API — open, explore and manipulate OME-Zarr images and HCS plates; derive new images and labels with minimal boilerplate.
  • Tables and ROIs — tight integration with tabular data, extensible table schemas, and measurements stored alongside the image.
  • Scalable processing — five iterators (image processing, segmentation, masked segmentation, feature extraction, object detection) that scale a per-region function from one ROI to a full plate: serial, threaded, multi-process, batched for neural networks, or split across cluster jobs — with halos for seamless tiles and stitching for objects split across tile boundaries.
  • Remote stores — stream from S3 and other fsspec-backed sources, with a configurable IO retry policy.
  • Supported OME-Zarr versions — ngio supports OME-Zarr v0.4 and v0.5, backed by either Zarr v2 or v3 storage. Support for v0.6 and later is planned.

Versioning

ngio follows semantic versioning: from 1.0 onwards the public API is stable, and breaking changes are reserved for major releases. The one carve-out is the structural protocols — MapperProtocol, TransformProtocol, and MergePolicy: implementing them pins you to the documented contract, which minor releases may extend with optional members.

Documentation

Full documentation, including guides, tutorials and the API reference, is at biovisioncenter.github.io/ngio. The tutorials' worked examples are executed when the site is built, so the code and the output you read are what actually ran.

Citing ngio

If ngio contributes to work you publish, please cite it. See CITATION.cff for the current citation metadata.

Project

ngio is developed at the BioVisionCenter, University of Zurich, by @lorenzocerrone and @jluethi. It is released under the BSD-3-Clause licence, and developed in the open on GitHub — issues and contributions welcome.

Metadata

Release files for ngio 1.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ngio 1.1.4
File Size Uploaded Provenance Actions
ngio-1.1.4.tar.gz 903.9 kB With provenance Details for ngio-1.1.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ngio 1.1.4
File Interpreter ABI Platform Actions
ngio-1.1.4-py3-none-any.whl Python 3 none any Details for ngio-1.1.4-py3-none-any.whl

Total release size: 1.3 MB

Release files / ngio-1.1.4.tar.gz

Download URL ngio-1.1.4.tar.gz
Size 903.9 kB
Tags Source
SHA-256 checksum
How to use checksums
02a8f644a282ea332c437d116a96bb3d64656d016656126405e66ff882456b1f
BLAKE2b-256 checksum
How to use checksums
bbb9842d6cdc9261fd938ca5b69a0f7597a5face65a42718212a4b6b11157cb7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.

Transparency log

Release files / ngio-1.1.4-py3-none-any.whl

Download URL ngio-1.1.4-py3-none-any.whl
Size 386.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e35bb322029ac47d3bc85155ade0b53563b2a178947a7fae5783047ab22dd7ca
BLAKE2b-256 checksum
How to use checksums
f6ebc2e7f890c5c3a015677fcdcb2f81c8a8ea473fa8376c2263d7c7e2fd4508
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.

Transparency log

Security for ngio 1.1.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for ngio-1.1.4.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.1.4 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page