epinterface 1.0.3__py3-none-any.whl → 1.0.5__py3-none-any.whl

epinterface/sbem/builder.py

@@ -2,18 +2,20 @@
 
 import asyncio
 import gc
+import logging
 import shutil
 import tempfile
 from collections.abc import Callable
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Literal, cast
+from typing import Literal, cast, get_args
 from uuid import uuid4
 
 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",
@@ -46,11 +50,13 @@ DESIRED_METERS = (
 )
 
 # TODO: add the meters for HVAC systems
-DESIRED_VARIABLES = (
+AvailableHourlyVariables = Literal[
     "Zone Mean Air Temperature",
     "Zone Air Relative Humidity",
     "Site Outdoor Air Drybulb Temperature",
-)
+]
+
+AVAILABLE_HOURLY_VARIABLES = get_args(AvailableHourlyVariables)
 
 
 class SimulationPathConfig(BaseModel):
@@ -803,7 +809,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,
@@ -846,7 +852,7 @@ class Model(BaseWeather, validate_assignment=True):
                     "Variable_Name": variable,
                     "Reporting_Frequency": "Hourly",
                 }
-                for variable in DESIRED_VARIABLES
+                for variable in AVAILABLE_HOURLY_VARIABLES
             ]
         )
         idf = IDF(
@@ -870,10 +876,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 +887,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 +1350,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 +1375,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 +1412,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/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.3.dist-info → epinterface-1.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: epinterface
-Version: 1.0.3
+Version: 1.0.5
 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.3.dist-info → epinterface-1.0.5.dist-info}/RECORD

@@ -20,7 +20,7 @@ epinterface/data/__init__.py,sha256=r6Uju05rbG3hVVAvCuqJS5wI_zLwK3fU_M8nKMC5DEA,
 epinterface/data/res_schedules.parquet,sha256=GjMaqb8uywr7FwR3rAByL72BKGfoZiVuSdAH2sAPFvw,4295
 epinterface/sbem/__init__.py,sha256=aOEtaivujVzFDMFyLrLRx_Xmwv7_Y60MYqObBsn5OR8,48
 epinterface/sbem/annotations.py,sha256=qnN0z7Suri5eHHPJNvXWUorYbEMHGajX2DPezCYcCSQ,1302
-epinterface/sbem/builder.py,sha256=Vu-UsvzxOGIJWPkA81goKtT8_uf3YJ3h9yUHJn2RFws,55328
+epinterface/sbem/builder.py,sha256=hgXHtILjpT921uAaw5Ictv_wChKVYoFsrPljJtDERTg,58198
 epinterface/sbem/common.py,sha256=s7DekSlosfM2mQUZGiIGEbbgiJfF7h6QsTvYbAPP3Ac,1317
 epinterface/sbem/exceptions.py,sha256=4uOXlZgJyvhhRG2cbSua2InxxXHanGSe74h2ioiNEkw,3332
 epinterface/sbem/flat_model.py,sha256=q-G23Rvw3GBDYRm7Oa6PItI8_Xp-FYieLZmLDR4mNyM,84602
@@ -32,7 +32,7 @@ epinterface/sbem/components/composer.py,sha256=Gs4v8-x8iqfCjaD28TREmqX0pHiRWwyoO
 epinterface/sbem/components/envelope.py,sha256=ccmLr2dajgA8s2qBwZxMaj3leu4DETROm6t4N6Q9oSo,12950
 epinterface/sbem/components/materials.py,sha256=MKewPewQEMim9kbLDdgbnW9mXkJh9Juxarf2O-jcW3I,3340
 epinterface/sbem/components/operations.py,sha256=G8GedBR6evNq8ZQ0Ff004Av2Bcz-afCjVmJMC17r6mI,14924
-epinterface/sbem/components/schedules.py,sha256=AQWHkoBN2apbAVYSN_URe836LSGeEcBZ457WCJTUhOw,24449
+epinterface/sbem/components/schedules.py,sha256=G6QTdM7hngDhtNygKipqVS_CXiXB5jXSk1Kr7D7pMlQ,25130
 epinterface/sbem/components/space_use.py,sha256=CEWXZ47Etbn06zga88ypmlqwhXEIDSF6Wf4HpW8RFJM,10125
 epinterface/sbem/components/systems.py,sha256=02C_HZd38mbE_4i0etxyS-py5y0UiZ9oXkkz_5hmqZ8,8945
 epinterface/sbem/components/zones.py,sha256=ivilWtXkDqWPej4JJho-XAu5aW4NrRqeR7mZDek2yQ0,1050
@@ -50,8 +50,8 @@ epinterface/sbem/prisma/migrations/20250325185158_add_mutually_exclusive_ventila
 epinterface/sbem/prisma/migrations/20250326141941_reduce_naming_complexity_ventilation/migration.sql,sha256=tslwxYOfpbfWCUPqnOadTGk-BzluLcly27MV-mZy2Sc,2289
 epinterface/sbem/prisma/migrations/20250331141910_add_support_for_attic_and_basement_constructions/migration.sql,sha256=fvAzKga8qsMmVM3jLFDAlSbBkWbqRGrHu5Mf2doIEgs,6690
 epinterface/sbem/prisma/migrations/20250919152559_decouple_basement_infiltration/migration.sql,sha256=YrQJxHcU1jrKb6AlBSdfuJKETKkkyxqdKb-X8krBH-8,1876
-epinterface-1.0.3.dist-info/METADATA,sha256=V_hpPgy5kYUvOK7qMtdHPRSc8GW-iasrfQtxf_CM5mk,3426
-epinterface-1.0.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-epinterface-1.0.3.dist-info/entry_points.txt,sha256=bjjYRuHWvWV0d-QUesH6prRqHqcppTJANSuAfg3h9j8,78
-epinterface-1.0.3.dist-info/licenses/LICENSE,sha256=hNp6DmbGMuUcwlnpYS8E-ZHYU7kxfmRUP8pLGQaCnu8,1066
-epinterface-1.0.3.dist-info/RECORD,,
+epinterface-1.0.5.dist-info/METADATA,sha256=2t5ecDAFk_97jAnOAvlvFwHDarCGPXZIAmxJnkpObHA,3463
+epinterface-1.0.5.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+epinterface-1.0.5.dist-info/entry_points.txt,sha256=bjjYRuHWvWV0d-QUesH6prRqHqcppTJANSuAfg3h9j8,78
+epinterface-1.0.5.dist-info/licenses/LICENSE,sha256=hNp6DmbGMuUcwlnpYS8E-ZHYU7kxfmRUP8pLGQaCnu8,1066
+epinterface-1.0.5.dist-info/RECORD,,