epinterface 1.0.2__tar.gz → 1.0.4__tar.gz

{epinterface-1.0.2 → epinterface-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: epinterface
-Version: 1.0.2
+Version: 1.0.4
 Summary: This is a repository for dynamically generating energy models within Python, relying on Archetypal and Eppy for most of its functionality.
 Project-URL: Homepage, https://github.com/szvsw/epinterface
 Project-URL: Documentation, https://szvsw.github.io/epinterface
@@ -13,6 +13,7 @@ Requires-Dist: archetypal
 Requires-Dist: click==8.1.7
 Requires-Dist: geopandas~=1.0.1
 Requires-Dist: httpx~=0.27.2
+Requires-Dist: ladybug-core>=0.44.30
 Requires-Dist: openpyxl~=3.1.5
 Requires-Dist: pandas<2.3,>=2.2
 Requires-Dist: prisma~=0.15.0

{epinterface-1.0.2 → epinterface-1.0.4}/epinterface/sbem/builder.py

@@ -2,6 +2,7 @@
 
 import asyncio
 import gc
+import logging
 import shutil
 import tempfile
 from collections.abc import Callable
@@ -14,6 +15,7 @@ import numpy as np
 import pandas as pd
 from archetypal.idfclass import IDF
 from archetypal.idfclass.sql import Sql
+from ladybug.epw import EPW
 from pydantic import BaseModel, Field, field_validator, model_validator
 
 from epinterface.constants import assumed_constants, physical_constants
@@ -37,6 +39,8 @@ from epinterface.sbem.components.zones import ZoneComponent
 from epinterface.sbem.exceptions import NotImplementedParameter
 from epinterface.weather import BaseWeather
 
+logger = logging.getLogger(__name__)
+
 DESIRED_METERS = (
     "InteriorEquipment:Electricity",
     "InteriorLights:Electricity",
@@ -803,7 +807,7 @@ class Model(BaseWeather, validate_assignment=True):
 
         return idf
 
-    def build(
+    def build(  # noqa: C901
         self,
         config: SimulationPathConfig,
         post_geometry_callback: Callable[[IDF], IDF] | None = None,
@@ -870,10 +874,6 @@ class Model(BaseWeather, validate_assignment=True):
         idf = add_default_sim_controls(idf)
         idf, _scheds = add_default_schedules(idf)
 
-        idf = SiteGroundTemperature.FromValues(
-            assumed_constants.SiteGroundTemperature_degC
-        ).add(idf)
-
         idf = self.geometry.add(idf)
         if post_geometry_callback is not None:
             idf = post_geometry_callback(idf)
@@ -885,6 +885,44 @@ class Model(BaseWeather, validate_assignment=True):
         for zone in added_zone_lists.main_zone_list.Names:
             self.Zone.add_to_idf_zone(idf, zone)
 
+        # Handle setting ground temperature
+        subtractor = (
+            4 if (self.geometry.basement and not self.Basement.Conditioned) else 2
+        )
+        has_heating = self.Zone.Operations.HVAC.ConditioningSystems.Heating is not None
+        has_cooling = self.Zone.Operations.HVAC.ConditioningSystems.Cooling is not None
+        hsp = self.Zone.Operations.SpaceUse.Thermostat.HeatingSchedule
+        csp = self.Zone.Operations.SpaceUse.Thermostat.CoolingSchedule
+        epw = EPW(epw_path.as_posix())
+        epw_ground_vals_all = epw.monthly_ground_temperature
+        if self.geometry.basement:
+            # if there is a basement, we use the 2m depth to account for the basement depth.
+            epw_ground_vals = epw_ground_vals_all[4].values
+        else:
+            # if there is no basement, we use the 0.5m depth to account for the ground temperature.
+            epw_ground_vals = epw_ground_vals_all[0.5].values
+        low_ground_val = min(epw_ground_vals)
+        high_ground_val = max(epw_ground_vals)
+        phase = (np.array(epw_ground_vals) - low_ground_val) / (
+            high_ground_val - low_ground_val
+        )
+        if has_heating and has_cooling:
+            winter_line = np.array(hsp.MonthlyAverageValues) - subtractor
+            summer_line = np.array(csp.MonthlyAverageValues) - subtractor
+        elif has_heating:
+            winter_line = np.array(hsp.MonthlyAverageValues) - subtractor
+            summer_line = np.array(hsp.MonthlyAverageValues)
+        elif has_cooling:
+            winter_line = np.array(csp.MonthlyAverageValues) - subtractor
+            summer_line = np.array(csp.MonthlyAverageValues) - subtractor
+        else:
+            # No heating or cooling, so we use the default ground temperature, should not matter much.
+            winter_line = np.array(assumed_constants.SiteGroundTemperature_degC)
+            summer_line = np.array(assumed_constants.SiteGroundTemperature_degC)
+        interp_temp = phase * np.abs(summer_line - winter_line) + winter_line
+        ground_vals = [max(epw_ground_vals[i], interp_temp[i]) for i in range(12)]
+        idf = SiteGroundTemperature.FromValues(ground_vals).add(idf)
+
         # handle basements
         if self.Basement.UseFraction or self.Basement.Conditioned:
             new_zone_def = self.Zone.model_copy(deep=True)
@@ -1310,9 +1348,15 @@ if __name__ == "__main__":
     from epinterface.sbem.prisma.client import PrismaSettings
 
     with tempfile.TemporaryDirectory() as temp_dir:
-        database_path = Path("/Users/daryaguettler/globi/data/Brazil/components-lib.db")
+        # database_path = Path("/Users/daryaguettler/globi/data/Brazil/components-lib.db")
+        # component_map_path = Path(
+        #     "/Users/daryaguettler/globi/data/Brazil/component-map.yaml"
+        # )
+        database_path = Path(
+            "/Users/daryaguettler/globi/data/Portugal/components-lib.db"
+        )
         component_map_path = Path(
-            "/Users/daryaguettler/globi/data/Brazil/component-map.yaml"
+            "/Users/daryaguettler/globi/data/Portugal/component-map.yaml"
         )
         settings = PrismaSettings(
             database_path=database_path,
@@ -1329,18 +1373,26 @@ if __name__ == "__main__":
             component_map_yaml = yaml.safe_load(f)
         selector = SelectorModel.model_validate(component_map_yaml)
         db = settings.db
+        # context = {
+        #     "region": "SP",
+        #     "income": "Low",
+        #     "typology": "Residential",
+        #     "scenario": "withAC",
+        # }
         context = {
-            "region": "SP",
-            "income": "Low",
-            "typology": "Residential",
-            "scenario": "withAC",
+            "Region": "I1_V2",
+            "City": "LS",
+            "Typology": "Single_Family_Residential",
+            "Age_buckets": "1971_1980",
+            "scenario": "Baseline",
         }
         with settings.db:
             zone = cast(ZoneComponent, selector.get_component(context=context, db=db))
 
         model = Model(
             Weather=(
-                "https://climate.onebuilding.org/WMO_Region_3_South_America/BRA_Brazil/SP_Sao_Paulo/BRA_SP_Guaratingueta.AP.837080_TMYx.2009-2023.zip"
+                # "https://climate.onebuilding.org/WMO_Region_3_South_America/BRA_Brazil/SP_Sao_Paulo/BRA_SP_Guaratingueta.AP.837080_TMYx.2009-2023.zip"
+                "https://climate.onebuilding.org/WMO_Region_6_Europe/PRT_Portugal/LB_Lisboa/PRT_LB_Lisboa.Portela.AP.085360_TMYx.2009-2023.zip"
             ),  # pyright: ignore [reportArgumentType]
             Zone=zone,
             Attic=AtticAssumptions(
@@ -1358,7 +1410,7 @@ if __name__ == "__main__":
                 d=20,
                 h=3,
                 wwr=0.3,
-                num_stories=3,
+                num_stories=1,
                 basement=False,
                 zoning="by_storey",
                 roof_height=None,

{epinterface-1.0.2 → epinterface-1.0.4}/epinterface/sbem/components/schedules.py

@@ -70,6 +70,11 @@ class DayComponent(NamedObject, extra="forbid"):
     Hour_22: float
     Hour_23: float
 
+    @property
+    def AverageValue(self) -> float:
+        """Get the average value of the day."""
+        return sum(self.Values) / len(self.Values)
+
     @property
     def bounds(self) -> tuple[float, float]:
         """Get the bounds of the day."""
@@ -200,6 +205,11 @@ class WeekComponent(NamedObject, extra="forbid"):
         highs = [day.bounds[1] for day in self.Days]
         return min(lows), max(highs)
 
+    @property
+    def AverageValue(self) -> float:
+        """Get the average value of the week."""
+        return sum(day.AverageValue for day in self.Days) / len(self.Days)
+
     @property
     def Days(self) -> list[DayComponent]:
         """Get the days of the week as a list."""
@@ -338,6 +348,16 @@ class YearComponent(NamedObject, extra="forbid"):
     November: WeekComponent
     December: WeekComponent
 
+    @property
+    def AverageValue(self) -> float:
+        """Get the average value of the year."""
+        return sum(week.AverageValue for week in self.Weeks) / len(self.Weeks)
+
+    @property
+    def MonthlyAverageValues(self) -> list[float]:
+        """Get the average values of the year."""
+        return [week.AverageValue for week in self.Weeks]
+
     @property
     def bounds(self) -> tuple[float, float]:
         """Get the bounds of the year."""

{epinterface-1.0.2 → epinterface-1.0.4}/epinterface/sbem/fields/spec.py

@@ -51,6 +51,34 @@ class SemanticModelFields(BaseModel):
     GFA_col: str | None = Field(
         default=None, description="The gross floor area column name [m2]."
     )
+    Building_ID_col: str | None = Field(
+        default=None, description="The building ID column name."
+    )
+    Basement_col: str | None = Field(
+        default=None, description="The basement column name."
+    )
+    Attic_col: str | None = Field(default=None, description="The attic column name.")
+    Exposed_Basement_Frac_col: str | None = Field(
+        default=None, description="The exposed basement fraction column name."
+    )
+    Weather_File_col: str | None = Field(
+        default=None, description="The weather file column name."
+    )
+
+    @property
+    def semantic_field_names(self) -> list[str]:
+        """The names of the semantic fields."""
+        return [f.Name for f in self.Fields]
+
+    @property
+    def rich_field_names(self) -> list[str | None]:
+        """The names of the rich fields."""
+        return [v for k, v in self.model_dump().items() if k.endswith("_col")]
+
+    @property
+    def field_names(self) -> list[str | None]:
+        """The names of the fields."""
+        return [*self.semantic_field_names, *self.rich_field_names]
 
     @model_validator(mode="after")
     def check_at_least_one_height_or_num_floors(self):

{epinterface-1.0.2 → epinterface-1.0.4}/epinterface/sbem/utils.py

@@ -1,7 +1,7 @@
 """Utility functions for working with SBEMs."""
 
 from pathlib import Path
-from typing import cast
+from typing import Any, cast
 
 import yaml
 from tqdm.autonotebook import tqdm
@@ -15,11 +15,25 @@ from epinterface.sbem.fields.spec import SemanticModelFields
 from epinterface.sbem.prisma.client import PrismaSettings
 
 
+class ModelsNotConstructableError(Exception):
+    """An error raised when the models are not constructable."""
+
+    def __init__(self, failing_contexts: list[dict[str, Any]]):
+        """Initialize the error."""
+        self.failing_contexts = failing_contexts
+        printable_contexts = failing_contexts[: min(10, len(failing_contexts))]
+        msg = "The following contexts failed to resolve to a valid zone component:\n"
+        msg += "\n\n"
+        msg += yaml.dump(printable_contexts, indent=2, sort_keys=False)
+        super().__init__(msg)
+
+
 def check_model_existence(
     component_map_path: Path,
     semantic_fields_path: Path,
     db_path: Path,
     max_tests: int = 100,
+    raise_on_error: bool = False,
 ) -> None:
     """Check if all semantic field combinations resolve to a valid zone component (up to some sampling limit).
 
@@ -34,6 +48,7 @@ def check_model_existence(
         semantic_fields_path: Path to the semantic fields file.
         db_path: Path to the database file.
         max_tests: Maximum number of tests to run.
+        raise_on_error: Whether to raise an error if any tests fail.
     """
     with open(semantic_fields_path) as f:
         semantic_fields_yaml = yaml.safe_load(f)
@@ -61,8 +76,13 @@ def check_model_existence(
     grid = grid.sample(min(max_tests, len(grid)))
 
     # Checks that things that should be in the db are in the db
+    failing_contexts = []
     with db:
-        for _ix, row in tqdm(grid.iterrows(), total=len(grid)):
+        for _ix, row in tqdm(
+            grid.iterrows(),
+            total=len(grid),
+            desc="Checking semantic field/component lib compatibility.",
+        ):
             context = row.to_dict()
             for field_name, field_val in field_vals.items():
                 context[field_name] = field_val[context[field_name]]
@@ -72,3 +92,6 @@ def check_model_existence(
                 )
             except Exception as e:
                 print(f"\nError: {e}, context: {context}\n")
+                failing_contexts.append(context)
+    if raise_on_error and failing_contexts:
+        raise ModelsNotConstructableError(failing_contexts)

{epinterface-1.0.2 → epinterface-1.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "epinterface"
-version = "v1.0.2"
+version = "v1.0.4"
 description = "This is a repository for dynamically generating energy models within Python, relying on Archetypal and Eppy for most of its functionality."
 readme = "README.md"
 authors = [
@@ -12,6 +12,7 @@ dependencies = [
     "click==8.1.7",
     "geopandas~=1.0.1",
     "httpx~=0.27.2",
+    "ladybug-core>=0.44.30",
     "openpyxl~=3.1.5",
     "pandas>=2.2,<2.3",
     "prisma~=0.15.0",

{epinterface-1.0.2 → epinterface-1.0.4}/uv.lock

@@ -598,13 +598,14 @@ wheels = [
 
 [[package]]
 name = "epinterface"
-version = "1.0.2"
+version = "1.0.4"
 source = { editable = "." }
 dependencies = [
     { name = "archetypal" },
     { name = "click" },
     { name = "geopandas" },
     { name = "httpx" },
+    { name = "ladybug-core" },
     { name = "openpyxl" },
     { name = "pandas" },
     { name = "prisma" },
@@ -636,6 +637,7 @@ requires-dist = [
     { name = "click", specifier = "==8.1.7" },
     { name = "geopandas", specifier = "~=1.0.1" },
     { name = "httpx", specifier = "~=0.27.2" },
+    { name = "ladybug-core", specifier = ">=0.44.30" },
     { name = "openpyxl", specifier = "~=3.1.5" },
     { name = "pandas", specifier = ">=2.2,<2.3" },
     { name = "prisma", specifier = "~=0.15.0" },
@@ -1428,6 +1430,28 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/3a/1d/50ad811d1c5dae091e4cf046beba925bcae0a610e79ae4c538f996f63ed5/kiwisolver-1.4.8-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:65ea09a5a3faadd59c2ce96dc7bf0f364986a315949dc6374f04396b0d60e09b", size = 71762, upload_time = "2024-12-24T18:30:48.903Z" },
 ]
 
+[[package]]
+name = "ladybug-core"
+version = "0.44.30"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "click" },
+    { name = "ladybug-geometry" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/bf/d5/c97c70cfbe345d3076a7a4c1c39285bd8617d47a170a9d931882d93019d3/ladybug_core-0.44.30.tar.gz", hash = "sha256:c01e1953b598a4d379d3996403ec6d1686870a3bd8474501be7281068c260aff", size = 242468, upload_time = "2026-01-06T17:26:42.834Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/c8/f9/90a46ce7e20d404c310ea1a68479a0ab0be4f995dc5c741bc17fda1702a3/ladybug_core-0.44.30-py3-none-any.whl", hash = "sha256:e5b65802adfd00d65cc1122a52b7ec561fa166c9bc78b240e05940c5f15be96f", size = 272523, upload_time = "2026-01-06T17:26:40.842Z" },
+]
+
+[[package]]
+name = "ladybug-geometry"
+version = "1.34.14"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/91/0c/1803f43741957787399c802ce07b833f0b69e8bf93630f5b275f88d65881/ladybug_geometry-1.34.14.tar.gz", hash = "sha256:7531f4d6a9f35e1c15f8307282af6ef43056e1652910bd0188114fcecae9a01d", size = 617102, upload_time = "2025-11-07T04:16:48.676Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/d4/52/7b8421a8ace22a17ae77dd9a8367e916364ed8be72502cb744805f06d6ac/ladybug_geometry-1.34.14-py3-none-any.whl", hash = "sha256:af91ee9285333ca1ddfaf439530306dff7f0a891cae40d4dc5491f139fcf7d36", size = 198221, upload_time = "2025-11-07T04:16:46.986Z" },
+]
+
 [[package]]
 name = "lark"
 version = "1.2.2"