Before installing stormpy, make sure
To avoid issues, we suggest that both pycarl and Storm use the same version of carl. The simplest way of ensuring this is to first install carl as explained in the Storm installation guide. You can then install Storm and pycarl independently.
Compatibility of stormpy and Storm¶
Note that stormpy and Storm are continuously extended and modified. It is therefore important to use compatible versions of stormpy and Storm. You have two choices for stormpy depending on the version of Storm you are using:
Release version: You use the latest release of Storm or the
stablebranch. In these cases, you need to use the latest release of stormpy. For example, Storm 1.6.0 is compatible with stormpy 1.6.0.
Master branch: You use the
masterbranch of Storm. In this case, you need to use the
masterbranch of stormpy as well. Note that due to ongoing development in Storm, after some commits, the stormpy
mastermight not work with the Storm
masteranymore. We will fix such issues as fast as possible.
Unfortunately, Stormpy currently does not work in conjunction with a homebrew installation of Storm.
Virtual environments create isolated environments for your projects. This helps to keep your system clean, work with different versions of packages and different version of python. While it is not required, we recommend the use of such virtual environments. To get you started, we recommend this guide or this primer.
In short you can create a virtual environment
$ pip install virtualenv $ virtualenv -p python3 env $ source env/bin/activate
The last step activates the virtual environment.
Whenever using the environment, the console prompt is prefixed with
Clone the compatible stormpy version into any suitable location.
master of stormpy use:
$ git clone https://github.com/moves-rwth/stormpy.git $ cd stormpy
or for the latest release use (remember to use the correct version):
$ git clone https://github.com/moves-rwth/stormpy.git --branch 1.6.0 $ cd stormpy
Build stormpy in develop mode using your favourite python distribution way of installing: e.g.:
$ python3 setup.py develop
$ pip install -ve .
Optional build arguments¶
The build step
build_ext also takes optional arguments for a more advanced configuration of stormpy.
Specifying which Storm library to use
If you have multiple versions of Storm or cmake is not able to find your Storm version, you can specify the
$ python3 setup.py build_ext --storm-dir YOUR-PATH-TO-STORM develop
If you want to disable certain functionality in stormpy from being built you can use the following flags:
--disable-dftto disable support for dynamic fault trees (DFTs)
--disable-parsto disable support for parametric models
Building stormpy in debug mode
If you want to build stormpy in debug mode you can add the
$ python3 setup.py build_ext --debug develop
Setting number of build threads
The build of stormpy uses all available cores per default. If you want to configure the number of threads manually you can specify the
$ python3 setup.py build_ext --jobs 2 develop
Testing stormpy installation¶
After building, you can run the test files by either:
$ python3 setup.py test
or by invoking pytest directly with:
$ pip install pytest $ py.test tests/
If the tests pass, you can now use stormpy.
To get started, continue with our Getting Started, consult the test files in
tests/ or the Stormpy API Reference (work in progress).
Building stormpy documentation¶
To build this documentation, you need additional python dependencies as well as pandoc. You can install the required python dependencies automatically with:
$ python setup.py develop easy_install stormpy[doc,numpy]
or manually with:
$ pip install sphinx sphinx_bootstrap_theme nbsphinx ipykernel numpy
Then build the documentation:
$ cd doc $ make html