diff --git a/doc/source/conf.py b/doc/source/conf.py index 09d07f1..2fbcfa8 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -226,7 +226,7 @@ man_pages = [ # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'stormpy', 'stormpy Documentation', - author, 'stormpy', 'One line description of project.', + author, 'stormpy', 'Python bindings for Storm.', 'Miscellaneous'), ] diff --git a/doc/source/contributors.rst b/doc/source/contributors.rst index 619e8fe..464d72b 100644 --- a/doc/source/contributors.rst +++ b/doc/source/contributors.rst @@ -2,7 +2,7 @@ Contributors ************** -Stormpy is an extension to storm. As a consequence, developers of storm contributed significantly to the functionality offered by these Python bindings. +Stormpy is an extension to `Storm `_. As a consequence, developers of Storm contributed significantly to the functionality offered by these Python bindings. The bindings themselves have been developed by (lexicographically ordered): * Sebastian Junges diff --git a/doc/source/getting_started.rst b/doc/source/getting_started.rst index 01598ff..09bd59f 100644 --- a/doc/source/getting_started.rst +++ b/doc/source/getting_started.rst @@ -8,7 +8,7 @@ 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. @@ -26,7 +26,7 @@ Building models .. seealso:: `01-getting-started.py `_ There are several ways to create a Markov chain. -One of the easiest is to parse a description of such a Markov chain and to let storm build the chain. +One of the easiest is to parse a description of such a Markov chain and to let Storm build the chain. Here, we build a Markov chain from a prism program. Stormpy comes with a small set of examples, which we use here:: @@ -74,7 +74,7 @@ Stormpy can be used to parse this. As the variables in the property refer to a p Notice that properties is now a list of properties containing a single element. However, if we build the model as before, then the appropriate information that the variable s=2 in some states is not present. -In order to label the states accordingly, we should notify storm upon building the model that we would like to preserve given properties. +In order to label the states accordingly, we should notify Storm upon building the model that we would like to preserve given properties. Storm will then add the labels accordingly:: >>> model = stormpy.build_model(prism_program, properties) @@ -91,7 +91,7 @@ If we consider another property, however, such as:: P=? [F s=7 & d=2] -then storm is only skipping exploration of successors of the particular state y where s=7 and d=2. In this model, state y has a self-loop, so effectively, the whole model is explored. +then Storm is only skipping exploration of successors of the particular state y where s=7 and d=2. In this model, state y has a self-loop, so effectively, the whole model is explored. Checking properties @@ -163,7 +163,7 @@ Investigating the model ------------------------------------- .. seealso:: `06-getting-started.py `_ -One powerful part of the storm model checker is to quickly create the Markov chain from higher-order descriptions, as seen above:: +One powerful part of the Storm model checker is to quickly create the Markov chain from higher-order descriptions, as seen above:: >>> path = stormpy.examples.files.prism_dtmc_die >>> prism_program = stormpy.parse_prism_program(path) @@ -207,4 +207,4 @@ Let us go into some more details. For DTMCs, each state has (at most) one outgoi Thus:: >>> for state in model.states: - ... assert len(state.actions) <= 1 \ No newline at end of file + ... assert len(state.actions) <= 1 diff --git a/doc/source/index.rst b/doc/source/index.rst index edfa65c..4adead3 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -7,7 +7,7 @@ Stormpy Documentation =================================== -Stormpy is a set of python bindings for the probabilistic model checker `storm `_. +Stormpy is a set of python bindings for the probabilistic model checker `Storm `_. .. toctree:: diff --git a/doc/source/installation.rst b/doc/source/installation.rst index 84439b0..69d2915 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -8,11 +8,11 @@ Requirements Before installing stormpy, make sure - `pycarl `_ -- `storm `_ +- `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 `_. -You can then install storm and pycarl independently. +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 @@ -37,9 +37,9 @@ or:: $ pip install -ve . -.. topic:: Specifying which storm library to use +.. topic:: Specifying which Storm library to use - If you have multiple versions of storm or cmake is not able to find your storm version, + 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