Skip to main content

openreadout (Python)

Read raw lab-instrument files from Python without vendor software, Java or a C toolchain. The package wraps OpenReadout's Rust readers. It returns the same JSON as the openreadout command-line tool, and NumPy, dask or xarray arrays for pixels. The formats it reads are listed at https://openreadout.github.io/openreadout/formats.html.

pip install openreadout            # needs only NumPy
pip install 'openreadout[xarray]'  # adds dask and xarray for lazy, labelled arrays

One abi3 wheel per platform covers CPython 3.10 and newer on Linux (manylinux and musllinux, x86_64 and aarch64), macOS (x86_64 and arm64) and Windows (x64).

import openreadout

meta = openreadout.info("run42.czi")        # header-only summary, a dict
meta["images"][0]["size_c"], meta["images"][0]["physical_size"]

with openreadout.File("run42.czi") as f:
    plane = f.read_plane(image=0, c=1, z=4)   # np.ndarray (Y, X), or (Y, X, 3) for RGB
    stack = f.read_image(0)                   # np.ndarray (T, C, Z, Y, X[, S])
    lazy = f.to_dask(0)                       # dask array, one chunk per plane, read on demand
    xarr = f.to_xarray(0)                     # labelled: channel names, µm and s coordinates
    f.check()["ok"]                           # integrity report
    f.export("run42.ome.tiff")                # verified OME-TIFF; the source is never modified

Tables, traces and spectra (flow cytometry, electrophysiology, chromatography, mass spectrometry) are read with File.read_table, File.read_trace and File.read_spectrum, and convert to Arrow or pandas with File.to_arrow and File.to_pandas.

Arrays use the dimension order TCZYX, with S added for interleaved RGB. File objects are thread-safe and picklable, so lazy arrays work with dask's threaded, multiprocessing and distributed schedulers.

Every error is an openreadout.OpenReadoutError and also the closest built-in exception (for example FileNotFoundError or ValueError). It carries the command-line tool's code, exit_code and a hint.

bioio-openreadout plugs these readers into bioio.BioImage, and napari-openreadout into napari.

Guide and full API: https://openreadout.github.io/openreadout/guides/python.html. Source: https://github.com/openreadout/openreadout. Licensed MIT OR Apache-2.0. OpenReadout is not affiliated with any instrument vendor.

Metadata

Release files for openreadout 0.4.0

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

Source distribution (sdist)

Source distribution for openreadout 0.4.0
File Size Uploaded Provenance Actions
openreadout-0.4.0.tar.gz 4.3 MB With provenance Details for openreadout-0.4.0.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for openreadout 0.4.0
File Actions
openreadout-0.4.0-cp310-abi3-win_amd64.whl CPython 3.10 abi3 Windows x86-64 Details for openreadout-0.4.0-cp310-abi3-win_amd64.whl
openreadout-0.4.0-cp310-abi3-musllinux_1_2_x86_64.whl CPython 3.10 abi3 Linux musl 1.2+ x86-64 Details for openreadout-0.4.0-cp310-abi3-musllinux_1_2_x86_64.whl
openreadout-0.4.0-cp310-abi3-musllinux_1_2_aarch64.whl CPython 3.10 abi3 Linux musl 1.2+ ARM64 Details for openreadout-0.4.0-cp310-abi3-musllinux_1_2_aarch64.whl
openreadout-0.4.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.10 abi3 Linux glibc 2.17+ x86-64 Details for openreadout-0.4.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
openreadout-0.4.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl CPython 3.10 abi3 Linux glibc 2.17+ ARM64 Details for openreadout-0.4.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
openreadout-0.4.0-cp310-abi3-macosx_11_0_arm64.whl CPython 3.10 abi3 macOS 11.0+ ARM64 Details for openreadout-0.4.0-cp310-abi3-macosx_11_0_arm64.whl
openreadout-0.4.0-cp310-abi3-macosx_10_12_x86_64.whl CPython 3.10 abi3 macOS 10.12+ x86-64 Details for openreadout-0.4.0-cp310-abi3-macosx_10_12_x86_64.whl

Total release size: 154.2 MB

Release files / openreadout-0.4.0.tar.gz

Download URL openreadout-0.4.0.tar.gz
Size 4.3 MB
Tags Source
SHA-256 checksum
How to use checksums
7040cac2152c969954c3ae947d8c7d1f62767f3addbfb03344c2e89524045263
BLAKE2b-256 checksum
How to use checksums
04bba4cd694382cc549c798be9dab4a953ca1692dae99a024f4a54c79ce2e40c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Oct 18, 2026.

Transparency log

Release files / openreadout-0.4.0-cp310-abi3-win_amd64.whl

Download URL openreadout-0.4.0-cp310-abi3-win_amd64.whl
Size 23.3 MB
Tags CPython 3.10 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
2a49c65c3134612dfd3c63ed226f53081ff64320ea64e0f8284e4fe689082b61
BLAKE2b-256 checksum
How to use checksums
e0e504a837ffe2813df9bc25a4acc6a4614f181835729833d4e73f09bee15657
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Oct 18, 2026.

Transparency log

Release files / openreadout-0.4.0-cp310-abi3-musllinux_1_2_x86_64.whl

Download URL openreadout-0.4.0-cp310-abi3-musllinux_1_2_x86_64.whl
Size 22.4 MB
Tags CPython 3.10 Linux musl 1.2+ x86-64 abi3
SHA-256 checksum
How to use checksums
6bf91830c39c4e6ccfe766a55e379305f9717ecd6c40bc9e7d27d5af30c7851c
BLAKE2b-256 checksum
How to use checksums
894258142451111aad3c38f452dc7dd4c650bf756689743b77b5736fb436ce55
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Oct 18, 2026.

Transparency log

Release files / openreadout-0.4.0-cp310-abi3-musllinux_1_2_aarch64.whl

Download URL openreadout-0.4.0-cp310-abi3-musllinux_1_2_aarch64.whl
Size 20.4 MB
Tags CPython 3.10 Linux musl 1.2+ ARM64 abi3
SHA-256 checksum
How to use checksums
86f9d97d2b8f9c025262141b857ce40cda103a6cc11aa68122f43234dd6f9c0d
BLAKE2b-256 checksum
How to use checksums
24a30edf6ff8afcd07c8e864b2c2ad8c8d6fb76b6ac2f3a526372eafbf4fc9b9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Oct 18, 2026.

Transparency log

Release files / openreadout-0.4.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL openreadout-0.4.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 22.2 MB
Tags CPython 3.10 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
2bca446238e525b44576272831e8987977138dbd07bef545d3e7f626c699133a
BLAKE2b-256 checksum
How to use checksums
2fda3d3bd7237fde9f7c46ad9deb77a841205199b8a03c7a5f5322d4424d94d9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Oct 18, 2026.

Transparency log

Release files / openreadout-0.4.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

Download URL openreadout-0.4.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Size 20.2 MB
Tags CPython 3.10 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
64130dbe3d7607dfee697ca032cc6c2e7e0aae589df89f43bf8d6b0ba4f9f904
BLAKE2b-256 checksum
How to use checksums
755936a7f6750502bd522be0f2f5807867dd6594b19f1ac27525c152dd6ac5db
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Oct 18, 2026.

Transparency log

Release files / openreadout-0.4.0-cp310-abi3-macosx_11_0_arm64.whl

Download URL openreadout-0.4.0-cp310-abi3-macosx_11_0_arm64.whl
Size 19.8 MB
Tags CPython 3.10 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
a023c95870641bffbbae4b5abe2c695c90f7629e5403261dba3e5ccf5bd1270a
BLAKE2b-256 checksum
How to use checksums
131cdc0d5f6ba16521c16a2949f8a918506e8ec5a86973786a9980adfe087186
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Oct 18, 2026.

Transparency log

Release files / openreadout-0.4.0-cp310-abi3-macosx_10_12_x86_64.whl

Download URL openreadout-0.4.0-cp310-abi3-macosx_10_12_x86_64.whl
Size 21.5 MB
Tags CPython 3.10 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
0a533ca144dbf253778bd9a363bdd34dc9efeaae2e1cd174cc9f4ac72b86e83f
BLAKE2b-256 checksum
How to use checksums
31848634730fff7ba81b5b22343566b935c2b48d9ca929df2c7442a12eaf93b8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Oct 18, 2026.

Transparency log

Security for openreadout 0.4.0

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

All 8 files in this release have been uploaded with provenance metadata.

Select from 8 files

Attestation for openreadout-0.4.0.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 Oct 18, 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.

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