bioio-openreadout
A bioio reader plugin that reads microscopy files with OpenReadout's Rust readers. It is licensed MIT OR Apache-2.0 and depends on no GPL plugin, vendor SDK or Java. Wheels need no compiler. Each plane is one dask chunk and is decoded only when a computation needs it.
pip install bioio bioio-openreadout
from bioio import BioImage
import bioio_openreadout
img = BioImage("run42.czi", reader=bioio_openreadout.Reader)
img.scenes # ('P2', 'P3', 'P1') — one per CZI scene / ND2 position / LIF series
img.dims # <Dimensions [T: 1, C: 3, Z: 5, Y: 325, X: 475]>
img.channel_names # ['EGFP', 'TaRFP', 'Bright']
img.physical_pixel_sizes # PhysicalPixelSizes(Z=1.0, Y=1.083, X=1.083) (µm)
img.set_scene(1)
zyx = img.get_image_dask_data("ZYX", T=0, C=1).compute() # decodes 5 planes, not the file
img.ome_metadata # ome_types.OME built from the normalized metadata
BioImage(path) without reader= also works for .czi, .nd2, .lif, .vsi, .svs, .ndpi, .qptiff, .ims, .oir, .oib, .oif and .zvi: the plugin registers these extensions through the bioio.readers entry point. Other formats OpenReadout reads, such as OME-TIFF or OME-Zarr, open with reader=bioio_openreadout.Reader. When another plugin for the same extension is installed (for example bioio-nd2), bioio's own ordering decides which is tried first; pass reader= to choose.
What you get
| bioio | from OpenReadout |
|---|---|
scenes |
image names (Image:<n> when the file has none; duplicates are suffixed with the index) |
dims |
TCZYX, or TCZYXS for RGB (interleaved samples) |
channel_names |
channel names (Channel:<scene>:<c> when the file has none) |
physical_pixel_sizes |
µm, None where the file records no size |
time_interval |
the recorded time increment |
metadata / ome_metadata |
ome_types.OME (one Image per scene, MetadataOnly pixels) |
xarray_dask_data.attrs["unprocessed"] |
the vendor's own metadata tree as JSON, names untouched |
Mosaics are returned stitched (no M dimension); pyramidal files at full resolution only. Remote (fsspec) paths are not supported: the file must be local.
Tests
pip install -e 'python/bioio-openreadout[test]'
OPENREADOUT_CORPUS_DIR=corpus/files pytest python/bioio-openreadout/tests
The tests compare img.data against bioio-nd2, czifile and liffile (all BSD) on files from the public test corpus and skip when those files or readers are absent.
Guide: https://openreadout.github.io/openreadout/guides/python.html. Part of OpenReadout. Licensed MIT OR Apache-2.0. OpenReadout is not affiliated with any instrument vendor.
Metadata
Release files for bioio-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)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| bioio_openreadout-0.4.0.tar.gz | 14.9 kB | With provenance | Details for bioio_openreadout-0.4.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| bioio_openreadout-0.4.0-py3-none-any.whl | Python 3 | none | any | Details for bioio_openreadout-0.4.0-py3-none-any.whl |
Total release size: 27.4 kB
Release files / bioio_openreadout-0.4.0.tar.gz
| Download URL | bioio_openreadout-0.4.0.tar.gz |
|---|---|
| Size | 14.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cf93d644d3cbccd79cf9f31d64e483dde7cdfddc3626ae613c28921508932ea9
|
|
BLAKE2b-256 checksum How to use checksums |
e3bb5ddba6a358129d1127d223dd92b7d8ae370bcaf311100762733d5c4b1e86
|
| 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 logRelease files / bioio_openreadout-0.4.0-py3-none-any.whl
| Download URL | bioio_openreadout-0.4.0-py3-none-any.whl |
|---|---|
| Size | 12.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6d6d529dc827f68b6e701499b3d19340336948a5153d7791b72d28d89db79a92
|
|
BLAKE2b-256 checksum How to use checksums |
e2cf4d2af4ed47d7c9501e55ec324c7f6a95529fee452837370675d2020d9a45
|
| 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 logSecurity for bioio-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
Both files in this release have been uploaded with provenance metadata.
Attestation for bioio_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 logA 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.