ltl-augmentation 0.1.0

A Toolbox for Augmenting LTL Specifications with External Knowledge

LTL Augmentation: Augment LTL Formulas with Outside Knowledge

System Requirements

The software is written in Python 3.10 and Rust, and was tested on Ubuntu 22.04.

Building & Testing

To build the Rust code simply run

cargo build

This will automatically download all required dependencies.

You can run the tests with

cargo test

Python Bindings

The project provides Python bindings for the most important functionalities. To install the Python package, you need to run

pip install -v .

The -v switch activates additional output during the build process.

For development purposes, it can make sense to install the Python bindings directly via maturin:

maturin develop

maturin can be installed via pip. For further options, please see its documentation.

You can run the main.py script to check whether the Python bindings were installed properly.

Using Pre-Commit Hooks

This project uses pre-commit to ensure that formatters and linters automatically run when committing files. To use pre-commit, install it via pip:

pip install pre-commit

Alternatively, pre-commit is also included in the optional dev dependencies of this project.

Then, install the pre-commit hooks so that they automatically run before each commit:

pre-commit install

To run the pre-commit hooks manually, use

pre-commit run --all-files