Browse Source

Uppercase Storm in documentation

refactoring
Matthias Volk 7 years ago
parent
commit
f47f8ee4ed
  1. 2
      doc/source/conf.py
  2. 2
      doc/source/contributors.rst
  3. 12
      doc/source/getting_started.rst
  4. 2
      doc/source/index.rst
  5. 10
      doc/source/installation.rst

2
doc/source/conf.py

@ -226,7 +226,7 @@ man_pages = [
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, 'stormpy', 'stormpy Documentation', (master_doc, 'stormpy', 'stormpy Documentation',
author, 'stormpy', 'One line description of project.',
author, 'stormpy', 'Python bindings for Storm.',
'Miscellaneous'), 'Miscellaneous'),
] ]

2
doc/source/contributors.rst

@ -2,7 +2,7 @@
Contributors 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 <http://www.stormchecker.org/>`_. 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): The bindings themselves have been developed by (lexicographically ordered):
* Sebastian Junges * Sebastian Junges

12
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 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 <http://www.stormchecker.org/>`_.
`Storm website <http://www.stormchecker.org/>`_.
While we assume some very basic programming concepts, we refrain from using more advanced concepts of python throughout the guide. 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.
@ -26,7 +26,7 @@ Building models
.. seealso:: `01-getting-started.py <https://github.com/moves-rwth/stormpy/blob/master/examples/01-getting-started.py>`_ .. seealso:: `01-getting-started.py <https://github.com/moves-rwth/stormpy/blob/master/examples/01-getting-started.py>`_
There are several ways to create a Markov chain. 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. Here, we build a Markov chain from a prism program.
Stormpy comes with a small set of examples, which we use here:: 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. 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. 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:: Storm will then add the labels accordingly::
>>> model = stormpy.build_model(prism_program, properties) >>> 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] 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 Checking properties
@ -163,7 +163,7 @@ Investigating the model
------------------------------------- -------------------------------------
.. seealso:: `06-getting-started.py <https://github.com/moves-rwth/stormpy/blob/master/examples/06-getting-started.py>`_ .. seealso:: `06-getting-started.py <https://github.com/moves-rwth/stormpy/blob/master/examples/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 >>> path = stormpy.examples.files.prism_dtmc_die
>>> prism_program = stormpy.parse_prism_program(path) >>> 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:: Thus::
>>> for state in model.states: >>> for state in model.states:
... assert len(state.actions) <= 1
... assert len(state.actions) <= 1

2
doc/source/index.rst

@ -7,7 +7,7 @@ Stormpy Documentation
=================================== ===================================
Stormpy is a set of python bindings for the probabilistic model checker `storm <https://moves-rwth.github.io/storm/>`_.
Stormpy is a set of python bindings for the probabilistic model checker `Storm <http://www.stormchecker.org/>`_.
.. toctree:: .. toctree::

10
doc/source/installation.rst

@ -8,11 +8,11 @@ Requirements
Before installing stormpy, make sure Before installing stormpy, make sure
- `pycarl <https://moves-rwth.github.io/pycarl>`_ - `pycarl <https://moves-rwth.github.io/pycarl>`_
- `storm <http://www.stormchecker.org/>`_
- `Storm <http://www.stormchecker.org/>`_
are both available on your system. To avoid issues, we suggest that both use the same version of `carl <https://smtrat.github.io/carl>`_. are both available on your system. To avoid issues, we suggest that both use the same version of `carl <https://smtrat.github.io/carl>`_.
The simplest way of ensuring this is to first install carl as explained in the `storm installation guide <http://www.stormchecker.org/documentation/installation/manual-configuration.html#carl>`_.
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 <http://www.stormchecker.org/documentation/installation/manual-configuration.html#carl>`_.
You can then install Storm and pycarl independently.
.. topic:: Virtual Environments .. topic:: Virtual Environments
@ -37,9 +37,9 @@ or::
$ pip install -ve . $ 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:: 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

Loading…
Cancel
Save