8000 GitHub - toshi67026/cbfpy
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

toshi67026/cbfpy

Repository files navigation

cbfpy

Python package for using simple control barrier function.

Requirements

  • poetry 1.3.1

Installation

Create virtualenv and install dependencies defined for the project.

poetry install

Build and install locally with pip.

poetry build
python -m pip install cbfpy --find-links=dist

Examples

Usage

poetry run python examples/example_{cbf name}.py

Document

Generate document from docstring.

poetry run task docs

Browse generated document by opening the html files in docs/build/ from your browser.

Tools

Format

  • isort
  • black
poetry run task fmt

Lint

  • black
  • ruff
  • mypy
poetry run task lint

Test

  • pytest
  • pytest-cov
poetry run task test

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

pre-commit

Apply config file for pre-commit.

poetry run pre-commit install

Export requirements.txt

poetry export -f requirements.txt --output requirements.txt --without-hashes

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

0