Skip to main content

BioIO

Build Status Documentation PyPI version License Python 3.10–3.13

Image Reading, Metadata Conversion, and Image Writing for Microscopy Images in Pure Python


Documentation

See the full documentation on our GitHub pages site

Example Usage (see full documentation for more examples)

Install bioio alongside OME TIFF and OME ZARR plug-ins with pip (this example won't use the OME ZARR plug-in):

pip install bioio bioio-ome-tiff bioio-ome-zarr

from bioio import BioImage

# Get a BioImage object
img = BioImage("my_file.tiff")  # selects the first scene found
img.data  # returns 5D TCZYX numpy array
img.xarray_data  # returns 5D TCZYX xarray data array backed by numpy
img.dims  # returns a Dimensions object
img.dims.order  # returns string "TCZYX"
img.dims.X  # returns size of X dimension
img.shape  # returns tuple of dimension sizes in TCZYX order
img.get_image_data("CZYX", T=0)  # returns 4D CZYX numpy array

# Get the id of the current operating scene
img.current_scene

# Get a list valid scene ids
img.scenes

# Change scene using name
img.set_scene("Image:1")
# Or by scene index
img.set_scene(1)

# Use the same operations on a different scene
# ...

Plug-in Registry

Bioio handles a variety of different image types through specific plug-ins. The bioio-dev supported plug-ins can be found within this registry. Plug-ins marked with * are community contributed and are maintained by external contributors.

Plug-in Extension Repository
arraylike ArrayLike Built-In
bioio-czi .czi Repo
bioio-dv .dv, .r3d Repo
bioio-imageio .jpg, .png, Full List Repo
bioio-imagexpress .jdce (ImageXpress directory) Repo
bioio-imzml * .imzml Repo
bioio-lif .lif Repo
bioio-nd2 .nd2 Repo
bioio-ome-tiff .ome.tiff, .tiff Repo
bioio-ome-tiled-tiff .tiles.ome.tif Repo
bioio-ome-zarr .zarr Repo
bioio-qptiff * .qptiff Repo
bioio-sldy .sldy, .dir Repo
bioio-tifffile .tif , .tiff Repo
bioio-tiff-glob .tiff (glob) Repo
bioio-bioformats Full List Repo

Each reader plugin should closely follow the specification laid out in bioio-base. As such, it is likely common that reader plugins won't distribute their own documentation and users should instead review bioio_base.reader.Reader for API documentation for the underlying Reader API. We encourage plugin authors to publish their own documentation if they change or include new features into their published image readers.

Writer Registry

BioIO supports a set of writer backends for exporting image data. The writer registry below lists maintained writer plug-ins.

Writer Extension Documentation
OmeTiffWriter .ome.tiff Repo
OMEZarrWriter .ome.zarr (OME-NGFF 0.4.0 and 0.5.0) Repo
TimeSeriesWriter .gif, .mp4, .mkv Repo
TwoDWriter .png, .bmp, .jpg, .mov, .avi, .mpg, .mpeg, .mp4, .mkv, .wmv, .ogg Repo

Writer Installation and Usage

Writers will be installed with the respective plugin. Once installed they can be imported via bioio.writers. ex. bioio.writers<Writer Name>

import numpy as np
from bioio.writers import OmeTiffWriter # with bioio-ome-tiff installed

image = np.random.rand(10, 3, 1024, 2048)
OmeTiffWriter.save(image, "file.ome.tiff", dim_order="ZCYX")

Citation

If you use BioIO in your research, please cite the core bioio package via the DOI.

DOI

@software{bioio,
  author    = {BioIO Contributors},
  title     = {{BioIO}},
  url       = {https://github.com/bioio-devs/bioio},
  doi       = {10.5281/zenodo.22755965},
  year      = {2023},
}

For other citation formats, use the Cite this repository button at the top of this page (powered by the CITATION.cff file).

Note: BioIO's various plugins each carry their own license.

Issues

Click here to view all open issues in bioio-devs organization at once

Metadata

Release files for bioio 3.7.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 bioio 3.7.0
File Size Uploaded Provenance Actions
bioio-3.7.0.tar.gz 65.1 kB With provenance Details for bioio-3.7.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for bioio 3.7.0
File Interpreter ABI Platform Actions
bioio-3.7.0-py3-none-any.whl Python 3 none any Details for bioio-3.7.0-py3-none-any.whl

Total release size: 127.5 kB

Release files / bioio-3.7.0.tar.gz

Download URL bioio-3.7.0.tar.gz
Size 65.1 kB
Tags Source
SHA-256 checksum
How to use checksums
5879b0fc16a4aea3a10428f8954da9458f7d4489fda9e56ae287d028b015e1ac
BLAKE2b-256 checksum
How to use checksums
047e2ac5b73642b19fdaf220bc8d60d2524a318d1aeb775bb4dbc92f3e56fa48
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 6, 2026.

Transparency log

Release files / bioio-3.7.0-py3-none-any.whl

Download URL bioio-3.7.0-py3-none-any.whl
Size 62.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
67537feff714d74eba1d1c2e3ef433017a602e6ecb8410100f0fb030315459a9
BLAKE2b-256 checksum
How to use checksums
29b311fd1fddab12b577994eb5d72dd2129b8e9c3359b8a5c776b767ab5f09ff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 6, 2026.

Transparency log

Security for bioio 3.7.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.

Select from 2 files

Attestation for bioio-3.7.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 Nov 6, 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