README.rst

Sismic for Python

Sismic Interactive Statechart Model Interpreter and Checker

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.4 or higher) provides a set of tools to define, validate, simulate, execute and test statecharts. More specifically, Sismic provides:

• 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
• Statechart visualization using PlantUML

Some experimental features are also available as feature branches.

Installation

Sismic requires Python >=3.4. Sismic can be installed using pip as usual: pip install sismic. This will install the latest stable version.

You can also install Sismic from this repository by cloning it.

Starting from release 1.0.0, Sismic adheres to a semantic versioning scheme.

Documentation

The documentation for the latest distributed version is available on sismic.readthedocs.io.

Many examples are available in docs/examples.

The documentation can also be directly built from the docs directory using Sphinx.

Changelog

See documentation's changelog.

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

You can cite Sismic using:

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