https://github.com/whitemech/ltlf2dfa
From LTLf / PPLTL to Deterministic Finite-state Automata (DFA)
https://github.com/whitemech/ltlf2dfa
dfa formula ltlf ltlf2dfa mona ppltl
Last synced: 5 months ago
JSON representation
From LTLf / PPLTL to Deterministic Finite-state Automata (DFA)
- Host: GitHub
- URL: https://github.com/whitemech/ltlf2dfa
- Owner: whitemech
- License: lgpl-3.0
- Created: 2018-04-13T07:37:54.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-03-20T17:52:51.000Z (about 2 years ago)
- Last Synced: 2025-08-20T11:55:55.939Z (10 months ago)
- Topics: dfa, formula, ltlf, ltlf2dfa, mona, ppltl
- Language: Python
- Homepage: http://ltlf2dfa.diag.uniroma1.it/
- Size: 1.51 MB
- Stars: 73
- Watchers: 2
- Forks: 10
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
README
---
LTLf2DFA is a tool that transforms an LTLf or a PPLTL formula into a minimal
Deterministic Finite state Automaton (DFA) using [MONA](http://www.brics.dk/mona/).
It is also available online at [http://ltlf2dfa.diag.uniroma1.it](http://ltlf2dfa.diag.uniroma1.it).
## Prerequisites
### MONA Installation
LTLf2DFA relies on the MONA tool for the generation of the DFA.
Please, make sure you have the MONA tool installed on your system before running LTLf2DFA.
You can follow the instructions [here](http://www.brics.dk/mona/download.html) to get MONA.
## Install
- from [PyPI](https://pypi.org/project/ltlf2dfa/):
```
pip install ltlf2dfa
```
- or, from source (`master` branch):
```
pip install git+https://github.com/whitemech/LTLf2DFA.git
```
- or, clone the repository and install:
```
git clone https://github.com/whitemech/LTLf2DFA.git
cd ltlf2dfa
pip install .
```
## Quickstart
You can use the LTLf2DFA package in two ways: as a library, and as a CLI tool.
### As a Library
- Parse an LTLf formula:
```python
from ltlf2dfa.parser.ltlf import LTLfParser
parser = LTLfParser()
formula_str = "G(a -> X b)"
formula = parser(formula_str) # returns an LTLfFormula
print(formula) # prints "G(a -> X (b))"
```
- Or, parse a PPLTL formula:
```python
from ltlf2dfa.parser.ppltl import PPLTLParser
parser = PPLTLParser()
formula_str = "H(a -> Y b)"
formula = parser(formula_str) # returns a PPLTLFormula
print(formula) # prints "H(a -> Y (b))"
```
- Translate a formula to the corresponding DFA automaton:
```python
dfa = formula.to_dfa()
print(dfa) # prints the DFA in DOT format
```
### As a CLI Interface
```python
ltlf2dfa -l {ltlf | ppltl} -f
```
## Features
* Syntax and parsing support for the following formal languages:
* Propositional Logic;
* Linear Temporal Logic on Finite Traces;
* Pure-Past Linear Temporal Logic on Finite Traces.
* Conversion from LTLf/PPLTL formula to MONA (First-order Logic)
**NOTE**: LTLf2DFA accepts either LTLf formulas or PPLTL formulas, i.e., formulas that
have only past, only future or none operators.
## Development
If you want to contribute, set up your development environment as follows:
- Intall [Poetry](https://python-poetry.org)
- Clone the repository: `git clone https://github.com/whitemech/LTLf2DFA.git && cd LTLf2DFA`
- Install the dependencies: `poetry shell && poetry install`
## Tests
To run tests: `tox`
To run only the code tests: `tox -e py38`
To run only the code style checks: `tox -e flake8`
## Docs
To build the docs: `mkdocs build`
To view documentation in a browser: `mkdocs serve`
and then go to [http://localhost:8000](http://localhost:8000)
## License
LTLf2DFA is released under the GNU Lesser General Public License v3.0 or later (LGPLv3+).
Copyright 2018-2023 WhiteMech
## Citing
If you use LTLf2DFA in your research, please consider citing it with the following bibtex:
```
@software{fuggitti-ltlf2dfa,
author = {Francesco Fuggitti},
title = {LTLf2DFA},
month = {March},
year = {2019},
publisher = {Zenodo},
version = {1.0.3},
doi = {10.5281/zenodo.3888410},
url_code = {https://github.com/whitemech/LTLf2DFA},
url_website = {http://ltlf2dfa.diag.uniroma1.it},
}
```
## Author
[Francesco Fuggitti](https://francescofuggitti.github.io/)