Permalink
Fetching contributors…
Cannot retrieve contributors at this time
123 lines (90 sloc) 4.46 KB

Sismic user manual

https://travis-ci.org/AlexandreDecan/sismic.svg?branch=master https://coveralls.io/repos/AlexandreDecan/sismic/badge.svg?branch=master&service=github https://api.codacy.com/project/badge/grade/10d0a71b01c144859db571ddf17bb7d4 https://readthedocs.org/projects/sismic/badge/?version=master

About

Sismic is a recursive acronym that stands for Sismic Interactive Statechart Model Interpreter and Checker.

Statecharts are a well-known visual modeling language for representing the executable behavior of complex reactive event-based systems. Sismic library for Python (version 3.5 or higher) provides a set of tools to define, validate, simulate, execute and test statecharts.

Sismic is mainly developed by Alexandre Decan at the University of Mons and released publicly under the GNU Lesser General Public Licence version 3.0 (LGPLv3).

Features

Sismic provides the following features:

  • An easy way to define and to import statecharts, based on the human-friendly YAML markup language
  • A statechart interpreter offering a discrete, step-by-step, and fully observable simulation engine
  • Fully controllable simulation clock, with support for real and simulated time
  • Built-in support for expressing actions and guards using regular Python code, can be easily extended to other programming languages
  • A design-by-contract approach for statecharts: contracts can be specified to express invariants, pre- and postconditions on states and transitions
  • Runtime checking of behavioral properties expressed as statecharts
  • Built-in support for behavior-driven development
  • Support for communication between statecharts
  • Synchronous and asynchronous executions
  • Statechart visualization using PlantUML

Some experimental features are also available as feature branches.

The semantics of the statechart interpreter is based on the specification of the SCXML semantics (with a few exceptions), but can be easily tuned to other semantics. Sismic statecharts provides full support for the majority of the UML 2 statechart concepts:

  • simple states, composite states, orthogonal (parallel) states, initial and final states, shallow and deep history states
  • state transitions, guarded transitions, automatic (eventless) transitions, internal transitions and transition priorities
  • statechart variables and their initialisation
  • state entry and exit actions, transition actions
  • internal and external events, parametrized events, delayed events
.. toctree::
    :caption: Overview
    :maxdepth: 2

    installation
    format
    execution
    code

.. toctree::
    :caption: Statechart testing
    :maxdepth: 2

    contract
    properties
    behavior
    unittests

.. toctree::
    :caption: Advanced topics
    :maxdepth: 2

    time
    integration
    communication
    extensions

.. toctree::
    :caption: Misc
    :maxdepth: 1

    authors
    changelog
    api


Credits

The Sismic library for Python is mainly developed by Alexandre Decan at the University of Mons with the help of many contributors.

Sismic is released publicly under the GNU Lesser General Public Licence version 3.0 (LGPLv3).

The source code is available on GitHub: https://github.com/AlexandreDecan/sismic

Use GitHub's integrated services to contribute suggestions and feature requests for this library or to report bugs.

You can cite Sismic using:

@software{sismic,
  author = {{Alexandre Decan}},
  title = {Sismic Interactive Statechart Model Interpreter and Checker},
  url = {https://github.com/AlexandreDecan/sismic},
}