Skip to content

Commit f345779

Browse files
committed
docs
1 parent 366972e commit f345779

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,21 @@ The probability to get from state `1` to state `0` is `0.3`.
3535
Suppose the motion begins at state `1`. How can we calculate the probability that we will get to state `R`
3636
before we get to state `L`? What is the probability we will get to state `3` before `L` and `R`?
3737

38-
# The code
38+
# What the module does
3939

4040
The described problem is [well modeled](https://math.stackexchange.com/a/2912626) by [Absorbing Markov chains](https://en.wikipedia.org/wiki/Absorbing_Markov_chain).
41-
The code performs the necessary matrix calculations in `numpy` and returns the answers as `float` numbers.
41+
The code performs the necessary matrix calculations in `numpy` and returns the answers as `float` numbers.
42+
43+
# How to install
44+
45+
```bash
46+
cd /abc/your_project
47+
svn export https://github.com/rtmigo/markov_walk/trunk/markov_walk markov_walk
48+
```
49+
50+
Now you can `import markov_walk` from `/abc/your_project/your_module.py`
51+
52+
# How to use
4253

4354
```python3
4455
from markov_walk import MarkovWalk

0 commit comments

Comments
 (0)