ome-zarr-converters-tools

License PyPI Python Version CI codecov

A Python library that provides shared utilities for building OME-Zarr image converters. It handles tile management, image registration, filtering, validation, and writing OME-Zarr datasets.

Features

  1. Abstraction layer for building OME-Zarr images and HCS plates from microscope metadata and image data
  2. Customizable pipeline for filtering, validating, registering, and tiling images
  3. Python API for building custom converters, with optional Fractal integration for parallel processing
  4. Flexible input: parse tiles from DataFrames or construct them programmatically

Architecture Diagram

OME-Zarr Converters Tools Architecture

Getting Started

Install via pip:

pip install ome-zarr-converters-tools

For converting data stored on S3 (s3:// URLs), install the s3 extra:

pip install "ome-zarr-converters-tools[s3]"

Quickstart

Convert a tiles table (one row per tile: stage position, size, and image file) into a single OME-Zarr image:

import pandas as pd

from ome_zarr_converters_tools import (
    AcquisitionDetails,
    AutoTiling,
    ChannelInfo,
    ConverterOptions,
    OverwriteMode,
    StagePositionCorrections,
    WriterMode,
    build_default_registration_pipeline,
    single_images_from_dataframe,
    tiled_image_creation_pipeline,
    tiles_aggregation_pipeline,
)

acq = AcquisitionDetails(
    channels=[ChannelInfo(channel_label="DAPI")],
    xy_pixel_size=0.65,  # micrometers
    z_spacing=1.0,
)
tiles = single_images_from_dataframe(
    tiles_table=pd.read_csv("tiles.csv"), acquisition_details=acq
)
options = ConverterOptions()
tiled_image = tiles_aggregation_pipeline(
    tiles=tiles, converter_options=options, resource="/path/to/image/files"
)[0]
tiled_image_creation_pipeline(
    zarr_url="/path/to/output.zarr",
    tiled_image=tiled_image,
    registration_pipeline=build_default_registration_pipeline(
        StagePositionCorrections(), AutoTiling()
    ),
    converter_options=options,
    writer_mode=WriterMode.BY_FOV,
    overwrite_mode=OverwriteMode.NO_OVERWRITE,
    resource="/path/to/image/files",
)

See the tutorials for HCS plates, custom image loaders, and Fractal tasks.

Documentation

For detailed documentation, tutorials, and API reference, visit the official documentation.

The documentation includes:

Project links

Data verified by PyPI on Jul 10, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.0.2)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for lorenzo.cerrone from gravatar.com lorenzo.cerrone

Credits

Author: Lorenzo Cerrone

GitHub Statistics

Data verified by PyPI on Jul 10, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

BSD License (BSD-3-Clause)

Requires

Python <3.15, >=3.11

Provides Extra

dev docs s3 test zarrs

Classifiers

Report project as malware

Download files

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

Source Distribution

ome_zarr_converters_tools-1.0.1.tar.gz (27.1 MB view details)

Uploaded Source

Built Distribution

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

ome_zarr_converters_tools-1.0.1-py3-none-any.whl (83.6 kB view details)

Uploaded Python 3

File details

Details for the file ome_zarr_converters_tools-1.0.1.tar.gz.

File metadata

File hashes

Hashes for ome_zarr_converters_tools-1.0.1.tar.gz
Algorithm Hash digest
SHA256 badf9c478af33f2f9486b716ce728f255bd070c30275e75b84b4228d45edcc35
MD5 ea81afe5675b7683c31f8c4e37d0a61d
BLAKE2b-256 77d30a2020efc68ccd0ff3dff06c4be71d02e4b8070ee610d2f3b3fc381371f9

See more details on using hashes here.

Provenance

The following attestation bundles were made for ome_zarr_converters_tools-1.0.1.tar.gz:

Publisher: ci.yml on BioVisionCenter/ome-zarr-converters-tools

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

File details

Details for the file ome_zarr_converters_tools-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ome_zarr_converters_tools-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1f70bb84bac6e6a1ab463c16ed77bfc720dd2e1502eb1c84b8660986489fd8ee
MD5 ce3841ed7068215f6089dbf09f4351df
BLAKE2b-256 3a3c6bcd8c8ccdc4a1ad131752e8cedf656f8ec834fca9b03dcf2a4204179e52

See more details on using hashes here.

Provenance

The following attestation bundles were made for ome_zarr_converters_tools-1.0.1-py3-none-any.whl:

Publisher: ci.yml on BioVisionCenter/ome-zarr-converters-tools

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

Supported by

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