Releases: frequenz-floss/frequenz-gridpool-python
Release list
v0.6.2
Frequenz Gridpool Library Release Notes
Summary
This release updates the microgrid component graph library to v0.5.0 and adds a way to configure how the component graph is built.
Upgrading
- The per-category formulas (
pv,battery,chp,ev) now read the component first and use the meter as the fallback. This is the opposite of the old order, and it changes the generated config. Regenerate stored configs with this release and review the diff. - To keep the old order, pass
ComponentGraphConfig(prefer_meters_in_component_formulas=True)toload_configs,load_configs_from_apiorComponentGraphGenerator, or use the new--prefer-meters-in-component-formulasflag of the CLI. - The update brings more changes, for example to the
consumptionformula and to the graph validation error messages. See the v0.5.0 release notes of the component graph library for the full list.
New Features
load_configsandload_configs_from_apitake acomponent_graph_configargument, andComponentGraphGeneratortakes it asconfig. It controls how the component graph is built and how its formulas are generated.ComponentGraphConfigandFormulaOverridesare re-exported fromfrequenz.gridpoolandfrequenz.gridpool.config.- The
generate-configandprint-formulasCLI commands take a--prefer-meters-in-component-formulasflag, which reads the meter before the component in the per-category formulas.
Bug Fixes
What's Changed
Full Changelog: v0.6.1...v0.6.2
v0.4.5
Frequenz Gridpool Library Release Notes
Summary
Upgrading
-
This updates the component-graph library to v0.5.0, which now needs
frequenz-client-assets>= 0.3.1. It changes the generated per-category formulas, so regenerate stored configs with this release and review the diff.- The formula fallback engine was rewritten. Formulas can now use meter subtraction as a fallback, which gives better fallback coverage. The exact formula strings can differ from the previous release, even for the same graph.
- The per-category formulas (
pv,battery,chp,ev) now read the component first and use the meter as the fallback. This is the opposite of the previous order.
See the v0.5.0 release notes of the component graph library for the full list of changes.
New Features
Bug Fixes
What's Changed
Full Changelog: v0.4.4...v0.4.5
v0.6.1
Frequenz Gridpool Library Release Notes
Summary
Upgrading
New Features
- Added an
--inplaceflag to thegenerate-configCLI command: patches--defaultdirectly instead of printing to stdout, only filling in values it's missing so existing comments, field order and formatting survive untouched. generate-confignow renders whole-number values (e.g. peak/rated power) as underscore-grouped ints (1_736_680) instead of floats (1736680.0), avoiding spurious diffs.
Bug Fixes
What's Changed
- Reset release notes by @cwasicki in #101
- Build(deps): Bump frequenz-floss/gh-action-setup-python-with-deps from 1.0.4 to 1.0.5 in the compatible group by @dependabot[bot] in #102
- Build(deps): Bump actions/checkout from 6.0.2 to 7.0.0 by @dependabot[bot] in #103
- Build(deps-dev): Bump the patch group with 2 updates by @dependabot[bot] in #104
- Build(deps-dev): Bump pydoclint from 0.8.4 to 0.9.0 by @dependabot[bot] in #107
- Build(deps-dev): Bump the minor group across 1 directory with 2 updates by @dependabot[bot] in #105
- Build(deps-dev): Bump frequenz-repo-config from 0.17.0 to 0.18.0 in the repo-config group across 1 directory by @dependabot[bot] in #106
- build(deps): bump the compatible group with 2 updates by @dependabot[bot] in #108
- feat(cli): add --inplace patching to generate-config by @cwasicki in #109
Full Changelog: v0.6.0...v0.6.1
v0.5.1
Frequenz Gridpool Library Release Notes
Summary
Upgrading
New Features
- Add start and end time to microgrid configs.
Bug Fixes
What's Changed
- Add start and end times to microgrid component configs by @cwasicki in #88
- Update assets client to v0.3.1 by @cwasicki in #89
Full Changelog: v0.5.0...v0.5.1
v0.5.0
Frequenz Gridpool Library Release Notes
Summary
Upgrading
- Change the
curtailableflag default of the PV config toNone.
New Features
Bug Fixes
What's Changed
- Clear release notes by @shsms in #83
- Remove default for curtailable flag in PV config by @cwasicki in #84
Full Changelog: v0.4.3...v0.5.0
v0.4.3
Frequenz Gridpool Library Release Notes
Upgrading
- This updates the component-graph version to 0.4, which breaks the config format for component graphs when there are created.
What's Changed
- docs: reset release notes by @Mohammad-Tayyab-Frequenz in #81
- Bump component-graph version to 0.4.0 by @shsms in #82
Full Changelog: v0.4.2...v0.4.3
v0.4.2
Frequenz Gridpool Library Release Notes
Summary
Upgrading
New Features
- If there are unconnected breakers at a site, they are now hidden from the component graph. If there are breakers with connections to other components, they are still sent to the component graph. This is a temporary measure until the graph traversal supports breakers.
Bug Fixes
- Fixed auto-formula population to only fill formulas for component types already present in a microgrid configuration. This prevents creating placeholder entries with
Noneformulas for component types that are not configured.
What's Changed
- Reset release notes by @cwasicki in #73
- Hide unconnected breakers from component graph by @shsms in #68
- Build(deps): Bump frequenz-floss/gh-action-setup-python-with-deps from 0d0d77eac3b54799f31f25a1060ef2c6ebdf9299 to e4d0b2ef8f5a1612d7827f3abaef17c931d2b946 by @dependabot[bot] in #75
- Build(deps): Bump the compatible group with 5 updates by @dependabot[bot] in #74
- Build(deps): Bump frequenz-floss/gh-action-setup-git from 16952aac3ccc01d27412fe0dea3ea946530dcace to f9d86a01228ee1cadaac5224d4d7626f1eb23f90 by @dependabot[bot] in #76
- Build(deps-dev): Bump the patch group with 3 updates by @dependabot[bot] in #77
- Build(deps-dev): Bump the minor group with 2 updates by @dependabot[bot] in #78
- Build(deps-dev): Bump types-markdown from 3.10.2.20260211 to 3.10.2.20260408 by @dependabot[bot] in #79
- Fix load auto formula by @Mohammad-Tayyab-Frequenz in #80
Full Changelog: v0.4.1...v0.4.2
v0.4.1
Frequenz Gridpool Library Release Notes
Summary
Upgrading
- Default formulas for AC active power and energy are removed.
New Features
Bug Fixes
What's Changed
- Remove default formula for active power and energy by @cwasicki in #55
- Add repo-config auto-migration workflow by @llucax in #56
- Build(deps-dev): Bump the repo-config group with 2 updates by @dependabot[bot] in #60
- Build(deps): Bump actions/create-github-app-token from 2.2.1 to 3.0.0 by @dependabot[bot] in #58
- Build(deps-dev): Bump nox from 2025.11.12 to 2026.2.9 by @dependabot[bot] in #64
- Build(deps-dev): Bump mkdocstrings-python from 1.19.0 to 2.0.3 by @dependabot[bot] in #63
- Build(deps-dev): Bump setuptools from 80.10.1 to 82.0.1 by @dependabot[bot] in #61
- Build(deps-dev): Bump the patch group with 3 updates by @dependabot[bot] in #59
- Build(deps-dev): Bump black from 25.11.0 to 26.3.1 by @dependabot[bot] in #62
- Build(deps-dev): Bump mkdocs-gen-files from 0.5.0 to 0.6.1 by @dependabot[bot] in #65
- Build(deps-dev): Bump isort from 7.0.0 to 8.0.1 by @dependabot[bot] in #66
- Update release notes by @cwasicki in #67
- Build(deps): Bump the compatible group across 1 directory with 2 updates by @dependabot[bot] in #57
- Build(deps): Bump the compatible group with 2 updates by @dependabot[bot] in #69
- Build(deps-dev): Bump mypy from 1.19.1 to 1.20.0 in the minor group by @dependabot[bot] in #70
- Build(deps-dev): Bump setuptools-scm from 9.2.2 to 10.0.5 by @dependabot[bot] in #72
- Build(deps-dev): Bump frequenz-repo-config from 0.16.0 to 0.17.0 in the repo-config group across 1 directory by @dependabot[bot] in #71
New Contributors
Full Changelog: v0.4.0...v0.4.1
v0.4.0
Frequenz Gridpool Library Release Notes
Summary
This release adds default formulas for AC energy metrics when they are not
explicitly configured.
Upgrading
- Update assets client to v0.3.0.
New Features
- Added default summation formulas for
AC_ENERGY_ACTIVE,
AC_ENERGY_ACTIVE_CONSUMED, andAC_ENERGY_ACTIVE_DELIVEREDwhen formulas are
not provided. The defaults are built from the component IDs configured for the
component type.
Bug Fixes
What's Changed
- Build(deps): Bump actions/download-artifact from 7 to 8 by @dependabot[bot] in #50
- Build(deps): Bump frequenz-floss/gh-action-setup-python-with-deps from 1.0.1 to 1.0.2 in the compatible group by @dependabot[bot] in #49
- Build(deps): Bump actions/upload-artifact from 6 to 7 by @dependabot[bot] in #51
- Build(deps-dev): Bump the patch group across 1 directory with 5 updates by @dependabot[bot] in #52
- Add support active energy by @Mohammad-Tayyab-Frequenz in #53
- Update assets client to v0.3.0 by @cwasicki in #54
Full Changelog: v0.3.1...v0.4.0
v0.3.1
Frequenz Gridpool Library Release Notes
Summary
Upgrading
- The minimum required version of
frequenz-microgrid-component-graphis nowv0.3.4.
New Features
- Added
gridpool-cli render-graphto visualize microgrid component graphs using the
Assets API credentials (ASSETS_API_URL,ASSETS_API_AUTH_KEY, and
ASSETS_API_SIGN_SECRET).
Bug Fixes
- Fixed component graph rendering so children follow the vertical order of their parents, keeping upper-level branches above lower ones in the layered layout.
What's Changed
- Add component graph renderer by @Mohammad-Tayyab-Frequenz in #41
- fix: order component layers in the graph by @Mohammad-Tayyab-Frequenz in #42
- Build(deps-dev): Bump pytest from 8.4.1 to 9.0.2 by @dependabot[bot] in #39
- Build(deps-dev): Bump the patch group across 1 directory with 3 updates by @dependabot[bot] in #44
- Build(deps-dev): Bump setuptools from 80.9.0 to 80.10.1 in the minor group across 1 directory by @dependabot[bot] in #43
- Build(deps): Bump actions/upload-artifact from 5 to 6 by @dependabot[bot] in #32
Full Changelog: v0.3.0...v0.3.1