Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

BIOMERO BIOMERO Schema

Tests Documentation PyPI License: Apache 2.0

🚀 This package is part of BIOMERO BIOMERO 2.0 — For complete deployment and FAIR infrastructure setup, start with the NL-BIOMERO Documentation 📖

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, biomero_schema.imports, and biomero_schema.shallower define internal cross-service contracts for managed Zarr sources, pixel identity, shallow collections, importer lifecycle operations, and remote shallowing reports and receipts.

Workflow descriptors

Workflow providers normally describe their tools using an external workflow format. The adapters in biomero_schema.adapters detect and convert 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 were moved here from biomero.schema_parsers so descriptors can be converted without the BIOMERO runtime:

from biomero_schema.adapters import parse_descriptor

workflow = parse_descriptor(yaml.safe_load(open("config.yaml")))

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. BILAYERS (.yaml) and BIAFLOWS descriptors are detected and converted before validation, and parse --json writes the converted descriptor.

biomero-schema validate config.yaml
biomero-schema parse config.yaml --json > descriptor.json
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 manifest is an experimental, versioned BIOMERO storage contract, not RFC-8 metadata. Its portable image/label graph is separate from BIOMERO storage and provenance bindings so that a future standards adapter can reuse the graph without redefining the operational data.

See Remote shallower contracts for the report formats, trusted receipt hand-off, and compatibility requirements. These models do not enable shallow storage or remote execution; feature configuration belongs to the consuming services.

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.3.0b2

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.3.0b2
File Size Uploaded Provenance Actions
biomero_schema-0.3.0b2.tar.gz 76.1 kB Without provenance Details for biomero_schema-0.3.0b2.tar.gz

Built distribution (wheel)

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

Total release size: 106.1 kB

Release files / biomero_schema-0.3.0b2.tar.gz

Download URL biomero_schema-0.3.0b2.tar.gz
Size 76.1 kB
Tags Source
SHA-256 checksum
How to use checksums
931af786896a21c7469af9edb327836f3d58d45e96235d82c6469d6bf5eb1928
BLAKE2b-256 checksum
How to use checksums
5ffa2ea6a6294fc82c9c53c1c949cbe89980b39808d139fdb5f9c294ccd9030d
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.3.0b2-py3-none-any.whl

Download URL biomero_schema-0.3.0b2-py3-none-any.whl
Size 30.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9d0fb5c8b862fc3718b4a738e198974a17beef386bf9fad35881500fc9bc4b50
BLAKE2b-256 checksum
How to use checksums
44c947bda89584e24d09a87265ebc59b20031da860ec6a02f529abb5675e7a3b
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.3.0b2

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