Skip to main content

Probabilistic Model Checking for almost everyone

Project description

Stormvogel 🐦: An interactive approach to probabilistic model checking in Python

The state-of-the-art model checking tools that are currently available are optimized to be efficient, but not much effort goes into making them user-friendly. The result of this is that they are quite hard to learn and use. Stormvogel solves this problem by providing easy and user-friendly APIs for creating probabilistic Markov models, and tools to visualize and debug them. It supports seemless conversion to the powerful Storm(py) model checker out of the box.

Features

  • Easy APIs for constructing Markov models in dedicated data structures. Currently, DTMCs, MDPs, CTMCs, POMDPs and Markov Automata are supported. This also includes parametric variants. Interval models are in development.

  • Seamless conversion between stormvogel and stormpy models with some runtime overhead. This allows, e.g., also using formats such as JANI and PRISM that are not supported by stormvogel directly. It is also possible to add support for a different model checker.

  • Visualization of Markov models as an interactive graph. This includes extensive layout options, and displaying model checking results and simulations in an interactive way.

  • Support for gymnasium environments

  • An extensive documentation with clear examples.

Check out the the stormvogel documentation for examples of how to use stormvogel.

Installation

Pip (release version, recommended for users)

  1. Run pip install stormvogel.
  2. To also install stormpy, run pip install stormpy.

Docker (release version)

  1. Install docker. Run:
  2. docker run -it -p 8080:8080 stormvogel/stormvogel
  3. Now a browser window should open that runs jupyter lab with stormvogel and stormpy installed.

For development (latest version)

Note that you might have to tweak these steps a bit to get it to work on your particular system, but here is an outline.

  1. Install the poetry package manager
  2. Clone the stormvogel repo (or your own fork) in a separate folder
  3. In the stormvogel folder:
    poetry install
    poetry shell # Activate poetry virtual environment
    pip install stormpy
    pip install . # Install stormvogel
    
    If installing stormpy fails in poetry, you can also try to follow the official stormpy installation instructions, and run poetry shell on top of the virtualenv environment that they describe there.
  4. Install pre-commit hook: pre-commit install

Testing

Notice that part of the tests will fail if stormpy is not installed.

pytest

Authors

Stormvogel was mainly developed at Radboud University by Linus Heck, Pim Leerkes, and Ivo Melse under supervision from Sebastian Junges and Matthias Volk.

Thank you to our contributors: Luko van der Maas, Nicklas Osmers.

License

Stormvogel is licenced under the GPL-3.0 license.

Project details


Download files

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

Source Distribution

stormvogel-0.9.9.tar.gz (425.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

stormvogel-0.9.9-py3-none-any.whl (447.8 kB view details)

Uploaded Python 3

File details

Details for the file stormvogel-0.9.9.tar.gz.

File metadata

  • Download URL: stormvogel-0.9.9.tar.gz
  • Upload date:
  • Size: 425.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.13.1 Linux/6.8.0-1031-azure

File hashes

Hashes for stormvogel-0.9.9.tar.gz
Algorithm Hash digest
SHA256 f69738f9f596f8f73140643b02686cd98fdeb02fb7e31b5df9798ff92b42f5ce
MD5 a79a5e255f834b7b189bbe060ce92bb6
BLAKE2b-256 90d0550b9126c93ab1ccb20e9b52d4641555d4eafb1e382a2c2bf6465d165b09

See more details on using hashes here.

File details

Details for the file stormvogel-0.9.9-py3-none-any.whl.

File metadata

  • Download URL: stormvogel-0.9.9-py3-none-any.whl
  • Upload date:
  • Size: 447.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.13.1 Linux/6.8.0-1031-azure

File hashes

Hashes for stormvogel-0.9.9-py3-none-any.whl
Algorithm Hash digest
SHA256 572fcf447a741416dc6e95b9e2334459db3c8a354ddd2c9578d9ed5f02417755
MD5 6dfd1ef5da282ee2398bd7317129e6b4
BLAKE2b-256 adf68219ef4c73448ffe912854f93e4fcfe25897307e44e8d57c56c9ac62418b

See more details on using hashes here.

Supported by

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