README.md 556 Bytes
Newer Older
Jan Dinkelbach's avatar
Jan Dinkelbach committed
1
2
# PyVolt
 
Jan Dinkelbach's avatar
Jan Dinkelbach committed
3
This package provides algorithms for running powerflow simulations, state estimation and FLISR in Python. <br>
Jan Dinkelbach's avatar
Jan Dinkelbach committed
4
It uses [CIMpy](https://git.rwth-aachen.de/acs/public/cim/cimpy) to read network data based on the Common Information Model.
Jan Dinkelbach's avatar
Jan Dinkelbach committed
5
6
7

## Installation

Jan Dinkelbach's avatar
Jan Dinkelbach committed
8
9
10
### User 

Install the pyvolt package with
Jan Dinkelbach's avatar
Jan Dinkelbach committed
11
12

```
Jan Dinkelbach's avatar
Jan Dinkelbach committed
13
python setup.py install
Jan Dinkelbach's avatar
Jan Dinkelbach committed
14
15
16
```


Jan Dinkelbach's avatar
Jan Dinkelbach committed
17
### Developer
Jan Dinkelbach's avatar
Jan Dinkelbach committed
18

Jan Dinkelbach's avatar
Jan Dinkelbach committed
19
Install the pyvolt package in development mode with
Jan Dinkelbach's avatar
Jan Dinkelbach committed
20
21
22
23
24
25
26
27

```
python setup.py develop
```

## Getting started

To get started you find executable examples under [examples/quickstart](examples/quickstart)