cbfpy

Python package for using simple control barrier function.

Documentation

Requirements

• Python >= 3.10

Installation

pip install -e .

With dev/test dependencies:

pip install -e ".[dev,test]"

Examples

Usage

python examples/example_{cbf name}.py

Documentation

Documentation is automatically published to GitHub Pages on push to main.

To build locally:

pip install -e ".[dev]"
sphinx-build docs/source docs/build

Then open docs/build/index.html.

Tools

Format & Lint

• ruff (format + lint + import sort)
• mypy (type check)

ruff format .
ruff check --fix .
mypy .

Test

pytest

The vscode extension coverage-gutters can be used to display the test coverage.

pre-commit

Apply config file for pre-commit.

pre-commit install