BaySIL

Bayesian Sequential Inference Library

Installation

pip install baysil

Or with uv:

uv add baysil

Requirements

• Python 3.12 or later
• uv installed

Contributing

Clone the repository and install dependencies:

git clone https://github.com/michaelellis003/BaySIL.git
cd BaySIL
uv sync

Install the pre-commit hooks:

uv run pre-commit install
uv run pre-commit install --hook-type commit-msg
uv run pre-commit install --hook-type pre-push

Development

A Makefile is provided for common tasks:

make test        # lint + pytest
make lint        # ruff check, format check, license headers, ty
make format      # add license headers, ruff format, ruff fix
make license     # add missing license headers
make docs        # build documentation
make serve-docs  # serve documentation locally
make install     # uv sync
make clean       # git clean (preserves .venv)

How releases work

Releases are cut deliberately. Merging to main runs CI only — nothing is published.

To ship a version, run the Release workflow from the Actions tab. It waits for maintainer approval before anything is computed, tagged, or published. python-semantic-release then inspects the commits since the last tag to determine the version:

• fix: ... produces a patch release
• feat: ... produces a minor release
• A BREAKING CHANGE footer or ! suffix produces a major release

If nothing warrants a bump the run exits without releasing. Set the force input to cut one anyway — useful for re-publishing after a failed upload.

Documentation is deployed from the release tag, so the published docs always describe the released version rather than main.

License

Apache 2.0. See LICENSE for the full text.