Skip to content

Commit 9473219

Browse files
docs: update release notes and readme file
Signed-off-by: Mohammad Tayyab <Mohammad.Tayyab@neustrom.de>
1 parent e7758d9 commit 9473219

2 files changed

Lines changed: 47 additions & 1 deletion

File tree

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,50 @@ The following platforms are officially supported (tested):
1818
- **Operating System:** Ubuntu Linux 20.04
1919
- **Architectures:** amd64, arm64
2020

21+
## CLI
22+
23+
This package ships the `gridpool-cli` command with two subcommands.
24+
25+
### Setup
26+
27+
Set the Assets API credentials before running the CLI:
28+
29+
```bash
30+
export ASSETS_API_URL="grpc://..."
31+
export ASSETS_API_AUTH_KEY="..."
32+
export ASSETS_API_SIGN_SECRET="..."
33+
```
34+
35+
If you plan to render graphs, install the optional graph dependencies:
36+
37+
```bash
38+
pip install "frequenz-gridpool[graph]"
39+
```
40+
41+
### Print component formulas
42+
43+
```bash
44+
gridpool-cli print-formulas <microgrid_id>
45+
```
46+
47+
Optional prefix formatting:
48+
49+
```bash
50+
gridpool-cli print-formulas <microgrid_id> --prefix "{microgrid_id}.{component}"
51+
```
52+
53+
### Render component graph
54+
55+
```bash
56+
gridpool-cli render-graph <microgrid_id>
57+
```
58+
59+
To save without opening a window:
60+
61+
```bash
62+
gridpool-cli render-graph <microgrid_id> --no-show --output component_graph.png
63+
```
64+
2165
## Contributing
2266

2367
If you want to know how to build this project and contribute to it, please

RELEASE_NOTES.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@
1010

1111
## New Features
1212

13-
<!-- Here goes the main new features and examples or instructions on how to use them -->
13+
* Added `gridpool-cli render-graph` to visualize microgrid component graphs using the
14+
Assets API credentials (`ASSETS_API_URL`, `ASSETS_API_AUTH_KEY`, and
15+
`ASSETS_API_SIGN_SECRET`) and optional `graph` extras.
1416

1517
## Bug Fixes
1618

0 commit comments

Comments
 (0)