umbi
Library for input/output of annotated transition systems (ATSs) in a unified Markov binary (UMB) format. See the format specification for details.
Installation:
pip install umbi
Quick start
A short example where we read a umbfile into an SimpleAts object, modify initial states, and write it back:
import umbi
ats = umbi.ats.read("in.umb")
ats.initial_states = [ats.num_states - 1]
umbi.ats.write(ats, "out.umb")
Here is another example where we create a simple CTMC:
import umbi
from fractions import Fraction
ats = umbi.ats.SimpleAts()
ats.time = umbi.ats.TimeType.STOCHASTIC
ats.num_states = 3
ats.initial_states = [0]
ats.state_to_exit_rate = [3/2, Fraction(7,3), 1]
ats.new_state_choice(state=2, targets=[2], probs=[1])
ats.new_state_choice(state=1, targets=list(ats.states), target_prob=lambda s: Fraction(1,ats.num_states))
ats.new_state_choice(state=0, targets=[1,2], probs=[1/2, 1/2])
annotation = ats.new_ap_annotation("deadlock")
annotation.state_values = [False, False, True]
umbi.ats.write(ats, "out.umb")
More examples can be found in the examples folder.
API
umbi offers multiple levels of abstraction for working with UMB files:
TarFile and TarCoder - low-level access to umbfile contents.
ExplicitUmb - in-memory representation of a typical umbfile. Attributes are standard Python objects (lists, dicts, dataclasses) providing a deserialized view of the file contents.
SimpleAts - format-agnostic abstraction for annotated transition systems (states, transitions, annotations, etc.). Recommended for most use cases: easiest to use programmatically and remains stable across UMB format changes. See umbi.ats.examples for usage examples.
CLI
umbi provides a basic CLI for umbfile manipulation.
Options:
--import-umb <path>- import umbfile asExplicitUmb--import-ats <path>- import umbfile asSimpleAts--export <path>- export to umbfile (requires--import-umbor--import-ats)--log-level <LEVEL>- set logging level:DEBUG,INFO(default),WARNING,ERROR,CRITICAL
Example:
umbi --import-umb input.umb --export output.umb --log-level DEBUG
Development
(optional) create and activate a python environment:
python -m venv .venv
source .venv/bin/activate
Setup
Install development dependencies:
pip install .[dev]
Testing
Run the test suite with pytest:
python -m pytest # run all tests
python -m pytest tests/tar/ # run specific test directory
python -m pytest -k test_name # run tests matching pattern
Current test coverage:
- binary - serialization and binary data handling
- datatypes - data type definitions and conversions
- tar - tarfile I/O and utilities
Code Quality
Pre-commit hooks automatically run code quality checks before each commit. Configuration: .pre-commit-config.yaml
Set up the hooks with:
pre-commit install
Run hooks manually on all files:
pre-commit run --all-files
Individual tools can be run manually:
Ruff -- Code formatting and linting. Config: pyproject.toml ([tool.ruff])
ruff check . # check for issues
ruff check . --fix # check and fix
ruff format . # format code
Pyright -- Static type checking. Config: pyproject.toml ([tool.pyright])
pyright # check entire project
pyright umbi/ # check specific directory
Release
To bump the version, run
bump-my-version bump <patch|minor|major>
git push origin --follow-tags
or run the bump version workflow (via GitHub Actions UI). When the new version tag is pushed, the release workflow is automatically triggered to:
1 maintainer
Release files for umbi 0.2.12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| umbi-0.2.12.tar.gz | 63.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| umbi-0.2.12-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 144.0 kB
Release files / umbi-0.2.12.tar.gz
| Download URL | umbi-0.2.12.tar.gz |
|---|---|
| Size | 63.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e6804cace37f35ef43fe63bd94e852cac43d3e3557105b0b20d3f3557d49d957
|
|
BLAKE2b-256 checksum How to use checksums |
70358b4951659a79adc92f0984c607bebfa08a7ab5fd2eb0b2d7001d3e4db06d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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 Jun 1, 2026.
Transparency logRelease files / umbi-0.2.12-py3-none-any.whl
| Download URL | umbi-0.2.12-py3-none-any.whl |
|---|---|
| Size | 80.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
df211da9bea84899efb06836d9334eb2f5993c5b26b471146292d64a133f72cb
|
|
BLAKE2b-256 checksum How to use checksums |
fe7da2bd0769c06ed0d3ed19c05a9f432ba82111e0f96506d41707da08358735
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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 Jun 1, 2026.
Transparency log
