Skip to content

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 two 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="..."

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

Contributing¤

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