https://github.com/whitemech/hoa-utils
Utilities for the HOA format.
https://github.com/whitemech/hoa-utils
automata automata-theory buchi-automaton graphviz graphviz-dot hoa hoa-format hoa-library hoa-parser hoa-validator ltl translator
Last synced: 7 months ago
JSON representation
Utilities for the HOA format.
- Host: GitHub
- URL: https://github.com/whitemech/hoa-utils
- Owner: whitemech
- License: lgpl-3.0
- Created: 2019-11-26T14:38:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-29T15:38:07.000Z (almost 6 years ago)
- Last Synced: 2025-09-22T15:44:21.325Z (10 months ago)
- Topics: automata, automata-theory, buchi-automaton, graphviz, graphviz-dot, hoa, hoa-format, hoa-library, hoa-parser, hoa-validator, ltl, translator
- Language: Python
- Homepage: https://whitemech.github.io/hoa-utils/
- Size: 542 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
HOA utils
Utilities for the HOA format.
## Install
The best way is to install the package from PyPI:
```
pip install hoa-utils
```
Alternatively, you can install it from source (master branch):
```
pip install git+https://github.com/whitemech/hoa-utils.git
```
## What you'll find
- APIs to create and manipulate HOA objects
- CLI tools to about the HOA format.
The implementation may not be very stable at the moment.
Currently, the only supported CLI tool is:
- `pyhoafparser`: parse and validate a file in HOA format.
## Development
If you want to contribute, here's how to set up your development environment.
- Install [Poetry](https://python-poetry.org/)
- Clone the repository: `git clone https://github.com/whitemech/hoa-utils.git && cd hoa-utils`
- Install the dependencies: `poetry install`
## Tests
To run tests: `tox`
To run only the code tests: `tox -e py3.7`
To run only the code style checks:
- `tox -e black-check`
- `tox -e isort-check`
- `tox -e flake8`
In `tox.ini` you can find all the test environment supported.
## 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)
## Authors
- [Marco Favorito](https://marcofavorito.github.io/)
- [Francesco Fuggitti](https://francescofuggitti.github.io/)
## License
`hoa-utils` is released under the MIT License.
Copyright 2020 WhiteMech