From 3976ef11b63b9f99fe50562e1ec751f0e163bca8 Mon Sep 17 00:00:00 2001 From: Matthias Volk Date: Thu, 22 Oct 2020 13:51:05 +0200 Subject: [PATCH] Added documentation about compatible stormpy and Storm versions --- doc/source/installation.rst | 33 +++++++++++++++++++++++++++++---- 1 file changed, 29 insertions(+), 4 deletions(-) diff --git a/doc/source/installation.rst b/doc/source/installation.rst index 2fd9bb1..5f16028 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -7,7 +7,7 @@ Requirements Before installing stormpy, make sure -- Python 3 is available on your system. Stormpy does not work with python 2. +- Python 3 is available on your system. - `pycarl `_ is available. - `Storm `_ is available on your system. @@ -15,6 +15,25 @@ To avoid issues, we suggest that both pycarl and Storm use the same version of ` 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_stormpy_storm: + +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: + +1. **Release version**: + You use the latest `release of Storm `_ or the ``stable`` branch or you installed Storm via `Homebrew `_. + 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. + +2. **Master branch**: + You use the ``master`` branch of Storm. + In this case, you need to use the ``master`` branch of stormpy as well. + Note that due to ongoing development in Storm, after some commits, the stormpy ``master`` might not work with the Storm ``master`` anymore. + We will fix such issues as fast as possible. + Installation Steps ==================== @@ -41,12 +60,18 @@ Whenever using the environment the console prompt is prefixed with ``(env)``. Building stormpy ---------------- -Clone stormpy into any suitable location:: +**Clone** the :ref:`compatible stormpy version` into any suitable location. +For the ``master`` of stormpy use:: $ git clone https://github.com/moves-rwth/stormpy.git $ cd stormpy - -Build stormpy in develop mode using your favourite python distribution way of installing: e.g.:: + +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