Skip to content

Commit 5ef650f

Browse files
committed
Update README.md
1 parent dec6759 commit 5ef650f

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,27 @@
11
# storm-project-starter-python
22
Starter project for the Python API of Storm via Stormpy
3+
4+
## Getting Started
5+
Before starting, make sure that Storm and stormpy are installed. If not, see the [documentation](https://moves-rwth.github.io/stormpy/installation.html) for details on how to install stormpy.
6+
7+
First, install the Python package. If you use a virtual environment, make sure to use it.
8+
To install the starter package, execute
9+
```
10+
python setup.py develop
11+
```
12+
13+
Then, run the script using
14+
```
15+
python stormpy_starter/check.py --model examples/die.pm --property examples/die.pctl
16+
```
17+
The answer should be no.
18+
19+
Then, run the script using
20+
```
21+
python stormpy_starter/check.py --model examples/die.pm --property examples/die2.pctl
22+
```
23+
The answer should be yes.
24+
25+
## What is next?
26+
You are all set to implement your own tools and algorithms on top of stormpy.
27+
Feel free to contribute your new algorithms to stormpy, such that others can enjoy them.

0 commit comments

Comments
 (0)