grid-data-models 2.3.4__tar.gz → 2.3.5__tar.gz

{grid_data_models-2.3.4 → grid_data_models-2.3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: grid-data-models
-Version: 2.3.4
+Version: 2.3.5
 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
@@ -36,7 +36,7 @@ Requires-Dist: pydata-sphinx-theme; extra == 'doc'
 Requires-Dist: sphinx; extra == 'doc'
 Requires-Dist: sphinxcontrib-mermaid; extra == 'doc'
 Provides-Extra: mcp
-Requires-Dist: mcp>=1.27.2; extra == 'mcp'
+Requires-Dist: mcp>=1.28.0; extra == 'mcp'
 Description-Content-Type: text/markdown
 
 

{grid_data_models-2.3.4 → grid_data_models-2.3.5}/pyproject.toml

@@ -33,7 +33,7 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-mcp = ["mcp>=1.27.2"]
+mcp = ["mcp>=1.28.0"]
 dev = ["pre-commit", "pytest", "pytest-cov", "pytest-doctestplus", "pytest-asyncio", "ruff", "docutils"]
 doc = [
   "jupyter-book>=2.1.5,<3",

{grid_data_models-2.3.4 → grid_data_models-2.3.5}/src/gdm/distribution/components/__init__.py

@@ -7,6 +7,7 @@ from gdm.distribution.components.distribution_solar import DistributionSolar
 from gdm.distribution.components.distribution_transformer import DistributionTransformer
 from gdm.distribution.components.distribution_vsource import DistributionVoltageSource
 from gdm.distribution.components.geometry_branch import GeometryBranch
+from gdm.distribution.components.geometry_switch import GeometrySwitch
 from gdm.distribution.components.matrix_impedance_branch import MatrixImpedanceBranch
 from gdm.distribution.components.matrix_impedance_fuse import MatrixImpedanceFuse
 from gdm.distribution.components.matrix_impedance_recloser import MatrixImpedanceRecloser

grid_data_models-2.3.5/src/gdm/distribution/components/geometry_switch.py

@@ -0,0 +1,122 @@
+"""This module contains geometry branch."""
+
+from typing import Annotated
+
+from pydantic import Field
+
+from gdm.distribution.components.base.distribution_switch_base import (
+    DistributionSwitchBase,
+)
+from gdm.distribution.equipment.geometry_branch_equipment import (
+    GeometryBranchEquipment,
+)
+from gdm.distribution.components.distribution_feeder import DistributionFeeder
+from gdm.distribution.components.distribution_substation import (
+    DistributionSubstation,
+)
+from gdm.distribution.components.distribution_bus import DistributionBus
+from gdm.distribution.enums import Phase
+from gdm.quantities import Voltage, Distance
+
+from gdm.distribution.components.matrix_impedance_switch import MatrixImpedanceSwitch
+from gdm.distribution.equipment import (
+    ConcentricCableEquipment,
+)
+from gdm.distribution.equipment.matrix_impedance_switch_equipment import (
+    MatrixImpedanceSwitchEquipment,
+)
+
+
+class GeometrySwitch(DistributionSwitchBase):
+    """Data model for distribution branches based on line geometry."""
+
+    equipment: Annotated[
+        GeometryBranchEquipment,
+        Field(..., description="Geometry branch equipment."),
+    ]
+
+    def validate_fields(self) -> "GeometrySwitch":
+        """Custom validator for geometry branch fields."""
+        if len(self.phases) != len(self.equipment.conductors):
+            msg = "Number of phases is not equal to number of wires."
+            raise ValueError(msg)
+        return self
+
+    def to_matrix_representation(
+        self, frequency_hz: float = 60, soil_resistivity_ohm_m: float = 100
+    ) -> MatrixImpedanceSwitch:
+        """
+        Converts the geometry-based branch model to a matrix impedance representation.
+
+        This method transforms the current `GeometryBranch` instance into a `MatrixImpedanceBranch`
+        by calculating the impedance matrix based on the specified frequency and soil resistivity.
+        The conversion process involves using the equipment's matrix representation method to obtain
+        the necessary impedance data.
+
+        Parameters
+        ----------
+        frequency_hz : float, optional
+            The frequency in hertz used for impedance calculations. Defaults to 60 Hz.
+        soil_resistivity_ohm_m : float, optional
+            The soil resistivity in ohm-meters used for impedance calculations. Defaults to 100 ohm-m.
+
+        Returns
+        -------
+        MatrixImpedanceBranch
+            A new instance of `MatrixImpedanceBranch` representing the converted geometry branch.
+
+        Notes
+        -----
+        - The method uses the number of neutral phases to assist in the impedance calculation.
+        - This conversion is essential for systems that require matrix impedance representations
+            for detailed electrical analysis.
+
+        """
+        equipment = self.equipment.to_matrix_representation(
+            frequency_hz,
+            soil_resistivity_ohm_m,
+            n_neutrals=len([phs for phs in self.phases if phs == Phase.N]),
+        )
+        if isinstance(self.equipment.conductors[0], ConcentricCableEquipment):
+            phases = self.phases + [Phase.N for _ in self.phases]
+            equipment.kron_reduce(phases)
+
+        switch_equipment = MatrixImpedanceSwitchEquipment(
+            **equipment.model_dump(exclude_none=True)
+        )
+
+        return MatrixImpedanceSwitch(
+            buses=self.buses,
+            length=self.length,
+            phases=self.phases,
+            substation=self.substation,
+            feeder=self.feeder,
+            name=self.name,
+            equipment=switch_equipment,
+            is_closed=self.is_closed,
+        )
+
+    @classmethod
+    def example(cls) -> "GeometrySwitch":
+        """Example for geometry branch."""
+        buses = [
+            DistributionBus(
+                voltage_type="line-to-ground",
+                phases=[Phase.A, Phase.B, Phase.C],
+                rated_voltage=Voltage(400, "volt"),
+                substation=DistributionSubstation.example(),
+                feeder=DistributionFeeder.example(),
+                name=bus_name,
+            )
+            for bus_name in ["Branch-DistBus1", "Branch-DistBus2"]
+        ]
+        return GeometrySwitch(
+            buses=buses,
+            length=Distance(130.2, "meter"),
+            phases=[Phase.A, Phase.B, Phase.C],
+            substation=DistributionSubstation.example(),
+            feeder=DistributionFeeder.example(),
+            name="DistBranch1",
+            is_closed=[True, True, True],
+            equipment=GeometryBranchEquipment.example(),
+        )

grid_data_models-2.3.5/src/gdm/distribution/upgrade_handler/from__2_3_4__to__2_3_5.py

@@ -0,0 +1,15 @@
+from loguru import logger
+from infrasys.migrations.metadata_migration import migrate_component_metadata
+
+
+def from__2_3_4__to__2_3_5(data: dict, from_version: str, to_version: str) -> dict:
+    logger.info(f"Upgrading DistributionSystem from verion {from_version} to {to_version}")
+    data["data_format_version"] = str(to_version)
+    number_of_components_before = len(data["components"])
+    data["components"] = migrate_component_metadata(data["components"])
+    number_of_components_after = len(data["components"])
+    assert (
+        number_of_components_before == number_of_components_after
+    ), "Number of components should be the same before and after model upgrade"
+
+    return data

{grid_data_models-2.3.4 → grid_data_models-2.3.5}/src/gdm/distribution/upgrade_handler/upgrade_handler.py

@@ -22,6 +22,7 @@ from gdm.distribution.upgrade_handler.from__2_3_0__to__2_3_1 import from__2_3_0_
 from gdm.distribution.upgrade_handler.from__2_3_1__to__2_3_2 import from__2_3_1__to__2_3_2
 from gdm.distribution.upgrade_handler.from__2_3_2__to__2_3_3 import from__2_3_2__to__2_3_3
 from gdm.distribution.upgrade_handler.from__2_3_3__to__2_3_4 import from__2_3_3__to__2_3_4
+from gdm.distribution.upgrade_handler.from__2_3_4__to__2_3_5 import from__2_3_4__to__2_3_5
 
 
 def fix_version(version):
@@ -124,6 +125,11 @@ class UpgradeHandler(BaseModel):
             from_version="2.3.3",
             to_version="2.3.4",
         ),
+        UpgradeSchema(
+            method=from__2_3_4__to__2_3_5,
+            from_version="2.3.4",
+            to_version="2.3.5",
+        ),
     ]
 
     @model_validator(mode="after")

{grid_data_models-2.3.4 → grid_data_models-2.3.5}/src/gdm/version.py

@@ -3,7 +3,7 @@ import subprocess
 import platform
 import sys
 
-VERSION = "2.3.4"
+VERSION = "2.3.5"
 SUPPORTED_VERSIONS = [VERSION]