Skip to main content

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

Coverage

The state-of-the-art model checking tools that are currently available are optimized to be efficient. The result of this is that they are quite hard to learn and use. Stormvogel flattens the learning cuve 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 and interval models.

  • 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 and into SVGs via dot. 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

  1. Run pip install stormvogel.
  2. To also install stormpy, run pip install stormpy.
  3. Run jupyter lab
  4. Now a browser window should open that runs jupyter lab with stormvogel installed.

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 contributors (latest version)

Contributors need uv and Python 3.12 or newer to manage the development environment.

  1. Clone the stormvogel repo (or your own fork) in a separate folder

  2. In the stormvogel folder:

    uv sync --locked --extra storm
    uv run jupyter lab
    

    This creates .venv and installs the project plus development, test, lint, and documentation tools. Omit --extra storm for core-only development, or use --all-extras for all integrations (needed for documentation builds). Some extras require system libraries such as Cairo and Graphviz; docs also need Pandoc.

  3. Install the pre-commit hook: uv run pre-commit install

Commit uv.lock when changing dependencies with uv add or uv remove. Use uv lock --upgrade to update locked versions and uv sync --locked to install them.

Testing

uv run nox -s tests   # run test suite
uv run nox -s lint    # ruff + pyright
uv run nox -s docs    # sphinx-build (executes doc notebooks)

Or run uv run pytest directly without nox.

To test without development tools or optional integrations:

uv sync --locked --no-default-groups --group test
uv run --no-sync pytest

Use --no-sync here so uv does not reinstall the default development groups.

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

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.

Metadata

Release files for stormvogel 0.13

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for stormvogel 0.13
File Size Uploaded Provenance Actions
stormvogel-0.13.tar.gz 882.0 kB Without provenance Details for stormvogel-0.13.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for stormvogel 0.13
File Interpreter ABI Platform Actions
stormvogel-0.13-py3-none-any.whl Python 3 none any Details for stormvogel-0.13-py3-none-any.whl

Total release size: 1.5 MB

Release files / stormvogel-0.13.tar.gz

Download URL stormvogel-0.13.tar.gz
Size 882.0 kB
Tags Source
SHA-256 checksum
How to use checksums
e59720e254ddd3d766c2d6ff672e943410d4fceb28d2dc1f5c95319683e91723
BLAKE2b-256 checksum
How to use checksums
9648457012db4d02b47c75e9f4a0aa4ca3fadc56a744e062e94d819d484ac077
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / stormvogel-0.13-py3-none-any.whl

Download URL stormvogel-0.13-py3-none-any.whl
Size 587.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
268d933fc33055a3edb1b6c0055b65ac7623cad4c837fb80206d630b3576e3d1
BLAKE2b-256 checksum
How to use checksums
3b3ed0822f69565cf500d841a692e408a909b185fe7f283ad18443db006e60bf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for stormvogel 0.13

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page