Skip to main content

ngio - Next Generation file format IO

License PyPI Python Version CI codecov

ngio is a Python library designed to simplify bioimage analysis workflows, offering an intuitive interface for working with OME-Zarr files.

What is ngio?

ngio is built for the OME-Zarr file format, a modern, cloud-optimized format for biological imaging data. OME-Zarr stores large, multi-dimensional microscopy images and metadata in an efficient and scalable way.

ngio's mission is to streamline working with OME-Zarr files by providing a simple, object-based API for opening, exploring, and manipulating OME-Zarr images and high-content screening (HCS) plates. It also offers comprehensive support for labels, tables and regions of interest (ROIs), making it easy to extract and analyze specific regions in your data.

Key Features

🔍 Simple Object-Based API

  • Easily open, explore, and manipulate OME-Zarr images and HCS plates
  • Create and derive new images and labels with minimal boilerplate code

📊 Rich Tables and Regions of Interest (ROI) Support

  • Tight integration with tabular data
  • Extract and analyze specific regions of interest
  • Store measurements and other metadata in the OME-Zarr container
  • Extensible & modular allowing users to define custom table schemas and on disk serialization

🔄 Scalable Data Processing

  • Powerful iterators for building scalable and generalizable image processing pipelines
  • Extensible mapping mechanism for custom parallelization strategies

Installation

You can install ngio via pip:

pip install ngio

To get started check out the Quickstart Guide.

Supported OME-Zarr versions

ngio supports OME-Zarr v0.4/v0.5. Support for version 0.6 and higher is planned for future releases.

Development Status

ngio is under active development and is not yet stable. The API is subject to change, and bugs and breaking changes are expected. We follow Semantic Versioning. Which means for 0.x releases potentially breaking changes can be introduced in minor releases.

Available Features

  • ✅ OME-Zarr metadata handling and validation
  • ✅ Image and label access across pyramid levels
  • ✅ ROI and table support
  • ✅ Image processing iterators
  • ✅ Streaming from remote sources
  • ✅ Documentation and examples

Upcoming Features

  • Enhanced performance optimizations (parallel iterators, optimized io strategies)

Contributors

ngio is developed at the BioVisionCenter, University of Zurich, by @lorenzocerrone and @jluethi.

License

ngio is released under the BSD-3-Clause License. See LICENSE for details.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ngio-0.5.14.tar.gz (464.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ngio-0.5.14-py3-none-any.whl (239.3 kB view details)

Uploaded Python 3

File details

Details for the file ngio-0.5.14.tar.gz.

File metadata

  • Download URL: ngio-0.5.14.tar.gz
  • Upload date:
  • Size: 464.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for ngio-0.5.14.tar.gz
Algorithm Hash digest
SHA256 43ca3d580f0f6ce889c3dde48d1d513a98bf0ff4c5b1a8e0a220577dc2b614f8
MD5 1d0037d3b1ba914d2edad601d884756b
BLAKE2b-256 28828f435afb7e0b5234ac8272769e640f104a40236ef77b3fa3b3e51d23d905

See more details on using hashes here.

Provenance

The following attestation bundles were made for ngio-0.5.14.tar.gz:

Publisher: ci.yml on BioVisionCenter/ngio

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ngio-0.5.14-py3-none-any.whl.

File metadata

  • Download URL: ngio-0.5.14-py3-none-any.whl
  • Upload date:
  • Size: 239.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for ngio-0.5.14-py3-none-any.whl
Algorithm Hash digest
SHA256 618b644615decf2a8f2bc758c815047295788eb7e1c3e2541a1ee2c457da533f
MD5 9391451c4583f61331ffb64a8d4b451a
BLAKE2b-256 9b1df14aa9ee774ed4ce563ac0485c119e2fc29e7436e3d2b9ef7b66112f56e4

See more details on using hashes here.

Provenance

The following attestation bundles were made for ngio-0.5.14-py3-none-any.whl:

Publisher: ci.yml on BioVisionCenter/ngio

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page