Skip to content

Commit

Permalink
Merge pull request #15 from mihsamusev/#8-documentation
Browse files Browse the repository at this point in the history
#8 Set up of documentation
  • Loading branch information
mihsamusev authored Jun 18, 2021
2 parents 405268e + f357d36 commit 04f2333
Show file tree
Hide file tree
Showing 7 changed files with 444 additions and 29 deletions.
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
35 changes: 35 additions & 0 deletions docs/make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build

if "%1" == "" goto help

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

:end
popd
38 changes: 38 additions & 0 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
=================
API Documentation
=================

This part of the documentation covers the interfaces used to develop with :code:`strategoutil`.

StrategoController
------------------

.. autoclass:: strategoutil.StrategoController
:members:
:private-members:
:show-inheritance:

MPCsetup
--------

.. autoclass:: strategoutil.MPCsetup
:members:
:private-members:
:show-inheritance:

SafeMPCSetup
------------

.. autoclass:: strategoutil.SafeMPCSetup
:members:
:private-members:
:show-inheritance:

Static methods
--------------

The folowing static methods are available.

.. automodule:: strategoutil
:members:
:exclude-members: StrategoController, MPCsetup, SafeMPCSetup
57 changes: 57 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
sys.path.insert(0, os.path.abspath('..'))


# -- Project information -----------------------------------------------------

project = 'strategoutil'
copyright = '2021, Mihhail Samusev and Martijn Goorden'
author = 'Mihhail Samusev and Martijn Goorden'

# The full version, including alpha/beta/rc tags
release = '0.0.3'


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
"myst_parser"
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
49 changes: 49 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
Welcome to strategoutil's documentation!
========================================

*Strategoutil* is a collection of utility functions and classes to interface
`UPPAAL Stratego <https://people.cs.aau.dk/~marius/stratego/>`_ controllers with Python. It furthermore
provides an interface to perform model-predictive control or online-control.

.. toctree::
:maxdepth: 3
:caption: Contents:

api


Getting started
---------------

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

.. code-block:: sh
pip install strategoutil
or

.. code-block:: sh
git clone https://github.com/mihsamusev/strategoutil.git
cd strategoutil
pip install -e .
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.


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Loading

0 comments on commit 04f2333

Please sign in to comment.