index.rst

Welcome to strategoutil's documentation!

Strategoutil is a collection of utility functions and classes to interface UPPAAL Stratego controllers with Python. It furthermore provides an interface to perform model-predictive control or online-control using STOMPC.

.. toctree::
   :hidden:
   :caption: Installation

   installation

.. toctree::
   :hidden:
   :caption: Examples

   examples/index
   examples/floor-heating
   examples/pond
   examples/traffic-light

.. toctree::
   :hidden:
   :caption: Reference

   api

Getting started

1. Use pip or clone this git repo to install strategoutil to your environment

pip install strategoutil

or

git clone https://github.com/DEIS-Tools/strategoutil.git
cd strategoutil
pip install -e .

2. Look how strategoutil is used in :ref:`example_index`.

Functionality

Currently, strategoutil contains the tool STOMPC that is capable of performing the following actions:

• 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.

Indices and tables

• :ref:`genindex`
• :ref:`modindex`
• :ref:`search`