diff --git a/doc/source/getting_started.rst b/doc/source/getting_started.rst index 7f87af0..e2ac8ed 100644 --- a/doc/source/getting_started.rst +++ b/doc/source/getting_started.rst @@ -8,10 +8,10 @@ A Quick Tour through Stormpy ================================ This guide is intended for people which have a basic understanding of probabilistic models and their verification. More details and further pointers to literature can be found on the -`storm website `_. +`storm website `_. While we assume some very basic programming concepts, we refrain from using more advanced concepts of python throughout the guide. -We start with a selection of high-level constructs in stormpy, and go into more details afterwards. +We start with a selection of high-level constructs in stormpy, and go into more details afterwards. .. seealso:: The code examples are also given in the examples/ folder. These boxes throughout the text will tell you which example contains the code discussed. diff --git a/doc/source/installation.rst b/doc/source/installation.rst index bc1e48e..ef6bcb8 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -5,13 +5,13 @@ Installation Requirements ================== -Before installing stormpy, make sure +Before installing stormpy, make sure -- `pycarl `_ -- `storm `_ +- `pycarl `_ +- `storm `_ -are both available on your system. To avoid issues, we suggest that both use the same version of `carl `_. -The simplest way of ensuring this is to first install carl as explained in the `storm installation guide `_. +are both available on your system. To avoid issues, we suggest that both 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. .. topic:: Virtual Environments @@ -25,7 +25,7 @@ Installation Steps Clone stormpy into any suitable location:: - $ git clone https://srv-i2.informatik.rwth-aachen.de/scm/git/stormpy.git + $ git clone https://github.com/moves-rwth/stormpy.git $ cd stormpy Here, build stormpy in develop mode using your favourite python distribution way of installing: e.g.:: @@ -42,12 +42,11 @@ or:: If you have multiple versions of storm or cmake is not able to find your storm version, you can specify the `--storm-DIR YOUR-PATH-TO-STORM` flag in the build_ext step:: - $ python3 setup.py build_ext --storm-DIR YOUR-PATH-TO-STORM develop - - + $ python3 setup.py build_ext --storm-DIR YOUR-PATH-TO-STORM develop + After building, you can run the test files by:: - py.test tests/ + py.test tests/ If tests pass, you can continue with our :doc:`getting_started`.