grid-data-models 2.3.0__tar.gz → 2.3.2__tar.gz

{grid_data_models-2.3.0 → grid_data_models-2.3.2}/.gitignore

@@ -7,6 +7,8 @@ __pycache__/
 *.so
 *.code-workspace
 *.sqlite
+*.db
+*.sql
 *.ruff_cache/
 
 # Distribution / packaging
@@ -163,3 +165,5 @@ cython_debug/
 #.idea/
 .qodo
 .DS_Store
+*.dump
+uv.lock

{grid_data_models-2.3.0 → grid_data_models-2.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: grid-data-models
-Version: 2.3.0
+Version: 2.3.2
 Project-URL: Documentation, https://github.com/NREL-Distribution-Suites/grid-data-models#readme
 Project-URL: Issues, https://github.com/NREL-Distribution-Suites/grid-data-models/issues
 Project-URL: Source, https://github.com/NREL-Distribution-Suites/grid-data-models
@@ -11,7 +11,6 @@ Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.11
-Requires-Dist: click~=8.1.7
 Requires-Dist: geopandas
 Requires-Dist: importlib-metadata
 Requires-Dist: infrasys~=1.0
@@ -20,6 +19,7 @@ Requires-Dist: pandas~=2.2.3
 Requires-Dist: plotly
 Requires-Dist: pydantic
 Requires-Dist: semver
+Requires-Dist: typer
 Provides-Extra: dev
 Requires-Dist: docutils; extra == 'dev'
 Requires-Dist: pre-commit; extra == 'dev'
@@ -30,6 +30,7 @@ Requires-Dist: pytest-doctestplus; extra == 'dev'
 Requires-Dist: ruff; extra == 'dev'
 Provides-Extra: doc
 Requires-Dist: autodoc-pydantic[erdantic]; extra == 'doc'
+Requires-Dist: jupyter-book<3,>=2; extra == 'doc'
 Requires-Dist: myst-parser; extra == 'doc'
 Requires-Dist: pydata-sphinx-theme; extra == 'doc'
 Requires-Dist: sphinx; extra == 'doc'
@@ -40,7 +41,7 @@ Description-Content-Type: text/markdown
 
 
 
-[![Upload to PyPi](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/publish_to_pypi.yml/badge.svg)](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/publish_to_pypi.yml) •  [![Pytest](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/pull_request_tests.yml/badge.svg)](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/pull_request_tests.yml) •  [![deploy-book](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/deploy.yml/badge.svg)](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/deploy.yml) • ![PyPI - Downloads](https://img.shields.io/pypi/dm/grid-data-models) •  [![codecov](https://codecov.io/github/NLR-Distribution-Suite/grid-data-models/branch/main/graph/badge.svg?token=K0X11EXOX8)](https://codecov.io/github/NLR-Distribution-Suite/grid-data-models) •  [![CodeFactor](https://www.codefactor.io/repository/github/nlr-distribution-suite/grid-data-models/badge)](https://www.codefactor.io/repository/github/nlr-distribution-suite/grid-data-models) • ![MCP Server](https://img.shields.io/badge/MCP_Server-enabled-brightgreen) • ![MCP Tools](https://img.shields.io/badge/MCP_Tools-20-blue)
+[![Upload to PyPi](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/publish_to_pypi.yml/badge.svg)](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/publish_to_pypi.yml) •  [![Pytest](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/pull_request_tests.yml/badge.svg)](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/pull_request_tests.yml) •  [![deploy-book](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/deploy.yml/badge.svg)](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/deploy.yml) • ![PyPI - Downloads](https://img.shields.io/pypi/dm/grid-data-models) •  [![codecov](https://codecov.io/github/NLR-Distribution-Suite/grid-data-models/branch/main/graph/badge.svg?token=K0X11EXOX8)](https://codecov.io/github/NLR-Distribution-Suite/grid-data-models) •  [![CodeFactor](https://www.codefactor.io/repository/github/nlr-distribution-suite/grid-data-models/badge)](https://www.codefactor.io/repository/github/nlr-distribution-suite/grid-data-models) • ![MCP Server](https://img.shields.io/badge/MCP_Server-enabled-brightgreen) • ![MCP Tools](https://img.shields.io/badge/MCP_Tools-20-blue) • [![GitHub issues](https://img.shields.io/github/issues/NLR-Distribution-Suite/grid-data-models)](https://github.com/NLR-Distribution-Suite/grid-data-models/issues) • [![License](https://img.shields.io/github/license/NLR-Distribution-Suite/grid-data-models)](https://github.com/NLR-Distribution-Suite/grid-data-models/blob/main/LICENSE.txt)
 
 # Grid Data Models (GDM)
 
@@ -61,7 +62,7 @@ In an effort to reduce code duplication and provide client packages a standard i
 - **Built-in validation layer:** Use of [pydantic](https://docs.pydantic.dev/latest/) allows us to validate model fields.
 - **Time series data management:** GDM uses [infrasys](https://github.nrel.gov/CADET/infrastructure_systems) package which enables [efficient time series data management](https://nrel.github.io/infrasys/explanation/time_series.html) by sharing arrays across components and offloading system memory. For example, we can attach time series power consumption data to a load profile.
 - **Built-in unit conversion:** GDM leverages [pint](https://pint.readthedocs.io/en/stable/) for unit conversion for power system quantities. For example, power, voltage, time, etc.
-- **JSON serialization/deserialization:** GDM uses [infrasys](https://github.com/NREL/infrasys) to serialize and deserialize distribution system components to/from JSON.
+- **JSON serialization/deserialization:** GDM uses [infrasys](https://github.com/NatLabRockies/infrasys) to serialize and deserialize distribution system components to/from JSON.
 - **Track System Changes:** Supports tracking changes within a distribution model (both temporal and scenario-based static updates), enabling powerful scenario management capabilities.
 - **Graph-Based Analysis:** Exposes a connectivity graph using NetworkX, allowing advanced graph-based algorithms and visualizations.
 - **Interoperability:** Easily integrates with existing tools.
@@ -97,9 +98,9 @@ For more details, see the [MCP documentation](docs/mcp/).
 
 ## Contributors
 
-- **Kapil Duwadi**
 - **Aadil Latif**
-- **Tarek Elgindy**
-- **Pedro Andres Sanchez Perez**
 - **Daniel Thom**
 - **Jeremy Keen**
+- **Kapil Duwadi**
+- **Tarek Elgindy**
+- **Pedro Andres Sanchez Perez**

{grid_data_models-2.3.0 → grid_data_models-2.3.2}/README.md

@@ -1,6 +1,6 @@
 
 
-[![Upload to PyPi](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/publish_to_pypi.yml/badge.svg)](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/publish_to_pypi.yml) •  [![Pytest](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/pull_request_tests.yml/badge.svg)](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/pull_request_tests.yml) •  [![deploy-book](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/deploy.yml/badge.svg)](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/deploy.yml) • ![PyPI - Downloads](https://img.shields.io/pypi/dm/grid-data-models) •  [![codecov](https://codecov.io/github/NLR-Distribution-Suite/grid-data-models/branch/main/graph/badge.svg?token=K0X11EXOX8)](https://codecov.io/github/NLR-Distribution-Suite/grid-data-models) •  [![CodeFactor](https://www.codefactor.io/repository/github/nlr-distribution-suite/grid-data-models/badge)](https://www.codefactor.io/repository/github/nlr-distribution-suite/grid-data-models) • ![MCP Server](https://img.shields.io/badge/MCP_Server-enabled-brightgreen) • ![MCP Tools](https://img.shields.io/badge/MCP_Tools-20-blue)
+[![Upload to PyPi](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/publish_to_pypi.yml/badge.svg)](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/publish_to_pypi.yml) •  [![Pytest](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/pull_request_tests.yml/badge.svg)](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/pull_request_tests.yml) •  [![deploy-book](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/deploy.yml/badge.svg)](https://github.com/NLR-Distribution-Suite/grid-data-models/actions/workflows/deploy.yml) • ![PyPI - Downloads](https://img.shields.io/pypi/dm/grid-data-models) •  [![codecov](https://codecov.io/github/NLR-Distribution-Suite/grid-data-models/branch/main/graph/badge.svg?token=K0X11EXOX8)](https://codecov.io/github/NLR-Distribution-Suite/grid-data-models) •  [![CodeFactor](https://www.codefactor.io/repository/github/nlr-distribution-suite/grid-data-models/badge)](https://www.codefactor.io/repository/github/nlr-distribution-suite/grid-data-models) • ![MCP Server](https://img.shields.io/badge/MCP_Server-enabled-brightgreen) • ![MCP Tools](https://img.shields.io/badge/MCP_Tools-20-blue) • [![GitHub issues](https://img.shields.io/github/issues/NLR-Distribution-Suite/grid-data-models)](https://github.com/NLR-Distribution-Suite/grid-data-models/issues) • [![License](https://img.shields.io/github/license/NLR-Distribution-Suite/grid-data-models)](https://github.com/NLR-Distribution-Suite/grid-data-models/blob/main/LICENSE.txt)
 
 # Grid Data Models (GDM)
 
@@ -21,7 +21,7 @@ In an effort to reduce code duplication and provide client packages a standard i
 - **Built-in validation layer:** Use of [pydantic](https://docs.pydantic.dev/latest/) allows us to validate model fields.
 - **Time series data management:** GDM uses [infrasys](https://github.nrel.gov/CADET/infrastructure_systems) package which enables [efficient time series data management](https://nrel.github.io/infrasys/explanation/time_series.html) by sharing arrays across components and offloading system memory. For example, we can attach time series power consumption data to a load profile.
 - **Built-in unit conversion:** GDM leverages [pint](https://pint.readthedocs.io/en/stable/) for unit conversion for power system quantities. For example, power, voltage, time, etc.
-- **JSON serialization/deserialization:** GDM uses [infrasys](https://github.com/NREL/infrasys) to serialize and deserialize distribution system components to/from JSON.
+- **JSON serialization/deserialization:** GDM uses [infrasys](https://github.com/NatLabRockies/infrasys) to serialize and deserialize distribution system components to/from JSON.
 - **Track System Changes:** Supports tracking changes within a distribution model (both temporal and scenario-based static updates), enabling powerful scenario management capabilities.
 - **Graph-Based Analysis:** Exposes a connectivity graph using NetworkX, allowing advanced graph-based algorithms and visualizations.
 - **Interoperability:** Easily integrates with existing tools.
@@ -57,9 +57,9 @@ For more details, see the [MCP documentation](docs/mcp/).
 
 ## Contributors
 
-- **Kapil Duwadi**
 - **Aadil Latif**
-- **Tarek Elgindy**
-- **Pedro Andres Sanchez Perez**
 - **Daniel Thom**
 - **Jeremy Keen**
+- **Kapil Duwadi**
+- **Tarek Elgindy**
+- **Pedro Andres Sanchez Perez**

{grid_data_models-2.3.0 → grid_data_models-2.3.2}/pyproject.toml

@@ -26,7 +26,7 @@ dependencies = [
   "pydantic",
   "infrasys~=1.0", 
   "importlib_metadata",
-  "click~=8.1.7",
+  "typer",
   "pandas~=2.2.3",
   "geopandas",
   "plotly",
@@ -36,6 +36,7 @@ dependencies = [
 mcp = ["mcp>=1.0.0"]
 dev = ["pre-commit", "pytest", "pytest-cov", "pytest-doctestplus", "pytest-asyncio", "ruff", "docutils"]
 doc = [
+  "jupyter-book>=2,<3",
   "sphinx",
   "pydata-sphinx-theme",
   "myst-parser",
@@ -44,7 +45,7 @@ doc = [
 ]
 
 [project.scripts]
-gdm = "gdm.cli.cli:cli"
+gdm = "gdm.cli.cli:app"
 gdm-mcp-server = "gdm.mcp.server:main"
 
 [project.urls]

grid_data_models-2.3.2/src/gdm/cli/cli.py

@@ -0,0 +1,5 @@
+import typer
+from gdm.cli.reducer import reduce
+
+app = typer.Typer()
+app.command()(reduce)

grid_data_models-2.3.2/src/gdm/cli/reducer.py

@@ -0,0 +1,53 @@
+from enum import Enum
+from pathlib import Path
+import shutil
+from typing import Annotated
+
+import typer
+
+from gdm.distribution.model_reduction.reducer import reduce_to_three_phase_system
+from gdm.distribution.distribution_system import DistributionSystem
+from gdm.exceptions import FolderAlreadyExistsError
+
+
+class ReducerType(str, Enum):
+    three_phase = "three_phase"
+
+
+def reduce(
+    gdm_file: Annotated[str, typer.Option("-g", "--gdm-file", help="GDM system JSON file path.")],
+    target_file: Annotated[
+        str, typer.Option("-t", "--target-file", help="Target GDM system JSON file path.")
+    ],
+    force: Annotated[
+        bool,
+        typer.Option(
+            "-f", "--force", help="Force delete the target GDM system file if already exists."
+        ),
+    ] = False,
+    reducer: Annotated[
+        ReducerType, typer.Option("-r", "--reducer", help="Reducer type to apply.")
+    ] = ReducerType.three_phase,
+    time_series: Annotated[
+        bool,
+        typer.Option(
+            "-ts", "--time-series", help="Include time series data in the reduced system."
+        ),
+    ] = False,
+):
+    """Reduce a GDM distribution system."""
+    target_path = Path(target_file)
+    if force and target_path.exists():
+        shutil.rmtree(target_path.parent / f"{target_path.stem}_time_series")
+        target_path.unlink()
+
+    if not force and target_path.exists():
+        raise FolderAlreadyExistsError(
+            f"{target_path} already exists. Consider deleting it first."
+        )
+    sys = DistributionSystem.from_json(gdm_file)
+    reducer_func = {"three_phase": reduce_to_three_phase_system}
+    new_sys_name = sys.name + "_reduced" if sys.name else None
+    new_sys = reducer_func[reducer.value](sys, new_sys_name, time_series)
+    new_sys.to_json(target_path)
+    typer.echo(str(target_path))

{grid_data_models-2.3.0 → grid_data_models-2.3.2}/src/gdm/distribution/components/matrix_impedance_branch.py

@@ -41,7 +41,7 @@ class MatrixImpedanceBranch(DistributionBranchBase):
         """Kron reduce the branch to remove neutral."""
 
         self.equipment.kron_reduce(self.phases)
-        self.phases = [p for p in self.phases if p != Phase.N]
+        object.__setattr__(self, "phases", [p for p in self.phases if p != Phase.N])
 
     @classmethod
     def example(cls) -> "MatrixImpedanceBranch":

{grid_data_models-2.3.0 → grid_data_models-2.3.2}/src/gdm/distribution/distribution_system.py

@@ -220,8 +220,41 @@ class DistributionSystem(System):
                 edge.buses[1].name,
                 **data,
             )
+
+        # Validate that every phase on each bus is served by at least one connected component.
+        self._warn_uncovered_bus_phases(edges)
+
         return graph
 
+    def _warn_uncovered_bus_phases(
+        self,
+        edges: list,
+    ) -> None:
+        """Log a warning if any bus has phases not connected to any component."""
+        bus_covered_phases: dict[str, set] = {
+            node.name: set() for node in self.get_components(DistributionBus)
+        }
+        for edge in edges:
+            if isinstance(edge, DistributionBranchBase):
+                edge_phase_set = set(edge.phases)
+                for bus in edge.buses:
+                    bus_covered_phases[bus.name] |= edge_phase_set
+            elif isinstance(edge, DistributionTransformerBase):
+                for bus, winding_phases in zip(edge.buses, edge.winding_phases):
+                    bus_covered_phases[bus.name] |= set(winding_phases)
+
+        uncovered: dict[str, list] = {}
+        for bus in self.get_components(DistributionBus):
+            missing = set(bus.phases) - bus_covered_phases[bus.name]
+            if missing:
+                uncovered[bus.name] = sorted(p.value for p in missing)
+
+        if uncovered:
+            details = "; ".join(f"{name}: {phases}" for name, phases in uncovered.items())
+            logger.warning(
+                f"The following buses have phases not connected to any component: {details}"
+            )
+
     def _add_to_subsystem(
         self,
         subtree_system: "DistributionSystem",
@@ -243,8 +276,10 @@ class DistributionSystem(System):
         self,
         bus_names: list[str],
         name: str,
-        keep_timeseries: bool = False,
+        keep_time_series: bool = False,
+        keep_timeseries: bool | None = None,
         time_series_type: Type[TimeSeriesData] = SingleTimeSeries,
+        directed_graph: nx.DiGraph | None = None,
     ) -> "DistributionSystem":
         """Method to get subsystem from list of buses.
 
@@ -254,15 +289,23 @@ class DistributionSystem(System):
             List of bus names
         name: str
             Name of the subsystem.
-        keep_timeseries: bool
-            Set this flag to retain timeseries data associated with the component.
+        keep_time_series: bool
+            Set this flag to retain time series data associated with the component.
+        keep_timeseries: bool | None
+            Deprecated alias for keep_time_series.
         time_series_type: Type[TimeSeriesData]
             Type of time series data. Defaults to: SingleTimeSeries
+        directed_graph: nx.DiGraph | None
+            Optional precomputed directed graph for this system. When provided,
+            it is reused instead of rebuilding the directed graph.
         Returns
         -------
         DistributionSystem
         """
-        tree = self.get_directed_graph()
+        if keep_timeseries is not None:
+            keep_time_series = keep_timeseries
+
+        tree = directed_graph if directed_graph is not None else self.get_directed_graph()
         subtree = tree.subgraph(bus_names)
         subtree_system = DistributionSystem(auto_add_composed_components=True, name=name)
         for u, v, _ in subtree.edges(data=True):
@@ -275,7 +318,7 @@ class DistributionSystem(System):
             parent_components = self.list_parent_components(self.get_component(DistributionBus, u))
             self._add_to_subsystem(subtree_system, parent_components, bus_names)
 
-        if keep_timeseries:
+        if keep_time_series:
             for comp in subtree_system.get_components(
                 Component,
                 filter_func=lambda x: self.has_time_series(x, time_series_type=time_series_type),
@@ -437,7 +480,6 @@ class DistributionSystem(System):
             bus_1 = cycle[i]
             bus_2 = cycle[(i + 1) % len(cycle)]
             edge_data = self.get_undirected_graph().get_edge_data(bus_1, bus_2)
-            print(bus_1, bus_2, edge_data)
             if edge_data:
                 for key, data in edge_data.items():
                     if issubclass(data.get("type"), MatrixImpedanceSwitch):
@@ -447,7 +489,10 @@ class DistributionSystem(System):
                         break
         return list(set(switch_buses))
 
-    def get_split_phase_mapping(self) -> dict[str, set[Phase]]:
+    def get_split_phase_mapping(
+        self,
+        directed_graph: nx.DiGraph | None = None,
+    ) -> dict[str, set[Phase]]:
         """Generates a mapping of components to their split-phase configurations.
 
         This method identifies distribution transformers with center-tapped windings and
@@ -461,6 +506,12 @@ class DistributionSystem(System):
             A dictionary where keys are component names and values are sets of phases
             associated with the high-voltage bus.
 
+        Parameters
+        ----------
+        directed_graph: nx.DiGraph | None
+            Optional precomputed directed graph for this system. When provided,
+            it is reused instead of rebuilding the directed graph.
+
         Notes
         -----
         - The method uses the directed graph representation of the distribution system to
@@ -472,7 +523,7 @@ class DistributionSystem(System):
         - Logs the process of identifying and mapping split-phase transformers.
         """
         split_phase_map = {}
-        original_tree = self.get_directed_graph()
+        original_tree = directed_graph if directed_graph is not None else self.get_directed_graph()
         split_phase_trs: list[DistributionTransformer] = list(
             self.get_components(
                 DistributionTransformer,
@@ -485,7 +536,9 @@ class DistributionSystem(System):
             }.pop()
             hv_bus = (set([bus.name for bus in tr.buses]) - set([lv_bus])).pop()
             lv_system = self.get_subsystem(
-                list(nx.descendants(original_tree, lv_bus)) + [lv_bus], name=""
+                list(nx.descendants(original_tree, lv_bus)) + [lv_bus],
+                name="",
+                directed_graph=original_tree,
             )
             bus_model_types = self.get_model_types_with_field_type(DistributionBus)
             for model_type in bus_model_types:

{grid_data_models-2.3.0 → grid_data_models-2.3.2}/src/gdm/distribution/enums.py

@@ -118,6 +118,21 @@ class TOUPeriodType(str, Enum):
     MID_PEAK = "mid_peak"
 
 
+class Month(str, Enum):
+    JANUARY = "january"
+    FEBRUARY = "february"
+    MARCH = "march"
+    APRIL = "april"
+    MAY = "may"
+    JUNE = "june"
+    JULY = "july"
+    AUGUST = "august"
+    SEPTEMBER = "september"
+    OCTOBER = "october"
+    NOVEMBER = "november"
+    DECEMBER = "december"
+
+
 class Season(str, Enum):
     SUMMER = "summer"
     WINTER = "winter"

{grid_data_models-2.3.0 → grid_data_models-2.3.2}/src/gdm/distribution/equipment/phase_capacitor_equipment.py

@@ -54,13 +54,22 @@ class PhaseCapacitorEquipment(Component):
     def aggregate(
         cls, instances: list["PhaseCapacitorEquipment"], name: str
     ) -> "PhaseCapacitorEquipment":
+        resistance_inverse_sum = sum(
+            1 / inst.resistance for inst in instances if inst.resistance.magnitude
+        )
+        reactance_inverse_sum = sum(
+            1 / inst.reactance for inst in instances if inst.reactance.magnitude
+        )
+
         return PhaseCapacitorEquipment(
             name=name,
             rated_reactive_power=sum(inst.rated_reactive_power for inst in instances),
-            resistance=1
-            / sum(1 / inst.resistance if inst.resistance.magnitude else 0 for inst in instances),
-            reactance=1
-            / sum(1 / inst.reactance if inst.reactance.magnitude else 0 for inst in instances),
+            resistance=(
+                1 / resistance_inverse_sum if resistance_inverse_sum else Resistance(0, "ohm")
+            ),
+            reactance=(
+                1 / reactance_inverse_sum if reactance_inverse_sum else Reactance(0, "ohm")
+            ),
             num_banks=sum(inst.num_banks for inst in instances),
             num_banks_on=sum(inst.num_banks_on for inst in instances),
         )

{grid_data_models-2.3.0 → grid_data_models-2.3.2}/src/gdm/distribution/market/tariff.py

@@ -4,7 +4,7 @@ from pydantic import Field, model_validator
 from typing import List, Optional
 from infrasys import Component
 
-from gdm.distribution.enums import BillingDemandBasis, CustomerClass, TOUPeriodType, Season
+from gdm.distribution.enums import BillingDemandBasis, CustomerClass, Month, TOUPeriodType
 
 
 class TOURatePeriod(Component):
@@ -50,13 +50,13 @@ class DemandCharge(Component):
 
 class SeasonalTOURates(Component):
     name: str = ""
-    season: Season = Field(..., description="Season for the TOU rates")
-    tou_periods: List[TOURatePeriod] = Field(..., description="List of TOU periods for the season")
+    season: Month = Field(..., description="Month for the TOU rates")
+    tou_periods: List[TOURatePeriod] = Field(..., description="List of TOU periods for the month")
 
     @classmethod
     def example(cls) -> "SeasonalTOURates":
         return SeasonalTOURates(
-            season=Season.SUMMER,
+            season=Month.JULY,
             tou_periods=[
                 TOURatePeriod.example(),
                 TOURatePeriod(
@@ -114,7 +114,7 @@ class DistributionTariff(Component):
             seasonal_tou=[
                 SeasonalTOURates.example(),
                 SeasonalTOURates(
-                    season=Season.WINTER,
+                    season=Month.JANUARY,
                     tou_periods=[
                         TOURatePeriod.example(),
                         TOURatePeriod(

{grid_data_models-2.3.0 → grid_data_models-2.3.2}/src/gdm/distribution/model_reduction/reducer.py

@@ -14,9 +14,9 @@ from gdm.distribution.distribution_system import (
 )
 from gdm.distribution.enums import Phase
 from gdm.distribution.sys_functools import (
-    get_aggregated_load_timeseries,
-    get_aggregated_solar_timeseries,
-    get_aggregated_battery_timeseries,
+    get_aggregated_load_time_series,
+    get_aggregated_solar_time_series,
+    get_aggregated_battery_time_series,
 )
 
 
@@ -74,23 +74,28 @@ def _reduce_system(
     dist_system: DistributionSystem,
     bus_subset: list[DistributionBus],
     name: str,
-    agg_timeseries: bool = False,
+    agg_time_series: bool = False,
+    agg_timeseries: bool | None = None,
     time_series_type: Type[TimeSeriesData] = SingleTimeSeries,
 ) -> DistributionSystem:
+    if agg_timeseries is not None:
+        agg_time_series = agg_timeseries
+
+    original_tree = dist_system.get_directed_graph()
     reduced_system = dist_system.get_subsystem(
         bus_subset,
         name,
-        keep_timeseries=agg_timeseries,
+        keep_time_series=agg_time_series,
         time_series_type=time_series_type,
+        directed_graph=original_tree,
     )
 
-    split_phase_mapping = dist_system.get_split_phase_mapping()
-    original_tree = dist_system.get_directed_graph()
+    split_phase_mapping = dist_system.get_split_phase_mapping(directed_graph=original_tree)
     reduced_network_tree = original_tree.subgraph(bus_subset)
     ts_agg_func_mapper: dict[Union[Type[DistributionLoad], Type[DistributionSolar]], Callable] = {
-        DistributionLoad: get_aggregated_load_timeseries,
-        DistributionSolar: get_aggregated_solar_timeseries,
-        DistributionBattery: get_aggregated_battery_timeseries,
+        DistributionLoad: get_aggregated_load_time_series,
+        DistributionSolar: get_aggregated_solar_time_series,
+        DistributionBattery: get_aggregated_battery_time_series,
     }
     for node in reduced_network_tree.nodes():
         if reduced_network_tree.out_degree(node) < original_tree.out_degree(node):
@@ -103,7 +108,11 @@ def _reduce_system(
                 for snode in nx.descendants(original_tree, successor)
             ] + list(sucessors_diff)
             subtree = original_tree.subgraph(successors_descendants)
-            subtree_system = dist_system.get_subsystem(subtree.nodes, "")
+            subtree_system = dist_system.get_subsystem(
+                list(subtree.nodes),
+                "",
+                directed_graph=original_tree,
+            )
             model_types = subtree_system.get_model_types_with_field_type(DistributionBus)
             for model_type in model_types:
                 agg_component = _get_aggregated_bus_component(
@@ -112,10 +121,9 @@ def _reduce_system(
                     model_type=model_type,
                     split_phase_mapping=split_phase_mapping,
                 )
-                # print(model_type.__name__, agg_component)
                 reduced_system.add_component(agg_component)
                 agg_comp = reduced_system.get_component(model_type, agg_component.name)
-                if agg_timeseries:
+                if agg_time_series:
                     comps = list(subtree_system.get_components(model_type))
                     ts_metadata = dist_system.list_time_series_metadata(
                         comps[0], time_series_type=time_series_type
@@ -135,18 +143,34 @@ def _reduce_system(
 def reduce_to_three_phase_system(
     dist_system: DistributionSystem,
     name: str,
-    agg_timeseries: bool = False,
+    agg_time_series: bool = False,
+    agg_timeseries: bool | None = None,
     time_series_type: Type[TimeSeriesData] = SingleTimeSeries,
 ) -> DistributionSystem:
     three_phase_buses = _get_three_phase_buses(dist_system)
-    return _reduce_system(dist_system, three_phase_buses, name, agg_timeseries, time_series_type)
+    return _reduce_system(
+        dist_system,
+        three_phase_buses,
+        name,
+        agg_time_series,
+        agg_timeseries,
+        time_series_type,
+    )
 
 
 def reduce_to_primary_system(
     dist_system: DistributionSystem,
     name: str,
-    agg_timeseries: bool = False,
+    agg_time_series: bool = False,
+    agg_timeseries: bool | None = None,
     time_series_type: Type[TimeSeriesData] = SingleTimeSeries,
 ) -> DistributionSystem:
     primary_buses = _get_primary_buses(dist_system)
-    return _reduce_system(dist_system, primary_buses, name, agg_timeseries, time_series_type)
+    return _reduce_system(
+        dist_system,
+        primary_buses,
+        name,
+        agg_time_series,
+        agg_timeseries,
+        time_series_type,
+    )