epinterface 1.0.2__tar.gz → 1.0.3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: epinterface
-Version: 1.0.2
+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.2 → epinterface-1.0.3}/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.3}/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.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "epinterface"
-version = "v1.0.2"
+version = "v1.0.3"
 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 = [

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

@@ -598,7 +598,7 @@ wheels = [
 
 [[package]]
 name = "epinterface"
-version = "1.0.2"
+version = "1.0.3"
 source = { editable = "." }
 dependencies = [
     { name = "archetypal" },