Sismic for Python

.. image:: https://travis-ci.com/AlexandreDecan/sismic.svg?branch=master :target: https://travis-ci.com/AlexandreDecan/sismic .. image:: https://coveralls.io/repos/AlexandreDecan/sismic/badge.svg?branch=master&service=github :target: https://coveralls.io/github/AlexandreDecan/sismic?branch=master .. image:: https://api.codacy.com/project/badge/grade/10d0a71b01c144859db571ddf17bb7d4 :target: https://www.codacy.com/app/alexandre-decan/sismic .. image:: https://badge.fury.io/py/sismic.svg :target: https://pypi.org/project/sismic/ .. image:: https://readthedocs.org/projects/sismic/badge/?version=latest :target: https://sismic.readthedocs.io/

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.5 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
• Support for Design by Contract (DbC) for statecharts: contracts can be specified to express invariants, pre- and postconditions on states and transitions
• Runtime monitoring of behavioral properties expressed as statecharts
• Built-in support for behavior-driven development (BDD)
• Support for communication between statecharts
• Synchronous and asynchronous executions
• Statechart visualization using PlantUML <http://www.plantuml.com/plantuml>__

Installation

Sismic requires Python >=3.5. 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 <https://semver.org>__ scheme.

Documentation

The documentation for the latest distributed version is available on sismic.readthedocs.io <http://sismic.readthedocs.io/>_.

Many examples are available in docs/examples <https://github.com/AlexandreDecan/sismic/tree/master/docs/examples>_.

The documentation can also be directly built from the docs <https://github.com/AlexandreDecan/sismic/tree/master/docs>_ directory using Sphinx.

The scientific article A method for testing and validating executable statechart models <https://doi.org/10.1007/s10270-018-0676-3>_ presenting the method and techniques supported by Sismic for validating and testing statecharts, is published in Springer's Software and Systems modeling journal in 2018.

Changelog

See documentation's changelog <http://sismic.readthedocs.io/en/master/changelog.html>_.

Credits

The Sismic library for Python is mainly developed by Alexandre Decan at the Software Engineering Lab <http://informatique.umons.ac.be/genlog>_ of the University of Mons <http://www.umons.ac.be>_ with the help of many contributors <http://sismic.readthedocs.io/en/master/authors.html>_.

Sismic is released as open source software under the GNU Lesser General Public Licence version 3.0 (LGPLv3) <http://www.gnu.org/licenses/lgpl-3.0.html>_.

You can cite the Sismic library using:

.. code::

@article{sismic-article,
    title = "Sismic—A Python library for statechart execution and testing",
    journal = "SoftwareX",
    volume = "12",
    pages = "100590",
    year = "2020",
    issn = "2352-7110",
    doi = "https://doi.org/10.1016/j.softx.2020.100590",
    url = "http://www.sciencedirect.com/science/article/pii/S2352711020303034",
    author = "Alexandre Decan and Tom Mens",
}

or

.. code::

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

You can cite the associated research article (PDF <https://decan.lexpage.net/files/SOSYM-2018.pdf>_) using:

.. code::

@article{sismic2018-sosym,
   author = {Mens, Tom and Decan, Alexandre and Spanoudakis, Nikolaos},
   journal = {Software and Systems Modeling},
   publisher = {Springer},
   year = 2018,
   title = {A method for testing and validating executable statechart models},
   doi = {10.1007/s10270-018-0676-3},
   url = {https://link.springer.com/article/10.1007/s10270-018-0676-3},
 }