Skip to main content

labware

Microplate and dish definitions for software: outer footprint, well geometry, skirt, material, and the vendor drawing each dimension came from.

Browse them in 3D: https://docs.ramonaoptics.com/tools/labware_viewer.html

Install

pip install labware

or

conda install -c conda-forge labware

Example

from labware import load_labware

plates = load_labware()
plate = plates["SBS_96_well_plate"]

print(plate.name)  # SBS 96 well
print(plate.well_dimensions.rows, plate.well_dimensions.columns)  # 8 12
print(plate.well_dimensions.pitch)  # 0.009, in meters

Layout

  • labware/definitions/ holds one JSON file per part. The file name, without .json, is the key load_labware() returns it under.
  • labware/schema.py is the pydantic model every definition is validated against.
  • labware/labware.v1.schema.json is that model published as a JSON schema. Each definition names it in its $schema key.

Releasing

Uploads to PyPI are automatic, and the version comes from the git tag, so there is no version number to edit in the source.

A merge to main that changes the package is released on its own: the pypi workflow runs the tests, creates the tag and a GitHub release, and publishes.

  • If anything in labware/ other than a JSON file changed, such as the schema model or the loader, the minor version goes up.
  • Otherwise, if a JSON file in labware/ was added, changed or deleted, which is what a new or corrected plate definition is, the patch version goes up.
  • A merge that only touches files outside labware/, such as this README, the tests or the CI, is not released.

A major version is always made by hand.

To release by hand, create the tag from the GitHub web interface:

  1. Open https://github.com/ramonaoptics/labware/releases/new
  2. Under "Choose a tag", type the new version with a leading v, for example v0.1.1, and pick "Create new tag on publish".
  3. Leave the target as main, click "Generate release notes", then "Publish release".

The pypi workflow then builds the sdist and wheel and publishes them, and labware.__version__ in the installed package reports that same version.

Metadata

Release files for labware 0.2.4

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

Source distribution (sdist)

Source distribution for labware 0.2.4
File Size Uploaded Provenance Actions
labware-0.2.4.tar.gz 100.2 kB With provenance Details for labware-0.2.4.tar.gz

Built distribution (wheel)

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

Total release size: 314.5 kB

Release files / labware-0.2.4.tar.gz

Download URL labware-0.2.4.tar.gz
Size 100.2 kB
Tags Source
SHA-256 checksum
How to use checksums
da6e3e088c5294d439e11c035e28e84637af937fdd1479d441f742a5cfb5056d
BLAKE2b-256 checksum
How to use checksums
7059a518a0c207c0ca3d749861fbccd7b4d5821bc5af528210eff71eb93f3905
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 Oct 30, 2026.

Transparency log

Release files / labware-0.2.4-py3-none-any.whl

Download URL labware-0.2.4-py3-none-any.whl
Size 214.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7539fa784261e5f3a2a674424d30b1639bd668df5fcf38bf27d165bf3cae31d3
BLAKE2b-256 checksum
How to use checksums
dc5768b56dda31b0b2a44eece504dd5293f265314a8bd8b638f16f1b9496d752
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 Oct 30, 2026.

Transparency log

Security for labware 0.2.4

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 labware-0.2.4.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 30, 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