Skip to main content

BIOMERO Schema

Shared, versioned Pydantic contracts for the BIOMERO ecosystem.

Documentation · Python API · Pixel identity reference

The package keeps two contract areas separate:

  • biomero_schema.models is BIOMERO's normalized representation of a workflow descriptor.
  • biomero_schema.zarr and biomero_schema.imports define internal cross-service contracts for managed Zarr sources, pixel identity, shallow collections, and importer lifecycle operations.

Workflow descriptors

Workflow providers normally describe their tools using an external workflow format. The biomero runtime detects and converts supported formats into the validated WorkflowSchema from this package:

BIAFLOWS descriptor.json ─┐
                         ├─> biomero adapters ─> WorkflowSchema ─> BIOMERO services
BILAYERS config.yaml ─────┘

Currently supported inputs are:

Provider format BIOMERO support
BILAYERS config.yaml Converts the container, command, citations, inputs, parameters, and declared outputs. This is the preferred route for Zarr-to-Zarr and Plate-aware workflows.
BIAFLOWS/Cytomine descriptor Converts the supported legacy cytomine-0.1 subset. It remains useful for established TIFF-oriented BIAFLOWS workflows.
Native biomero-0.1 descriptor Validates directly. This is primarily BIOMERO's normalized service representation, although integrations may produce it explicitly.

CWL and OpenAPI descriptors are not yet supported. The adapters are maintained in biomero.schema_parsers, not in this schema package. This repository therefore documents what the normalized model can represent; the adapter determines which fields from an external format are currently converted.

See Workflow descriptors for the conversion boundary and supported mappings.

Installation

Python 3.11 or newer is required.

pip install biomero-schema

For development:

git clone https://github.com/NL-BioImaging/biomero-schema.git
cd biomero-schema
pip install -e .

The repository also supports Pixi:

pixi run test

Native descriptor validation

The CLI validates the normalized BIOMERO descriptor. Conversion of BILAYERS or BIAFLOWS descriptors is performed by the biomero runtime before validation.

biomero-schema validate descriptor.json
biomero-schema parse descriptor.json
biomero-schema parse descriptor.json --pretty
biomero-schema schema

A maintained native example is available at tests/example_workflow.json.

Cross-service contracts

Consumers should import the shared models rather than duplicating JSON fields:

from biomero_schema.zarr import CanonicalZarrSource

source = CanonicalZarrSource.from_dict(payload)
wire_payload = source.to_dict()
json_schema = CanonicalZarrSource.model_json_schema()

The camelCase output from to_dict() is the stable wire representation. Every contract family carries its own integer schema, independently of the workflow descriptor version.

The shallow-Zarr contracts are experimental BIOMERO storage contracts inspired by OME-NGFF RFC 8. They are not a replacement for OME-NGFF Collections and are not requirements for third-party workflows.

Documentation development

python -m pip install -e .
python -m pip install -r docs/requirements.txt
mkdocs serve

Use mkdocs build --strict to reproduce the documentation CI build. See docs/contributing.md for publishing details.

Metadata

Release files for biomero-schema 0.2

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

Source distribution (sdist)

Source distribution for biomero-schema 0.2
File Size Uploaded Provenance Actions
biomero_schema-0.2.tar.gz 55.7 kB Without provenance Details for biomero_schema-0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for biomero-schema 0.2
File Interpreter ABI Platform Actions
biomero_schema-0.2-py3-none-any.whl Python 3 none any Details for biomero_schema-0.2-py3-none-any.whl

Total release size: 75.6 kB

Release files / biomero_schema-0.2.tar.gz

Download URL biomero_schema-0.2.tar.gz
Size 55.7 kB
Tags Source
SHA-256 checksum
How to use checksums
414d2d7e3610264f9e363a22ebb946cf1ff40eab05749340d6f4e6506af64477
BLAKE2b-256 checksum
How to use checksums
11d7e1a805c04fc56247474cb8d63396034fd0257eaf391b58dc4b29722e2186
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / biomero_schema-0.2-py3-none-any.whl

Download URL biomero_schema-0.2-py3-none-any.whl
Size 19.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bbf6ea42ba3bf10908b5eb751b535588d5b657363db49402eeb51001ddcce475
BLAKE2b-256 checksum
How to use checksums
da9448b781b1a7eef165b9dcd659519ec46ba95ddc509c6ae66ddde98bff3396
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Security for biomero-schema 0.2

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

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