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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: grid-data-models
-Version: 2.3.2
+Version: 2.3.3
 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
@@ -13,9 +13,9 @@ Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.11
 Requires-Dist: geopandas
 Requires-Dist: importlib-metadata
-Requires-Dist: infrasys~=1.0
+Requires-Dist: infrasys~=1.1
 Requires-Dist: networkx
-Requires-Dist: pandas~=2.2.3
+Requires-Dist: pandas~=3.0.2
 Requires-Dist: plotly
 Requires-Dist: pydantic
 Requires-Dist: semver
@@ -30,13 +30,13 @@ 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: jupyter-book<3,>=2.1.4; extra == 'doc'
 Requires-Dist: myst-parser; extra == 'doc'
 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.0.0; extra == 'mcp'
+Requires-Dist: mcp>=1.27.0; extra == 'mcp'
 Description-Content-Type: text/markdown
 
 

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

@@ -24,19 +24,19 @@ dependencies = [
   "semver",
   "networkx", 
   "pydantic",
-  "infrasys~=1.0", 
+  "infrasys~=1.1", 
   "importlib_metadata",
   "typer",
-  "pandas~=2.2.3",
+  "pandas~=3.0.2",
   "geopandas",
   "plotly",
 ]
 
 [project.optional-dependencies]
-mcp = ["mcp>=1.0.0"]
+mcp = ["mcp>=1.27.0"]
 dev = ["pre-commit", "pytest", "pytest-cov", "pytest-doctestplus", "pytest-asyncio", "ruff", "docutils"]
 doc = [
-  "jupyter-book>=2,<3",
+  "jupyter-book>=2.1.4,<3",
   "sphinx",
   "pydata-sphinx-theme",
   "myst-parser",

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

@@ -143,6 +143,7 @@ class CustomerClass(str, Enum):
     RESIDENTIAL = "residential"
     COMMERCIAL = "commercial"
     INDUSTRIAL = "industrial"
+    UTILITY = "utility"
 
 
 class BillingDemandBasis(str, Enum):

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

@@ -31,6 +31,9 @@ class TOURatePeriod(Component):
 
 class DemandCharge(Component):
     name: str = ""
+    months: List[Month] = Field(
+        ..., min_length=1, description="Months for which this demand charge applies"
+    )
     rate: float = Field(..., gt=0, description="Rate for demand charge in $/kW")
     billing_demand_basis: BillingDemandBasis = Field(
         ..., description="Basis for billing demand calculation"
@@ -39,9 +42,16 @@ class DemandCharge(Component):
         ..., description="Time periods when the demand charge applies"
     )
 
+    @model_validator(mode="after")
+    def check_no_duplicate_months(self) -> "DemandCharge":
+        if len(self.months) != len(set(self.months)):
+            raise ValueError("Duplicate months are not allowed within a single DemandCharge")
+        return self
+
     @classmethod
     def example(cls) -> "DemandCharge":
         return DemandCharge(
+            months=[Month.JUNE, Month.JULY, Month.AUGUST],
             rate=12.50,
             billing_demand_basis=BillingDemandBasis.PEAK_15MIN,
             time_applicability=[TOURatePeriod.example()],
@@ -50,13 +60,23 @@ class DemandCharge(Component):
 
 class SeasonalTOURates(Component):
     name: str = ""
-    season: Month = Field(..., description="Month for the TOU rates")
-    tou_periods: List[TOURatePeriod] = Field(..., description="List of TOU periods for the month")
+    months: List[Month] = Field(
+        ..., min_length=1, description="Months for which these TOU rates apply"
+    )
+    tou_periods: List[TOURatePeriod] = Field(
+        ..., description="List of TOU periods for the specified months"
+    )
+
+    @model_validator(mode="after")
+    def check_no_duplicate_months(self) -> "SeasonalTOURates":
+        if len(self.months) != len(set(self.months)):
+            raise ValueError("Duplicate months are not allowed within a single SeasonalTOURates")
+        return self
 
     @classmethod
     def example(cls) -> "SeasonalTOURates":
         return SeasonalTOURates(
-            season=Month.JULY,
+            months=[Month.JUNE, Month.JULY, Month.AUGUST],
             tou_periods=[
                 TOURatePeriod.example(),
                 TOURatePeriod(
@@ -81,7 +101,7 @@ class TieredRate(Component):
 
 class FixedCharge(Component):
     name: str = ""
-    amount: float = Field(..., gt=0, description="Amount of the fixed charge in $/month")
+    amount: float = Field(..., ge=0, description="Amount of the fixed charge in $/month")
     description: Optional[str] = Field(None, description="Description of the fixed charge")
 
     @classmethod
@@ -93,7 +113,7 @@ class DistributionTariff(Component):
     name: str = Field(..., description="Name of the tariff")
     utility: str = Field(..., description="Name of the utility company")
     customer_class: CustomerClass = Field(..., description="Customer class for the tariff")
-    fixed_charge: FixedCharge = Field(..., description="Fixed charge for the tariff")
+    fixed_charge: Optional[FixedCharge] = Field(None, description="Fixed charge for the tariff")
     seasonal_tou: List[SeasonalTOURates] = Field(
         ..., description="Seasonal TOU rates for the tariff"
     )
@@ -104,6 +124,13 @@ class DistributionTariff(Component):
         None, description="List of tiered energy charges for the tariff"
     )
 
+    @model_validator(mode="after")
+    def check_no_overlapping_months(self) -> "DistributionTariff":
+        all_months = [m for entry in self.seasonal_tou for m in entry.months]
+        if len(all_months) != len(set(all_months)):
+            raise ValueError("A month must not appear in more than one SeasonalTOURates entry")
+        return self
+
     @classmethod
     def example(cls) -> "DistributionTariff":
         return DistributionTariff(
@@ -114,7 +141,7 @@ class DistributionTariff(Component):
             seasonal_tou=[
                 SeasonalTOURates.example(),
                 SeasonalTOURates(
-                    season=Month.JANUARY,
+                    months=[Month.DECEMBER, Month.JANUARY, Month.FEBRUARY],
                     tou_periods=[
                         TOURatePeriod.example(),
                         TOURatePeriod(

grid_data_models-2.3.3/src/gdm/distribution/upgrade_handler/from__2_3_2__to__2_3_3.py

@@ -0,0 +1,77 @@
+from loguru import logger
+from infrasys.migrations.metadata_migration import migrate_component_metadata
+
+
+SEASON_TO_MONTHS = {
+    "summer": ["june", "july", "august"],
+    "winter": ["december", "january", "february"],
+    "shoulder": ["march", "april", "may", "september", "october", "november"],
+}
+
+
+def _get_component_type(component: dict) -> str | None:
+    return component.get("__metadata__", {}).get("fields", {}).get("type")
+
+
+def _migrate_seasonal_tou_rates(component: dict) -> None:
+    """Migrate SeasonalTOURates: rename 'season' -> 'months' (Season -> List[Month])."""
+    if "season" in component:
+        season_value = component.pop("season")
+        component["months"] = SEASON_TO_MONTHS.get(season_value, [season_value])
+        logger.debug(
+            f"Migrated SeasonalTOURates season={season_value} -> months={component['months']}"
+        )
+
+
+def _migrate_demand_charge(component: dict) -> None:
+    """Migrate DemandCharge: add 'months' field if missing (default to all 12 months)."""
+    if "months" not in component:
+        component["months"] = [
+            "january",
+            "february",
+            "march",
+            "april",
+            "may",
+            "june",
+            "july",
+            "august",
+            "september",
+            "october",
+            "november",
+            "december",
+        ]
+        logger.debug("Migrated DemandCharge: added default months (all 12 months)")
+
+
+def _migrate_tariff_components(obj: dict) -> None:
+    """Recursively walk the component dict and apply tariff migrations."""
+    component_type = _get_component_type(obj)
+    if component_type == "SeasonalTOURates":
+        _migrate_seasonal_tou_rates(obj)
+    elif component_type == "DemandCharge":
+        _migrate_demand_charge(obj)
+
+    for value in obj.values():
+        if isinstance(value, dict):
+            _migrate_tariff_components(value)
+        elif isinstance(value, list):
+            for item in value:
+                if isinstance(item, dict):
+                    _migrate_tariff_components(item)
+
+
+def from__2_3_2__to__2_3_3(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"])
+
+    for component in data["components"]:
+        _migrate_tariff_components(component)
+
+    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.2 → grid_data_models-2.3.3}/src/gdm/distribution/upgrade_handler/upgrade_handler.py

@@ -20,6 +20,7 @@ from gdm.distribution.upgrade_handler.from__2_2_0__to__2_2_1 import from__2_2_0_
 from gdm.distribution.upgrade_handler.from__2_2_1__to__2_3_0 import from__2_2_1__to__2_3_0
 from gdm.distribution.upgrade_handler.from__2_3_0__to__2_3_1 import from__2_3_0__to__2_3_1
 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
 
 
 def fix_version(version):
@@ -112,6 +113,11 @@ class UpgradeHandler(BaseModel):
             from_version="2.3.1",
             to_version="2.3.2",
         ),
+        UpgradeSchema(
+            method=from__2_3_2__to__2_3_3,
+            from_version="2.3.2",
+            to_version="2.3.3",
+        ),
     ]
 
     @model_validator(mode="after")

{grid_data_models-2.3.2 → grid_data_models-2.3.3}/src/gdm/version.py

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