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 — iterators for building pipelines that generalise from a single ROI to a full plate, with a pluggable mapping mechanism for parallelisation.
- 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.
Documentation
Full documentation, including guides, tutorials and the API reference, is at biovisioncenter.github.io/ngio. The 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.
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ngio-1.0.0.tar.gz.
File metadata
- Download URL: ngio-1.0.0.tar.gz
- Upload date:
- Size: 604.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
466bf21ab23e2e104e045bfc8e9173bbbd9dd2df4cc0535b06bf881eea7b87a1
|
|
| MD5 |
eff2982f81417fa31a6416c4fed62db4
|
|
| BLAKE2b-256 |
48e23695c7659dcfc21d2c7ebd3431d5af0bbb7b73aebbbc2ec717b164277c8f
|
Provenance
The following attestation bundles were made for ngio-1.0.0.tar.gz:
Publisher:
ci.yml on BioVisionCenter/ngio
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ngio-1.0.0.tar.gz -
Subject digest:
466bf21ab23e2e104e045bfc8e9173bbbd9dd2df4cc0535b06bf881eea7b87a1 - Sigstore transparency entry: 2302890700
- Sigstore integration time:
-
Permalink:
BioVisionCenter/ngio@882b31aaa6094690ef3638f15ec981f0c02a845f -
Branch / Tag:
refs/tags/v1.0.0 - Owner: https://github.com/BioVisionCenter
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@882b31aaa6094690ef3638f15ec981f0c02a845f -
Trigger Event:
push
-
Statement type:
File details
Details for the file ngio-1.0.0-py3-none-any.whl.
File metadata
- Download URL: ngio-1.0.0-py3-none-any.whl
- Upload date:
- Size: 251.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6596ceb0e5e8a9098a6f4d1dcf18fd5617080a566ae8b755322c6b5a37a45305
|
|
| MD5 |
98f77ed60a2f150b3efbec7d8869365c
|
|
| BLAKE2b-256 |
50dae73c44c88afbbce1514cdcad9c80c8b98655ff6876e7df31db007809ae2a
|
Provenance
The following attestation bundles were made for ngio-1.0.0-py3-none-any.whl:
Publisher:
ci.yml on BioVisionCenter/ngio
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ngio-1.0.0-py3-none-any.whl -
Subject digest:
6596ceb0e5e8a9098a6f4d1dcf18fd5617080a566ae8b755322c6b5a37a45305 - Sigstore transparency entry: 2302890752
- Sigstore integration time:
-
Permalink:
BioVisionCenter/ngio@882b31aaa6094690ef3638f15ec981f0c02a845f -
Branch / Tag:
refs/tags/v1.0.0 - Owner: https://github.com/BioVisionCenter
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@882b31aaa6094690ef3638f15ec981f0c02a845f -
Trigger Event:
push
-
Statement type:
