Skip to content

Commit

Permalink
better readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mihsamusev committed Jun 15, 2021
1 parent a6756a1 commit 78902fc
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,33 @@
# strategoutil
Utility functions to interface UPPAAL Stratego with python
Collection of utility functions and classes to interface [UPPAAL Stratego](https://people.cs.aau.dk/~marius/stratego/) controllers with Python.

## Repo status
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/mihsamusev/strategoutil)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![badge](https://github.com/mihsamusev/strategoutil/workflows/build/badge.svg)](https://github.com/mihsamusev/strategoutil/actions)

See which OS and Python versions combinations are supported [here](https://github.com/mihsamusev/strategoutil/actions).

## Getting started
1) Clone and install `strategoutil` to your environment
1) Use pip or clone this git repo to install `strategoutil` to your environment

```sh
pip install strategoutil
# OR
git clone https://github.com/mihsamusev/strategoutil.git
cd strategoutil
pip install -e .
```

2) Run tests, successful passing of all tests does not depend on having `verifyta` installed on your machine.
```sh
python -m pytest
```
2) Look how `strategoutil` is used with [example projects](https://github.com/mihsamusev/stratego_mpc_example)
## Functionality
- Write input variables to Stratego model `*.xml` files
- Parse outputs of `simulate` queries to get timeseries of important variables
- Run `verifyta` with chosen query `*.q` and run parameters
- Create model predictive control (MPC) routines where plant is either defined within the same Stratego model, or plant is defined as external process, simulataor, etc.



3) Import to your stratego MPC project and start hacking, see [example project](https://github.com/mihsamusev/stratego_mpc_example)
```python
import strategoutil as sutil
```

## Reference



2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = strategoutil
version = 0.0.2
version = 0.0.3
author = Mihhail Samusev, Martijn Goorden
author_email = msam@build.aau.dk
description = Python utility functions library for UPPAAL Stratego
Expand Down

0 comments on commit 78902fc

Please sign in to comment.