Frequenz Gridpool Library
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 three subcommands.
Setup
Set the Assets API credentials before running the CLI:
export ASSETS_API_URL="grpc://..."
export ASSETS_API_AUTH_KEY="..."
export ASSETS_API_SIGN_SECRET="..."
Print component formulas
gridpool-cli print-formulas <microgrid_id>
Optional prefix formatting:
gridpool-cli print-formulas <microgrid_id> --prefix "{microgrid_id}.{component}"
Render component graph
Rendering requires optional dependencies. Install with:
pip install frequenz-gridpool[render-graph]
gridpool-cli render-graph <microgrid_id>
To save without opening a window:
gridpool-cli render-graph <microgrid_id> --no-show --output component_graph.png
Generate microgrid config
Derive metadata, formulas and component IDs for one or more microgrids from the Assets API and print them as dotted-key TOML to stdout:
gridpool-cli generate-config <microgrid_id> [<microgrid_id> ...]
Redirect stdout to save the result:
gridpool-cli generate-config <microgrid_id> > microgrid.toml
You can layer existing config files with the Assets API by precedence
(--default < Assets API < --override). Values from a --default file are
overridden by the API, while a --override file keeps its own values and the
API only fills the gaps:
gridpool-cli generate-config <microgrid_id> \
--default defaults.toml \
--override overrides.toml > microgrid.toml
If no microgrid IDs are given, they are taken from the supplied files:
gridpool-cli generate-config --override existing.toml > microgrid.toml
Contributing
If you want to know how to build this project and contribute to it, please check out the Contributing Guide.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file frequenz_gridpool-0.6.1.tar.gz.
File metadata
- Download URL: frequenz_gridpool-0.6.1.tar.gz
- Upload date:
- Size: 24.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
36f53f24af553c57737aec82b7ad3d948ef8da482e4919d5d9e9839f7f0fb7a4
|
|
| MD5 |
b984be8bc6adcf320c494112127dfa0f
|
|
| BLAKE2b-256 |
344a7703bed6cd50cda16e3eb5aff2d487e53ee0547a481c2d494bd6a93323b9
|
Provenance
The following attestation bundles were made for frequenz_gridpool-0.6.1.tar.gz:
Publisher:
ci.yaml on frequenz-floss/frequenz-gridpool-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
frequenz_gridpool-0.6.1.tar.gz -
Subject digest:
36f53f24af553c57737aec82b7ad3d948ef8da482e4919d5d9e9839f7f0fb7a4 - Sigstore transparency entry: 2189845013
- Sigstore integration time:
-
Permalink:
frequenz-floss/frequenz-gridpool-python@b59f4d68ef3ec186a3e33159706eaadcc34f72fd -
Branch / Tag:
refs/tags/v0.6.1 - Owner: https://github.com/frequenz-floss
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yaml@b59f4d68ef3ec186a3e33159706eaadcc34f72fd -
Trigger Event:
push
-
Statement type:
File details
Details for the file frequenz_gridpool-0.6.1-py3-none-any.whl.
File metadata
- Download URL: frequenz_gridpool-0.6.1-py3-none-any.whl
- Upload date:
- Size: 25.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3c964c6616a5f8e0c1eb17295c73db40d035c1c73e1aec7371f0734b2794dddd
|
|
| MD5 |
5f8d3ae4acb1baf9874d84d62aadad1d
|
|
| BLAKE2b-256 |
6c9a4acb74b055d684bed964efd1c22d6bb53bebc6a180a63bf800842b0d2b57
|
Provenance
The following attestation bundles were made for frequenz_gridpool-0.6.1-py3-none-any.whl:
Publisher:
ci.yaml on frequenz-floss/frequenz-gridpool-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
frequenz_gridpool-0.6.1-py3-none-any.whl -
Subject digest:
3c964c6616a5f8e0c1eb17295c73db40d035c1c73e1aec7371f0734b2794dddd - Sigstore transparency entry: 2189845019
- Sigstore integration time:
-
Permalink:
frequenz-floss/frequenz-gridpool-python@b59f4d68ef3ec186a3e33159706eaadcc34f72fd -
Branch / Tag:
refs/tags/v0.6.1 - Owner: https://github.com/frequenz-floss
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yaml@b59f4d68ef3ec186a3e33159706eaadcc34f72fd -
Trigger Event:
push
-
Statement type:
