Home

Background

Cloud-native file streaming solutions (e.g. file writers) are essential for building efficient image data acquisition workflows, especially when acquiring more data than fits into memory or a single external hard drive. Zarr is a cloud-native data format that supports imaging data and has strong early adoption within the imaging community. The Acquire project developed this standalone Zarr streaming library with interfaces in both Python and C. This library easily integrates into custom acquisition workflows since it does not rely on runtime or hardware support.

Installation

Install the Python library

To install the acquire-zarr Python library on Windows, macOS, or Ubuntu, run the following command:

python -m pip install acquire-zarr

For more details, check out the Get Started page.

Build the C Library from Source

To build the C Library, follow these instructions.

Guides

Python API Reference

Information on classes and methods

Python API Reference

C Library Reference

Information on functions and structures

C Library Reference

Python Examples

Examples that demonstrate how to use the Python library

Python Examples

C Examples

Examples that demonstrate how to use the C Library

C Examples

Citing acquire-zarr

authors:
- affiliation: Chan Zuckerberg Initiative (United States)
  family-names: Liddell
  given-names: Alan
- affiliation: Chan Zuckerberg Initiative (United States)
  family-names: Eskesen
  given-names: Justin
- affiliation: Chan Zuckerberg Initiative (United States)
  family-names: Clack
  given-names: Nathan
  orcid: 0000-0001-6236-9282
cff-version: 1.2.0
date-released: '2025-02-06'
doi: 10.5280/zenodo.14828040
license:
- apache-2.0
title: 'acquire-zarr: Streaming directly to Zarr on the file system or cloud'
type: software

Acquire Zarr License

acquire-zarris provided under an Apache 2.0 license. Learn more about the Apache license.