Package: sismic
Sismic Interactive Statechart Model Interpreter and CheckerSismicis a recursive acronym that stands forSismic 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.6 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 languageA statechart interpreter offering a discrete, step-by-step, and fully observable simulation engineFully controllable simulation clock, with support for real and simulated timeBuilt-in support for expressing actions and guards using regular Python code, can be easily extended to other programming languagesSupport for Design by Contract (DbC) for statecharts: contracts can be specified to express invariants, pre- and postconditions on states and transitionsRuntime monitoring of behavioral properties expressed as statechartsBuilt-in support for behavior-driven development (BDD)Support for communication between statechartsSynchronous and asynchronous executionsStatechart visualization usingPlantUMLInstallationSismic requires Python >=3.7.
Sismic can be installed usingpipas 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 asemantic versioningscheme.DocumentationThe documentation for the latest distributed version is available onsismic.readthedocs.io.Many examples are available indocs/examples.The documentation can also be directly built from thedocsdirectory using Sphinx.The scientific articleA method for testing and validating executable statechart modelspresenting the method and techniques supported by Sismic for validating and testing statecharts, is published in Springer’s Software and Systems modeling journal in 2018.ChangelogSee documentation’schangelog.CreditsThe Sismic library for Python is mainly developed by Alexandre Decan at theSoftware Engineering Labof theUniversity of Monswith the help ofmany contributors.Sismic is released as open source software under theGNU 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 ResourcesThe 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.AYouTube playlistproviding 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.)