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

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/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.1.dist-info → epinterface-1.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: epinterface
-Version: 1.0.1
+Version: 1.0.3
 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

{epinterface-1.0.1.dist-info → epinterface-1.0.3.dist-info}/RECORD

@@ -26,7 +26,7 @@ epinterface/sbem/exceptions.py,sha256=4uOXlZgJyvhhRG2cbSua2InxxXHanGSe74h2ioiNEk
 epinterface/sbem/flat_model.py,sha256=q-G23Rvw3GBDYRm7Oa6PItI8_Xp-FYieLZmLDR4mNyM,84602
 epinterface/sbem/interface.py,sha256=M9p5XK3psKjExBTcOY66IFLK1sRcPiuKXbu4BckAXgU,25417
 epinterface/sbem/model_graph_structure.md,sha256=uCky10vTV-yuosd9LyLoXzKUzH-Vu6_oY7UCk35oBCg,952
-epinterface/sbem/utils.py,sha256=AILbYbP5NAjKRvoUrGtyMcX3JRBFb7hIk5g9NF_wUcg,2633
+epinterface/sbem/utils.py,sha256=i2BM9iwdW_fYpKfmnmXzOqJ4_APnxTaSlNHinVyWWUo,3581
 epinterface/sbem/components/__init__.py,sha256=nAhAN6WmcfR2uVfyJIjrFFctuzc7WFdVGmKJmjm3fwM,37
 epinterface/sbem/components/composer.py,sha256=Gs4v8-x8iqfCjaD28TREmqX0pHiRWwyoOh20OPnR3WU,16357
 epinterface/sbem/components/envelope.py,sha256=ccmLr2dajgA8s2qBwZxMaj3leu4DETROm6t4N6Q9oSo,12950
@@ -37,7 +37,7 @@ epinterface/sbem/components/space_use.py,sha256=CEWXZ47Etbn06zga88ypmlqwhXEIDSF6
 epinterface/sbem/components/systems.py,sha256=02C_HZd38mbE_4i0etxyS-py5y0UiZ9oXkkz_5hmqZ8,8945
 epinterface/sbem/components/zones.py,sha256=ivilWtXkDqWPej4JJho-XAu5aW4NrRqeR7mZDek2yQ0,1050
 epinterface/sbem/fields/__init__.py,sha256=4y74sjtmCMvTALurPyZxbXhTSPjvtkrY1rXgoFcvaYU,74
-epinterface/sbem/fields/spec.py,sha256=qa3PL_Z_FrswlB1JvTFtOXEBUN8ycMns7H0FKVsa1kU,3452
+epinterface/sbem/fields/spec.py,sha256=lYEyMPV-aODwqehZxGbofb2YUwL8F4er-c4oOcXM83Q,4522
 epinterface/sbem/prisma/client.py,sha256=689cjAnU1trW4r1Bfh49itwbhi3FL9rhSDEBtO59a4I,22060
 epinterface/sbem/prisma/partial_types.py,sha256=HxOvndrx-XMrp8twUazEt2dVzrsdvQAXo-GfnhoeOKM,4929
 epinterface/sbem/prisma/schema.prisma,sha256=az4o4Tb5qzmtIFm6g_z7afmGaAyXc2GrqEawWZ7fBF4,19189
@@ -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.1.dist-info/METADATA,sha256=aPgH-xHuqPojhGonAAKM_bPRj2MRq-hnZ9cLedCxpt4,3426
-epinterface-1.0.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-epinterface-1.0.1.dist-info/entry_points.txt,sha256=bjjYRuHWvWV0d-QUesH6prRqHqcppTJANSuAfg3h9j8,78
-epinterface-1.0.1.dist-info/licenses/LICENSE,sha256=hNp6DmbGMuUcwlnpYS8E-ZHYU7kxfmRUP8pLGQaCnu8,1066
-epinterface-1.0.1.dist-info/RECORD,,
+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,,