frequenz-gridpool 0.0.1__tar.gz

frequenz_gridpool-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

frequenz_gridpool-0.0.1/MANIFEST.in

@@ -0,0 +1,13 @@
+exclude .cookiecutter-replay.json
+exclude .editorconfig
+exclude .gitignore
+exclude CODEOWNERS
+exclude CONTRIBUTING.md
+exclude mkdocs.yml
+exclude noxfile.py
+exclude src/conftest.py
+recursive-exclude .github *
+recursive-exclude benchmarks *
+recursive-exclude docs *
+recursive-exclude tests *
+recursive-include py *.pyi

frequenz_gridpool-0.0.1/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: frequenz-gridpool
+Version: 0.0.1
+Summary: High-level interface to grid pools for the Frequenz platform.
+Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
+License: MIT
+Project-URL: Documentation, https://frequenz-floss.github.io/frequenz-gridpool-python/
+Project-URL: Changelog, https://github.com/frequenz-floss/frequenz-gridpool-python/releases
+Project-URL: Issues, https://github.com/frequenz-floss/frequenz-gridpool-python/issues
+Project-URL: Repository, https://github.com/frequenz-floss/frequenz-gridpool-python
+Project-URL: Support, https://github.com/frequenz-floss/frequenz-gridpool-python/discussions/categories/support
+Keywords: frequenz,python,lib,library,gridpool
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: <4,>=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: marshmallow-dataclass<9,>=8.7.1
+Requires-Dist: typing-extensions<5,>=4.14.1
+Provides-Extra: dev-flake8
+Requires-Dist: flake8==7.3.0; extra == "dev-flake8"
+Requires-Dist: flake8-docstrings==1.7.0; extra == "dev-flake8"
+Requires-Dist: flake8-pyproject==1.2.3; extra == "dev-flake8"
+Requires-Dist: pydoclint==0.8.1; extra == "dev-flake8"
+Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
+Provides-Extra: dev-formatting
+Requires-Dist: black==25.11.0; extra == "dev-formatting"
+Requires-Dist: isort==6.0.0; extra == "dev-formatting"
+Provides-Extra: dev-mkdocs
+Requires-Dist: Markdown==3.10; extra == "dev-mkdocs"
+Requires-Dist: black==25.11.0; extra == "dev-mkdocs"
+Requires-Dist: mike==2.1.3; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-gen-files==0.5.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-macros-plugin==1.5.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-material==9.7.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings[python]==0.30.1; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings-python==1.19.0; extra == "dev-mkdocs"
+Requires-Dist: frequenz-repo-config[lib]==0.13.6; extra == "dev-mkdocs"
+Provides-Extra: dev-mypy
+Requires-Dist: mypy==1.18.2; extra == "dev-mypy"
+Requires-Dist: types-Markdown==3.10.0.20251106; extra == "dev-mypy"
+Requires-Dist: frequenz-gridpool[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
+Provides-Extra: dev-noxfile
+Requires-Dist: nox==2025.11.12; extra == "dev-noxfile"
+Requires-Dist: frequenz-repo-config[lib]==0.13.6; extra == "dev-noxfile"
+Provides-Extra: dev-pylint
+Requires-Dist: frequenz-gridpool[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
+Provides-Extra: dev-pytest
+Requires-Dist: pytest==8.4.1; extra == "dev-pytest"
+Requires-Dist: pylint==4.0.3; extra == "dev-pytest"
+Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.6; extra == "dev-pytest"
+Requires-Dist: pytest-mock==3.15.1; extra == "dev-pytest"
+Requires-Dist: pytest-asyncio==1.3.0; extra == "dev-pytest"
+Requires-Dist: async-solipsism==0.8; extra == "dev-pytest"
+Provides-Extra: dev
+Requires-Dist: frequenz-gridpool[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
+Dynamic: license-file
+
+# Frequenz Gridpool Library
+
+[![Build Status](https://github.com/frequenz-floss/frequenz-gridpool-python/actions/workflows/ci.yaml/badge.svg)](https://github.com/frequenz-floss/frequenz-gridpool-python/actions/workflows/ci.yaml)
+[![PyPI Package](https://img.shields.io/pypi/v/frequenz-gridpool)](https://pypi.org/project/frequenz-gridpool/)
+[![Docs](https://img.shields.io/badge/docs-latest-informational)](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
+
+## Contributing
+
+If you want to know how to build this project and contribute to it, please
+check out the [Contributing Guide](CONTRIBUTING.md).

frequenz_gridpool-0.0.1/README.md

@@ -0,0 +1,24 @@
+# Frequenz Gridpool Library
+
+[![Build Status](https://github.com/frequenz-floss/frequenz-gridpool-python/actions/workflows/ci.yaml/badge.svg)](https://github.com/frequenz-floss/frequenz-gridpool-python/actions/workflows/ci.yaml)
+[![PyPI Package](https://img.shields.io/pypi/v/frequenz-gridpool)](https://pypi.org/project/frequenz-gridpool/)
+[![Docs](https://img.shields.io/badge/docs-latest-informational)](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
+
+## Contributing
+
+If you want to know how to build this project and contribute to it, please
+check out the [Contributing Guide](CONTRIBUTING.md).

frequenz_gridpool-0.0.1/RELEASE_NOTES.md

@@ -0,0 +1,17 @@
+# Frequenz Gridpool Library Release Notes
+
+## Summary
+
+<!-- Here goes a general summary of what this release is about -->
+
+## Upgrading
+
+<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
+
+## New Features
+
+* Adds a configuration class for microgrids copied from `frequenz-floss/lib-notebooks`.
+
+## Bug Fixes
+
+<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

frequenz_gridpool-0.0.1/pyproject.toml

@@ -0,0 +1,176 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+[build-system]
+requires = [
+  "setuptools == 80.9.0",
+  "setuptools_scm[toml] == 9.2.2",
+  "frequenz-repo-config[lib] == 0.13.6",
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "frequenz-gridpool"
+description = "High-level interface to grid pools for the Frequenz platform."
+readme = "README.md"
+license = { text = "MIT" }
+keywords = ["frequenz", "python", "lib", "library", "gridpool"]
+# TODO(cookiecutter): Remove and add more classifiers if appropriate
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Topic :: Software Development :: Libraries",
+  "Typing :: Typed",
+]
+requires-python = ">= 3.11, < 4"
+# TODO(cookiecutter): Remove and add more dependencies if appropriate
+dependencies = [
+  "marshmallow-dataclass>=8.7.1,<9",
+  "typing-extensions >= 4.14.1, < 5",
+]
+dynamic = ["version"]
+
+[[project.authors]]
+name = "Frequenz Energy-as-a-Service GmbH"
+email = "floss@frequenz.com"
+
+# TODO(cookiecutter): Remove and add more optional dependencies if appropriate
+[project.optional-dependencies]
+dev-flake8 = [
+  "flake8 == 7.3.0",
+  "flake8-docstrings == 1.7.0",
+  "flake8-pyproject == 1.2.3",  # For reading the flake8 config from pyproject.toml
+  "pydoclint == 0.8.1",
+  "pydocstyle == 6.3.0",
+]
+dev-formatting = ["black == 25.11.0", "isort == 6.0.0"]
+dev-mkdocs = [
+  "Markdown == 3.10",
+  "black == 25.11.0",
+  "mike == 2.1.3",
+  "mkdocs-gen-files == 0.5.0",
+  "mkdocs-literate-nav == 0.6.2",
+  "mkdocs-macros-plugin == 1.5.0",
+  "mkdocs-material == 9.7.0",
+  "mkdocstrings[python] == 0.30.1",
+  "mkdocstrings-python == 1.19.0",
+  "frequenz-repo-config[lib] == 0.13.6",
+]
+dev-mypy = [
+  "mypy == 1.18.2",
+  "types-Markdown == 3.10.0.20251106",
+  # For checking the noxfile, docs/ script, and tests
+  "frequenz-gridpool[dev-mkdocs,dev-noxfile,dev-pytest]",
+]
+dev-noxfile = [
+  "nox == 2025.11.12",
+  "frequenz-repo-config[lib] == 0.13.6",
+]
+dev-pylint = [
+  # dev-pytest already defines a dependency to pylint because of the examples
+  # For checking the noxfile, docs/ script, and tests
+  "frequenz-gridpool[dev-mkdocs,dev-noxfile,dev-pytest]",
+]
+dev-pytest = [
+  "pytest == 8.4.1",
+  "pylint == 4.0.3",       # We need this to check for the examples
+  "frequenz-repo-config[extra-lint-examples] == 0.13.6",
+  "pytest-mock == 3.15.1",
+  "pytest-asyncio == 1.3.0",
+  "async-solipsism == 0.8",
+]
+dev = [
+  "frequenz-gridpool[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
+]
+
+[project.urls]
+Documentation = "https://frequenz-floss.github.io/frequenz-gridpool-python/"
+Changelog = "https://github.com/frequenz-floss/frequenz-gridpool-python/releases"
+Issues = "https://github.com/frequenz-floss/frequenz-gridpool-python/issues"
+Repository = "https://github.com/frequenz-floss/frequenz-gridpool-python"
+Support = "https://github.com/frequenz-floss/frequenz-gridpool-python/discussions/categories/support"
+
+[tool.black]
+line-length = 88
+target-version = ['py311']
+include = '\.pyi?$'
+
+[tool.isort]
+profile = "black"
+line_length = 88
+src_paths = ["benchmarks", "examples", "src", "tests"]
+
+[tool.flake8]
+# We give some flexibility to go over 88, there are cases like long URLs or
+# code in documenation that have extra indentation. Black will still take care
+# of making everything that can be 88 wide, 88 wide.
+max-line-length = 100
+extend-ignore = [
+  "E203", # Whitespace before ':' (conflicts with black)
+  "W503", # Line break before binary operator (conflicts with black)
+]
+# pydoclint options
+style = "google"
+check-return-types = false
+check-yield-types = false
+arg-type-hints-in-docstring = false
+arg-type-hints-in-signature = true
+allow-init-docstring = true
+check-class-attributes = false
+
+[tool.pylint.similarities]
+ignore-comments = ['yes']
+ignore-docstrings = ['yes']
+ignore-imports = ['no']
+min-similarity-lines = 40
+
+[tool.pylint.messages_control]
+disable = [
+  "too-few-public-methods",
+  "too-many-return-statements",
+  # disabled because it conflicts with isort
+  "wrong-import-order",
+  "ungrouped-imports",
+  # Checked by mypy (and pylint is very flaky checking these)
+  "unsubscriptable-object",
+  "no-member",
+  "no-name-in-module",
+  "possibly-used-before-assignment",
+  # Checked by flake8
+  "f-string-without-interpolation",
+  "line-too-long",
+  "missing-function-docstring",
+  "redefined-outer-name",
+  "unnecessary-lambda-assignment",
+  "unused-import",
+  "unused-variable",
+]
+
+[tool.pytest.ini_options]
+addopts = "-W=all -Werror -Wdefault::DeprecationWarning -Wdefault::PendingDeprecationWarning -vv"
+testpaths = ["tests", "src"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+required_plugins = ["pytest-asyncio", "pytest-mock"]
+
+[tool.mypy]
+explicit_package_bases = true
+namespace_packages = true
+# This option disables mypy cache, and it is sometimes useful to enable it if
+# you are getting weird intermittent error, or error in the CI but not locally
+# (or vice versa). In particular errors saying that type: ignore is not
+# used but getting the original ignored error when removing the type: ignore.
+# See for example: https://github.com/python/mypy/issues/2960
+#no_incremental = true
+packages = ["frequenz.gridpool"]
+strict = true
+
+[[tool.mypy.overrides]]
+module = ["mkdocs_macros.*", "sybil", "sybil.*"]
+ignore_missing_imports = true
+
+[tool.setuptools_scm]
+version_scheme = "post-release"

frequenz_gridpool-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

frequenz_gridpool-0.0.1/src/frequenz/gridpool/__init__.py

@@ -0,0 +1,8 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""High-level interface to grid pools for the Frequenz platform."""
+
+from ._microgrid_config import MicrogridConfig
+
+__all__ = ["MicrogridConfig"]

frequenz_gridpool-0.0.1/src/frequenz/gridpool/_microgrid_config.py

@@ -0,0 +1,390 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Configuration for microgrids."""
+
+import logging
+import re
+import tomllib
+from dataclasses import field
+from pathlib import Path
+from typing import Any, ClassVar, Literal, Self, Type, cast, get_args
+
+from marshmallow import Schema
+from marshmallow_dataclass import dataclass
+
+_logger = logging.getLogger(__name__)
+
+ComponentType = Literal["grid", "pv", "battery", "consumption", "chp", "ev"]
+"""Valid component types."""
+
+ComponentCategory = Literal["meter", "inverter", "component"]
+"""Valid component categories."""
+
+
+@dataclass
+class ComponentTypeConfig:
+    """Configuration of a microgrid component type."""
+
+    meter: list[int] | None = None
+    """List of meter IDs for this component."""
+
+    inverter: list[int] | None = None
+    """List of inverter IDs for this component."""
+
+    component: list[int] | None = None
+    """List of component IDs for this component."""
+
+    formula: dict[str, str] | None = None
+    """Formula to calculate the power of this component."""
+
+    def __post_init__(self) -> None:
+        """Set the default formula if none is provided."""
+        self.formula = self.formula or {}
+        if "AC_ACTIVE_POWER" not in self.formula:
+            self.formula["AC_ACTIVE_POWER"] = "+".join(
+                [f"#{cid}" for cid in self._default_cids()]
+            )
+
+    def cids(self, metric: str = "") -> list[int]:
+        """Get component IDs for this component.
+
+        By default, the meter IDs are returned if available, otherwise the inverter IDs.
+        For components without meters or inverters, the component IDs are returned.
+
+        If a metric is provided, the component IDs are extracted from the formula.
+
+        Args:
+            metric: Metric name of the formula.
+
+        Returns:
+            List of component IDs for this component.
+
+        Raises:
+            ValueError: If the metric is not supported or improperly set.
+        """
+        if metric:
+            if not isinstance(self.formula, dict):
+                raise ValueError("Formula must be a dictionary.")
+            formula = self.formula.get(metric)
+            if not formula:
+                raise ValueError(f"{metric} does not have a formula")
+            # Extract component IDs from the formula which are given as e.g. #123
+            pattern = r"#(\d+)"
+            return [int(e) for e in re.findall(pattern, self.formula[metric])]
+
+        return self._default_cids()
+
+    def _default_cids(self) -> list[int]:
+        """Get the default component IDs for this component.
+
+        If available, the meter IDs are returned, otherwise the inverter IDs.
+        For components without meters or inverters, the component IDs are returned.
+
+        Returns:
+            List of component IDs for this component.
+
+        Raises:
+            ValueError: If no IDs are available.
+        """
+        if self.meter:
+            return self.meter
+        if self.inverter:
+            return self.inverter
+        if self.component:
+            return self.component
+
+        raise ValueError("No IDs available")
+
+    @classmethod
+    def is_valid_type(cls, ctype: str) -> bool:
+        """Check if `ctype` is a valid enum value."""
+        return ctype in get_args(ComponentType)
+
+
+@dataclass(frozen=True)
+class PVConfig:
+    """Configuration of a PV system in a microgrid."""
+
+    peak_power: float | None = None
+    """Peak power of the PV system in Watt."""
+
+    rated_power: float | None = None
+    """Rated power of the inverters in Watt."""
+
+    curtailable: bool = False
+    """Flag to indicate if PV system can be curtailed."""
+
+
+@dataclass(frozen=True)
+class WindConfig:
+    """Configuration of a wind turbine in a microgrid."""
+
+    turbine_model: str | None = None
+    """Model name of the wind turbine."""
+
+    rated_power: float | None = None
+    """Rated power of the wind turbine in Watt."""
+
+    turbine_height: float | None = None
+    """Height of the wind turbine in meters."""
+
+    number_of_turbines: int = 1
+    """Number of wind turbines."""
+
+    hellmann_exponent: float | None = None
+    """Hellmann exponent for wind speed extrapolation. See: https://w.wiki/FMw9"""
+
+    longitude: float | None = None
+    """Geographic longitude of the wind turbine."""
+
+    latitude: float | None = None
+    """Geographic latitude of the wind turbine."""
+
+
+@dataclass(frozen=True)
+class BatteryConfig:
+    """Configuration of a battery in a microgrid."""
+
+    capacity: float | None = None
+    """Capacity of the battery in Wh."""
+
+
+# pylint: disable=too-many-instance-attributes
+@dataclass(frozen=True)
+class Metadata:
+    """Metadata for a microgrid."""
+
+    microgrid_id: int
+    """ID of the microgrid."""
+
+    name: str | None = None
+    """Name of the microgrid."""
+
+    enterprise_id: int | None = None
+    """Enterprise ID of the microgrid."""
+
+    gid: int | None = None
+    """Gridpool ID of the microgrid."""
+
+    delivery_area: str | None = None
+    """Delivery area of the microgrid."""
+
+    latitude: float | None = None
+    """Geographic latitude of the microgrid."""
+
+    longitude: float | None = None
+    """Geographic longitude of the microgrid."""
+
+    altitude: float | None = None
+    """Geographic altitude of the microgrid."""
+
+
+@dataclass
+class MicrogridConfig:
+    """Configuration of a microgrid."""
+
+    meta: Metadata
+    """Metadata of the microgrid."""
+
+    pv: dict[str, PVConfig] | None = None
+    """Configuration of the PV system."""
+
+    wind: dict[str, WindConfig] | None = None
+    """Configuration of the wind turbines."""
+
+    battery: dict[str, BatteryConfig] | None = None
+    """Configuration of the batteries."""
+
+    ctype: dict[str, ComponentTypeConfig] = field(default_factory=dict)
+    """Mapping of component category types to ac power component config."""
+
+    def component_types(self) -> list[str]:
+        """Get a list of all component types in the configuration."""
+        return list(self.ctype.keys())
+
+    def component_type_ids(
+        self,
+        component_type: str,
+        component_category: str | None = None,
+        metric: str = "",
+    ) -> list[int]:
+        """Get a list of all component IDs for a component type.
+
+        Args:
+            component_type: Component type to be aggregated.
+            component_category: Specific category of component IDs to retrieve
+                (e.g., "meter", "inverter", or "component"). If not provided,
+                the default logic is used.
+            metric: Metric name of the formula if CIDs should be extracted from the formula.
+
+        Returns:
+            List of component IDs for this component type.
+
+        Raises:
+            ValueError: If the component type is unknown.
+            KeyError: If `component_category` is invalid.
+        """
+        cfg = self.ctype.get(component_type)
+        if not cfg:
+            raise ValueError(f"{component_type} not found in config.")
+
+        if component_category:
+            valid_categories = get_args(ComponentCategory)
+            if component_category not in valid_categories:
+                raise KeyError(
+                    f"Invalid component category: {component_category}. "
+                    f"Valid categories are {valid_categories}"
+                )
+            category_ids = cast(list[int], getattr(cfg, component_category, []))
+            return category_ids
+
+        return cfg.cids(metric)
+
+    def formula(self, component_type: str, metric: str) -> str:
+        """Get the formula for a component type.
+
+        Args:
+            component_type: Component type to be aggregated.
+            metric: Metric to be aggregated.
+
+        Returns:
+            Formula to be used for this aggregated component as string.
+
+        Raises:
+            ValueError: If the component type is unknown or formula is missing.
+        """
+        cfg = self.ctype.get(component_type)
+        if not cfg:
+            raise ValueError(f"{component_type} not found in config.")
+        if cfg.formula is None:
+            raise ValueError(f"No formula set for {component_type}")
+        formula = cfg.formula.get(metric)
+        if not formula:
+            raise ValueError(f"{component_type} is missing formula for {metric}")
+
+        return formula
+
+    Schema: ClassVar[Type[Schema]] = Schema
+
+    @classmethod
+    def _load_table_entries(cls, data: dict[str, Any]) -> dict[str, Self]:
+        """Load microgrid configurations from table entries.
+
+        Args:
+            data: The loaded TOML data.
+
+        Returns:
+            A dict mapping microgrid IDs to MicrogridConfig instances.
+
+        Raises:
+            ValueError: If top-level keys are not numeric microgrid IDs
+                or if there is a microgrid ID mismatch.
+            TypeError: If microgrid data is not a dict.
+        """
+        if not all(str(k).isdigit() for k in data.keys()):
+            raise ValueError("All top-level keys must be numeric microgrid IDs.")
+
+        mgrids = {}
+        for mid, entry in data.items():
+            if not mid.isdigit():
+                raise ValueError(
+                    f"Table reader: Microgrid ID key must be numeric, got {mid}"
+                )
+            if not isinstance(entry, dict):
+                raise TypeError("Table reader: Each microgrid entry must be a dict")
+
+            mgrid = cls.Schema().load(entry)
+            if mgrid.meta is None or mgrid.meta.microgrid_id is None:
+                raise ValueError(
+                    "Table reader: Each microgrid entry must have a meta.microgrid_id"
+                )
+            if int(mgrid.meta.microgrid_id) != int(mid):
+                raise ValueError(
+                    f"Table reader: Microgrid ID mismatch: key {mid} != {mgrid.meta.microgrid_id}"
+                )
+
+            mgrids[mid] = mgrid
+
+        return mgrids
+
+    @classmethod
+    def load_from_file(cls, config_path: Path) -> dict[str, Self]:
+        """
+        Load and validate configuration settings from a TOML file.
+
+        Args:
+            config_path: the path to the TOML configuration file.
+
+        Returns:
+            A dict mapping microgrid IDs to MicrogridConfig instances.
+        """
+        with config_path.open("rb") as f:
+            data = tomllib.load(f)
+
+        assert isinstance(data, dict)
+
+        return cls._load_table_entries(data)
+
+    @staticmethod
+    def load_configs(
+        microgrid_config_files: str | Path | list[str | Path] | None = None,
+        microgrid_config_dir: str | Path | None = None,
+    ) -> dict[str, "MicrogridConfig"]:
+        """Load multiple microgrid configurations from a file.
+
+        Configs for a single microgrid are expected to be in a single file.
+        Later files with the same microgrid ID will overwrite the previous configs.
+
+        Args:
+            microgrid_config_files: Path to a single microgrid config file or list of paths.
+            microgrid_config_dir: Directory containing multiple microgrid config files.
+
+        Returns:
+            Dictionary of single microgrid formula configs with microgrid IDs as keys.
+
+        Raises:
+            ValueError: If no config files or dir is provided, or if no config files are found.
+        """
+        if microgrid_config_files is None and microgrid_config_dir is None:
+            raise ValueError(
+                "No microgrid config path or directory provided. "
+                "Please provide at least one."
+            )
+
+        config_files: list[Path] = []
+
+        if microgrid_config_files:
+            if isinstance(microgrid_config_files, str):
+                config_files = [Path(microgrid_config_files)]
+            elif isinstance(microgrid_config_files, Path):
+                config_files = [microgrid_config_files]
+            elif isinstance(microgrid_config_files, list):
+                config_files = [Path(f) for f in microgrid_config_files]
+
+        if microgrid_config_dir:
+            if Path(microgrid_config_dir).is_dir():
+                config_files += list(Path(microgrid_config_dir).glob("*.toml"))
+            else:
+                raise ValueError(
+                    f"Microgrid config directory {microgrid_config_dir} "
+                    "is not a directory"
+                )
+
+        if len(config_files) == 0:
+            raise ValueError(
+                "No microgrid config files found. "
+                "Please provide at least one valid config file."
+            )
+
+        microgrid_configs: dict[str, "MicrogridConfig"] = {}
+
+        for config_path in config_files:
+            if not config_path.is_file():
+                _logger.warning("Config path %s is not a file, skipping.", config_path)
+                continue
+
+            mcfgs = MicrogridConfig.load_from_file(config_path)
+            microgrid_configs.update({str(key): value for key, value in mcfgs.items()})
+
+        return microgrid_configs

frequenz_gridpool-0.0.1/src/frequenz/gridpool/conftest.py

@@ -0,0 +1,13 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Validate docstring code examples.
+
+Code examples are often wrapped in triple backticks (```) within docstrings.
+This plugin extracts these code examples and validates them using pylint.
+"""
+
+from frequenz.repo.config.pytest import examples
+from sybil import Sybil
+
+pytest_collect_file = Sybil(**examples.get_sybil_arguments()).pytest()

frequenz_gridpool-0.0.1/src/frequenz_gridpool.egg-info/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: frequenz-gridpool
+Version: 0.0.1
+Summary: High-level interface to grid pools for the Frequenz platform.
+Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
+License: MIT
+Project-URL: Documentation, https://frequenz-floss.github.io/frequenz-gridpool-python/
+Project-URL: Changelog, https://github.com/frequenz-floss/frequenz-gridpool-python/releases
+Project-URL: Issues, https://github.com/frequenz-floss/frequenz-gridpool-python/issues
+Project-URL: Repository, https://github.com/frequenz-floss/frequenz-gridpool-python
+Project-URL: Support, https://github.com/frequenz-floss/frequenz-gridpool-python/discussions/categories/support
+Keywords: frequenz,python,lib,library,gridpool
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: <4,>=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: marshmallow-dataclass<9,>=8.7.1
+Requires-Dist: typing-extensions<5,>=4.14.1
+Provides-Extra: dev-flake8
+Requires-Dist: flake8==7.3.0; extra == "dev-flake8"
+Requires-Dist: flake8-docstrings==1.7.0; extra == "dev-flake8"
+Requires-Dist: flake8-pyproject==1.2.3; extra == "dev-flake8"
+Requires-Dist: pydoclint==0.8.1; extra == "dev-flake8"
+Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
+Provides-Extra: dev-formatting
+Requires-Dist: black==25.11.0; extra == "dev-formatting"
+Requires-Dist: isort==6.0.0; extra == "dev-formatting"
+Provides-Extra: dev-mkdocs
+Requires-Dist: Markdown==3.10; extra == "dev-mkdocs"
+Requires-Dist: black==25.11.0; extra == "dev-mkdocs"
+Requires-Dist: mike==2.1.3; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-gen-files==0.5.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-macros-plugin==1.5.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-material==9.7.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings[python]==0.30.1; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings-python==1.19.0; extra == "dev-mkdocs"
+Requires-Dist: frequenz-repo-config[lib]==0.13.6; extra == "dev-mkdocs"
+Provides-Extra: dev-mypy
+Requires-Dist: mypy==1.18.2; extra == "dev-mypy"
+Requires-Dist: types-Markdown==3.10.0.20251106; extra == "dev-mypy"
+Requires-Dist: frequenz-gridpool[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
+Provides-Extra: dev-noxfile
+Requires-Dist: nox==2025.11.12; extra == "dev-noxfile"
+Requires-Dist: frequenz-repo-config[lib]==0.13.6; extra == "dev-noxfile"
+Provides-Extra: dev-pylint
+Requires-Dist: frequenz-gridpool[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
+Provides-Extra: dev-pytest
+Requires-Dist: pytest==8.4.1; extra == "dev-pytest"
+Requires-Dist: pylint==4.0.3; extra == "dev-pytest"
+Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.6; extra == "dev-pytest"
+Requires-Dist: pytest-mock==3.15.1; extra == "dev-pytest"
+Requires-Dist: pytest-asyncio==1.3.0; extra == "dev-pytest"
+Requires-Dist: async-solipsism==0.8; extra == "dev-pytest"
+Provides-Extra: dev
+Requires-Dist: frequenz-gridpool[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
+Dynamic: license-file
+
+# Frequenz Gridpool Library
+
+[![Build Status](https://github.com/frequenz-floss/frequenz-gridpool-python/actions/workflows/ci.yaml/badge.svg)](https://github.com/frequenz-floss/frequenz-gridpool-python/actions/workflows/ci.yaml)
+[![PyPI Package](https://img.shields.io/pypi/v/frequenz-gridpool)](https://pypi.org/project/frequenz-gridpool/)
+[![Docs](https://img.shields.io/badge/docs-latest-informational)](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
+
+## Contributing
+
+If you want to know how to build this project and contribute to it, please
+check out the [Contributing Guide](CONTRIBUTING.md).

frequenz_gridpool-0.0.1/src/frequenz_gridpool.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+MANIFEST.in
+README.md
+RELEASE_NOTES.md
+pyproject.toml
+src/frequenz/gridpool/__init__.py
+src/frequenz/gridpool/_microgrid_config.py
+src/frequenz/gridpool/conftest.py
+src/frequenz/gridpool/py.typed
+src/frequenz_gridpool.egg-info/PKG-INFO
+src/frequenz_gridpool.egg-info/SOURCES.txt
+src/frequenz_gridpool.egg-info/dependency_links.txt
+src/frequenz_gridpool.egg-info/requires.txt
+src/frequenz_gridpool.egg-info/top_level.txt

frequenz_gridpool-0.0.1/src/frequenz_gridpool.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

frequenz_gridpool-0.0.1/src/frequenz_gridpool.egg-info/requires.txt

@@ -0,0 +1,48 @@
+marshmallow-dataclass<9,>=8.7.1
+typing-extensions<5,>=4.14.1
+
+[dev]
+frequenz-gridpool[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]
+
+[dev-flake8]
+flake8==7.3.0
+flake8-docstrings==1.7.0
+flake8-pyproject==1.2.3
+pydoclint==0.8.1
+pydocstyle==6.3.0
+
+[dev-formatting]
+black==25.11.0
+isort==6.0.0
+
+[dev-mkdocs]
+Markdown==3.10
+black==25.11.0
+mike==2.1.3
+mkdocs-gen-files==0.5.0
+mkdocs-literate-nav==0.6.2
+mkdocs-macros-plugin==1.5.0
+mkdocs-material==9.7.0
+mkdocstrings[python]==0.30.1
+mkdocstrings-python==1.19.0
+frequenz-repo-config[lib]==0.13.6
+
+[dev-mypy]
+mypy==1.18.2
+types-Markdown==3.10.0.20251106
+frequenz-gridpool[dev-mkdocs,dev-noxfile,dev-pytest]
+
+[dev-noxfile]
+nox==2025.11.12
+frequenz-repo-config[lib]==0.13.6
+
+[dev-pylint]
+frequenz-gridpool[dev-mkdocs,dev-noxfile,dev-pytest]
+
+[dev-pytest]
+pytest==8.4.1
+pylint==4.0.3
+frequenz-repo-config[extra-lint-examples]==0.13.6
+pytest-mock==3.15.1
+pytest-asyncio==1.3.0
+async-solipsism==0.8

frequenz_gridpool-0.0.1/src/frequenz_gridpool.egg-info/top_level.txt

@@ -0,0 +1 @@
+frequenz