Skip to main content

Sismic Interactive Statechart Model Interpreter and Checker

Project description

https://github.com/AlexandreDecan/sismic/actions/workflows/test.yaml/badge.svg?branch=master https://coveralls.io/repos/AlexandreDecan/sismic/badge.svg?branch=master&service=github https://badge.fury.io/py/sismic.svg https://readthedocs.org/projects/sismic/badge/?version=latest

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

Installation

Sismic requires Python >=3.9. 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.

The scientific article A method for testing and validating executable statechart models 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.

Credits

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

Sismic is released as open source software under the GNU Lesser General Public Licence version 3.0 (LGPLv3).

You can cite the Sismic library using:

@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 = "10.1016/j.softx.2020.100590",
    url = "https://doi.org/10.1016/j.softx.2020.100590",
    author = "Alexandre Decan and Tom Mens",
}

or

@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) using:

@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://doi.org/10.1007/s10270-018-0676-3},
 }

External Resources

The following resources provide additional information about statecharts that may be of use, even if it is not immediately related to Sismic.

  • Yakindu Statechart tools: commercial software for visual simulation, debugging, testing and code generation from statecharts. A free academic licence can be obtained for universities.

  • A YouTube playlist providing a set of introductory tutorials about statechart modeling and simulation (based on the aforementioned Yakindu tool).

(If some of the links provided above turn out to be dead, or if you know other relevant resources that should be added here, please contact us.)

Project details


Release history Release notifications | RSS feed

This version

1.6.9

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sismic-1.6.9.tar.gz (572.9 kB view details)

Uploaded Source

Built Distribution

sismic-1.6.9-py3-none-any.whl (53.9 kB view details)

Uploaded Python 3

File details

Details for the file sismic-1.6.9.tar.gz.

File metadata

  • Download URL: sismic-1.6.9.tar.gz
  • Upload date:
  • Size: 572.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sismic-1.6.9.tar.gz
Algorithm Hash digest
SHA256 29bf85ab8ef640ac2e904c0394987c47980e145d889ff8a485d6419126744965
MD5 627947846aeda8ba59184e345afcdd29
BLAKE2b-256 a31ab09b50353bb95fb1ec1375bc74989ae0ff34b537594c2ed8c3980ab27a3a

See more details on using hashes here.

File details

Details for the file sismic-1.6.9-py3-none-any.whl.

File metadata

  • Download URL: sismic-1.6.9-py3-none-any.whl
  • Upload date:
  • Size: 53.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sismic-1.6.9-py3-none-any.whl
Algorithm Hash digest
SHA256 2383f097c6dfdb047ac49189f50c1fcd9b0283d6d2afe24b283c93c3a1f44ab8
MD5 b7203ce47025d1464ab29ca0e59d3eac
BLAKE2b-256 949595d5b7496b69ead8d831f4e197a892f18da2b00c872411a990faebc21a61

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page