Skip to content

Commit c15a384

Browse files
committed
Add documentation
Signed-off-by: Thijs Baaijen <[email protected]>
1 parent 422d76f commit c15a384

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ demos/index
3535
model_structure
3636
model_interface
3737
examples/index
38+
visualizer
3839
advanced_documentation/index
3940
```
4041

docs/visualizer.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Visualizer
2+
3+
## Features
4+
5+
- Based on [dash-cytoscape](https://github.com/plotly/dash-cytoscape).
6+
- Visualize small and large (10000+ nodes) networks
7+
- Explore attributes of nodes and branches
8+
- Highlight specific nodes and branches
9+
- Visualize various layouts, including hierarchical, force-directed and coordinate-based layouts
10+
11+
With Coordinates | Hierarchical | Force-Directed
12+
:------------------:|:------------:|:-------------:
13+
<img width="250" alt="Coordinates" src="https://github.com/user-attachments/assets/6f991cb1-08b4-4c4b-8adc-eed36f58db40" /> | <img width="250" alt="Hierarchical" src="https://github.com/user-attachments/assets/0cf5684d-fb7c-4920-92b8-1e49bc827a92" /> | <img width="250" alt="Force-Directed" src="https://github.com/user-attachments/assets/f0167ded-ceb4-4a31-a91e-e029dd6d7f13" />
14+
15+
-----
16+
## Quickstart
17+
#### Installation
18+
```bash
19+
pip install 'power-grid-model-ds[visualizer]' # quotes added for zsh compatibility
20+
```
21+
22+
#### Usage
23+
```python
24+
from power_grid_model_ds import Grid
25+
from power_grid_model_ds.visualizer import visualize
26+
from power_grid_model_ds.generators import RadialGridGenerator
27+
28+
grid = RadialGridGenerator(Grid).run()
29+
visualize(grid)
30+
```
31+
This will start a local web server at http://localhost:8050
32+

0 commit comments

Comments
 (0)