https://github.com/frequenz-floss/frequenz-gridpool-python
High-level interface to grid pools for the Frequenz platform
https://github.com/frequenz-floss/frequenz-gridpool-python
Last synced: 2 months ago
JSON representation
High-level interface to grid pools for the Frequenz platform
- Host: GitHub
- URL: https://github.com/frequenz-floss/frequenz-gridpool-python
- Owner: frequenz-floss
- License: mit
- Created: 2025-11-03T11:15:29.000Z (7 months ago)
- Default Branch: v0.x.x
- Last Pushed: 2026-04-01T11:06:59.000Z (2 months ago)
- Last Synced: 2026-04-01T13:07:53.207Z (2 months ago)
- Language: Python
- Size: 1.15 MB
- Stars: 0
- Watchers: 1
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Frequenz Gridpool Library
[](https://github.com/frequenz-floss/frequenz-gridpool-python/actions/workflows/ci.yaml)
[](https://pypi.org/project/frequenz-gridpool/)
[](https://frequenz-floss.github.io/frequenz-gridpool-python/)
## Introduction
High-level interface to grid pools for the Frequenz platform.
TODO(cookiecutter): Improve the README file
## Supported Platforms
The following platforms are officially supported (tested):
- **Python:** 3.11
- **Operating System:** Ubuntu Linux 20.04
- **Architectures:** amd64, arm64
## CLI
This package ships the `gridpool-cli` command with two subcommands.
### Setup
Set the Assets API credentials before running the CLI:
```bash
export ASSETS_API_URL="grpc://..."
export ASSETS_API_AUTH_KEY="..."
export ASSETS_API_SIGN_SECRET="..."
```
### Print component formulas
```bash
gridpool-cli print-formulas
```
Optional prefix formatting:
```bash
gridpool-cli print-formulas --prefix "{microgrid_id}.{component}"
```
### Render component graph
Rendering requires optional dependencies. Install with:
```bash
pip install frequenz-gridpool[render-graph]
```
```bash
gridpool-cli render-graph
```
To save without opening a window:
```bash
gridpool-cli render-graph --no-show --output component_graph.png
```
## Contributing
If you want to know how to build this project and contribute to it, please
check out the [Contributing Guide](CONTRIBUTING.md).