Frequenz Gridpool Library

Build Status PyPI Package Docs

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}"

The per-category formulas (pv, battery, chp, ev) read the component first and use the meter as the fallback. Use --prefer-meters-in-component-formulas for the opposite order, which is what versions before component graph v0.5.0 produced:

gridpool-cli print-formulas <microgrid_id> --prefer-meters-in-component-formulas

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

--prefer-meters-in-component-formulas works here too, so a regenerated config can keep the meter-first order of the per-category formulas:

gridpool-cli generate-config <microgrid_id> \
    --prefer-meters-in-component-formulas > microgrid.toml

Contributing

If you want to know how to build this project and contribute to it, please check out the Contributing Guide.

Project links

Data verified by PyPI on Jul 29, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

Owner

PyPI data
Data sourced directly from PyPI's database.

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for shsms from gravatar.com shsms

Credits

Author: Frequenz Energy-as-a-Service GmbH

GitHub Statistics

Data verified by PyPI on Jul 29, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python <4, >=3.11

Provides Extra

cli render-graph dev-flake8 dev-formatting dev-mkdocs dev-mypy dev-noxfile dev-pylint dev-pytest dev

Tags

frequenz python lib library gridpool

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

frequenz_gridpool-0.6.3.tar.gz (25.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

frequenz_gridpool-0.6.3-py3-none-any.whl (26.2 kB view details)

Uploaded Python 3

File details

Details for the file frequenz_gridpool-0.6.3.tar.gz.

File metadata

  • Download URL: frequenz_gridpool-0.6.3.tar.gz
  • Upload date:
  • Size: 25.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for frequenz_gridpool-0.6.3.tar.gz
Algorithm Hash digest
SHA256 c5b80ea9ad12cfab3cfc26e4516cf721535886525c9e580c8e7def52b1fb7d29
MD5 c6ac705b5b3a9edeb8f5669430b138c5
BLAKE2b-256 2356d7d47420f68ba440261796235483305e55f5ee3cd579210e066b60de9f67

See more details on using hashes here.

Provenance

The following attestation bundles were made for frequenz_gridpool-0.6.3.tar.gz:

Publisher: ci.yaml on frequenz-floss/frequenz-gridpool-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file frequenz_gridpool-0.6.3-py3-none-any.whl.

File metadata

File hashes

Hashes for frequenz_gridpool-0.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2caad747dcd8c42985f910c3c7568a6f6df61344bd494651f01cb4941a2ab85e
MD5 c4d454ab46ba66031a222d1959ff57f9
BLAKE2b-256 36e286ecd98e996311906e2bf2efcaa5943b84a221f0095494b87026102a4961

See more details on using hashes here.

Provenance

The following attestation bundles were made for frequenz_gridpool-0.6.3-py3-none-any.whl:

Publisher: ci.yaml on frequenz-floss/frequenz-gridpool-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page