ifctrano 0.1.7__py3-none-any.whl → 0.1.9__py3-none-any.whl

ifctrano/exceptions.py

@@ -8,3 +8,19 @@ class BoundingBoxFaceError(Exception):
 
 class IfcFileNotFoundError(FileNotFoundError):
     pass
+
+
+class SpaceSurfaceAreaNullError(Exception):
+    pass
+
+
+class NoIfcSpaceFoundError(Exception):
+    pass
+
+
+class InvalidLibraryError(Exception):
+    pass
+
+
+class VectorWithNansError(Exception):
+    pass

ifctrano/main.py

@@ -1,12 +1,14 @@
+import shutil
 from pathlib import Path
-from typing import Annotated
+from tempfile import TemporaryDirectory
+from typing import Annotated, get_args
 
 import typer
-from pydantic import validate_call
 from rich.progress import Progress, SpinnerColumn, TextColumn
 
 from ifctrano.base import Libraries
 from ifctrano.building import Building
+from ifctrano.exceptions import InvalidLibraryError
 
 app = typer.Typer()
 CHECKMARK = "[green]✔[/green]"
@@ -14,14 +16,13 @@ CROSS_MARK = "[red]✘[/red]"
 
 
 @app.command()
-@validate_call
 def create(
     model: Annotated[
         str,
         typer.Argument(help="Local path to the ifc file."),
     ],
     library: Annotated[
-        Libraries,
+        str,
         typer.Argument(help="Modelica library to be used for simulation."),
     ] = "Buildings",
 ) -> None:
@@ -30,6 +31,10 @@ def create(
         TextColumn("[progress.description]{task.description}"),
         transient=True,
     ) as progress:
+        if library not in get_args(Libraries):
+            raise InvalidLibraryError(
+                f"Invalid library {library}. Valid libraries are {get_args(Libraries)}"
+            )
         modelica_model_path = Path(model).resolve().with_suffix(".mo")
         task = progress.add_task(
             description=f"Generating model {modelica_model_path.name} with library {library} from {model}",
@@ -42,3 +47,29 @@ def create(
         modelica_model_path.write_text(modelica_model)
         progress.remove_task(task)
         print(f"{CHECKMARK} Model generated at {modelica_model_path}")
+
+
+@app.command()
+def verify() -> None:
+    verification_ifc = Path(__file__).parent / "example" / "verification.ifc"
+    with Progress(
+        SpinnerColumn(),
+        TextColumn("[progress.description]{task.description}"),
+        transient=True,
+    ) as progress, TemporaryDirectory() as temp_dir:
+        temp_ifc_file = Path(temp_dir) / verification_ifc.name
+        shutil.copy(verification_ifc, temp_ifc_file)
+        task = progress.add_task(
+            description="Trying to create a model from a test file...",
+            total=None,
+        )
+        building = Building.from_ifc(temp_ifc_file)
+        building.save_model()
+        if temp_ifc_file.parent.joinpath(f"{building.name}.mo").exists():
+            progress.remove_task(task)
+            print(f"{CHECKMARK} Model successfully created... your system is ready.")
+        else:
+            progress.remove_task(task)
+            print(
+                f"{CROSS_MARK} Model could not be created... please check your system."
+            )

ifctrano/space_boundary.py

@@ -7,17 +7,34 @@ import ifcopenshell.geom
 import ifcopenshell.util.shape
 from ifcopenshell import entity_instance, file
 from pydantic import BaseModel, Field
-from trano.elements import Space as TranoSpace, ExternalWall, Window, BaseWall  # type: ignore
-from trano.elements.construction import Construction, Layer, Material  # type: ignore
+from trano.data_models.conversion import SpaceParameter  # type: ignore
+from trano.elements import Space as TranoSpace, ExternalWall, Window, BaseWall, ExternalDoor  # type: ignore
+from trano.elements.construction import (  # type: ignore
+    Construction,
+    Layer,
+    Material,
+    Glass,
+    GlassLayer,
+    GasLayer,
+    GlassMaterial,
+    Gas,
+)
 from trano.elements.system import Occupancy  # type: ignore
-from trano.elements.types import Azimuth, Tilt  # type: ignore
+from trano.elements.types import Tilt  # type: ignore
 
-from ifctrano.base import GlobalId, settings, BaseModelConfig, CommonSurface
+from ifctrano.base import (
+    GlobalId,
+    settings,
+    BaseModelConfig,
+    CommonSurface,
+    ROUNDING_FACTOR,
+    CLASH_CLEARANCE,
+    Vector,
+)
 from ifctrano.bounding_box import OrientedBoundingBox
 
 
 def initialize_tree(ifc_file: file) -> ifcopenshell.geom.tree:
-
     tree = ifcopenshell.geom.tree()
 
     iterator = ifcopenshell.geom.iterator(
@@ -39,14 +56,41 @@ class Space(GlobalId):
     name: Optional[str] = None
     bounding_box: OrientedBoundingBox
     entity: entity_instance
+    average_room_height: float
+    floor_area: float
+    bounding_box_height: float
+    bounding_box_volume: float
 
-    def space_name(self) -> str:
-        main_name = (
-            remove_non_alphanumeric(self.name)
-            if self.name
-            else remove_non_alphanumeric(self.entity.GlobalId)
+    @classmethod
+    def from_entity(cls, entity: entity_instance) -> "Space":
+        bounding_box = OrientedBoundingBox.from_entity(entity)
+        entity_shape = ifcopenshell.geom.create_shape(settings, entity)
+        area = ifcopenshell.util.shape.get_footprint_area(entity_shape.geometry)  # type: ignore
+        volume = ifcopenshell.util.shape.get_volume(entity_shape.geometry)  # type: ignore
+        if area:
+            average_room_height = volume / area
+        else:
+            area = bounding_box.volume / bounding_box.height
+            average_room_height = bounding_box.height
+        return cls(
+            global_id=entity.GlobalId,
+            name=entity.Name,
+            bounding_box=bounding_box,
+            entity=entity,
+            average_room_height=average_room_height,
+            floor_area=area,
+            bounding_box_height=bounding_box.height,
+            bounding_box_volume=bounding_box.volume,
         )
-        return f"space_{main_name}_{self.entity.GlobalId}"
+
+    def check_volume(self) -> bool:
+        return round(self.bounding_box_volume, ROUNDING_FACTOR) == round(
+            self.floor_area * self.average_room_height, ROUNDING_FACTOR
+        )
+
+    def space_name(self) -> str:
+        main_name = f"{remove_non_alphanumeric(self.name)}_" if self.name else ""
+        return f"space_{main_name}{remove_non_alphanumeric(self.entity.GlobalId)}"
 
 
 material_1 = Material(
@@ -61,27 +105,81 @@ construction = Construction(
         Layer(material=material_1, thickness=0.18),
     ],
 )
+id_100 = GlassMaterial(
+    name="id_100",
+    thermal_conductivity=1,
+    density=2500,
+    specific_heat_capacity=840,
+    solar_transmittance=[0.646],
+    solar_reflectance_outside_facing=[0.062],
+    solar_reflectance_room_facing=[0.063],
+    infrared_transmissivity=0,
+    infrared_absorptivity_outside_facing=0.84,
+    infrared_absorptivity_room_facing=0.84,
+)
+
+air = Gas(
+    name="Air",
+    thermal_conductivity=0.025,
+    density=1.2,
+    specific_heat_capacity=1005,
+)
+glass = Glass(
+    name="double_glazing",
+    u_value_frame=1.4,
+    layers=[
+        GlassLayer(thickness=0.003, material=id_100),
+        GasLayer(thickness=0.0127, material=air),
+        GlassLayer(thickness=0.003, material=id_100),
+    ],
+)
 
 
 class SpaceBoundary(BaseModelConfig):
     bounding_box: OrientedBoundingBox
     entity: entity_instance
     common_surface: CommonSurface
-    adjacent_space: Optional[Space] = None
+    adjacent_spaces: List[Space] = Field(default_factory=list)
+
+    def boundary_name(self) -> str:
+        return f"{self.entity.is_a()}_{remove_non_alphanumeric(self.entity.GlobalId)}"
 
-    def model_element(self) -> Optional[BaseWall]:
+    def model_element(
+        self, exclude_entities: List[str], north_axis: Vector
+    ) -> Optional[BaseWall]:
+        if self.entity.GlobalId in exclude_entities:
+            return None
+        azimuth = self.common_surface.orientation.angle(north_axis)
         if "wall" in self.entity.is_a().lower():
             return ExternalWall(
-                surface=6.44,
-                azimuth=Azimuth.south,
+                name=self.boundary_name(),
+                surface=self.common_surface.area,
+                azimuth=azimuth,
+                tilt=Tilt.wall,
+                construction=construction,
+            )
+        if "door" in self.entity.is_a().lower():
+            return ExternalDoor(
+                name=self.boundary_name(),
+                surface=self.common_surface.area,
+                azimuth=azimuth,
                 tilt=Tilt.wall,
                 construction=construction,
             )
         if "window" in self.entity.is_a().lower():
             return Window(
-                surface=6.44,
-                azimuth=Azimuth.south,
+                name=self.boundary_name(),
+                surface=self.common_surface.area,
+                azimuth=azimuth,
                 tilt=Tilt.wall,
+                construction=glass,
+            )
+        if "roof" in self.entity.is_a().lower():
+            return ExternalWall(
+                name=self.boundary_name(),
+                surface=self.common_surface.area,
+                azimuth=azimuth,
+                tilt=Tilt.ceiling,
                 construction=construction,
             )
 
@@ -112,15 +210,24 @@ class SpaceBoundaries(BaseModel):
     space: Space
     boundaries: List[SpaceBoundary] = Field(default_factory=list)
 
-    def model(self) -> TranoSpace:
+    def model(
+        self, exclude_entities: List[str], north_axis: Vector
+    ) -> Optional[TranoSpace]:
+        external_boundaries = [
+            boundary.model_element(exclude_entities, north_axis)
+            for boundary in self.boundaries
+            if boundary.model_element(exclude_entities, north_axis)
+        ]
+        if not external_boundaries:
+            return None
         return TranoSpace(
             name=self.space.space_name(),
             occupancy=Occupancy(),
-            external_boundaries=[
-                boundary.model_element()
-                for boundary in self.boundaries
-                if boundary.model_element()
-            ],
+            parameters=SpaceParameter(
+                floor_area=self.space.floor_area,
+                average_room_height=self.space.average_room_height,
+            ),
+            external_boundaries=external_boundaries,
         )
 
     @classmethod
@@ -130,13 +237,7 @@ class SpaceBoundaries(BaseModel):
         tree: ifcopenshell.geom.tree,
         space: entity_instance,
     ) -> "SpaceBoundaries":
-        bounding_box = OrientedBoundingBox.from_entity(space)
-        space_ = Space(
-            global_id=space.GlobalId,
-            name=space.Name,
-            bounding_box=bounding_box,
-            entity=space,
-        )
+        space_ = Space.from_entity(space)
         clashes = tree.clash_clearance_many(
             [space],
             ifcopenshell_file.by_type("IfcWall")
@@ -144,7 +245,7 @@ class SpaceBoundaries(BaseModel):
             + ifcopenshell_file.by_type("IfcRoof")
             + ifcopenshell_file.by_type("IfcDoor")
             + ifcopenshell_file.by_type("IfcWindow"),
-            clearance=0.1,
+            clearance=CLASH_CLEARANCE,
         )
         space_boundaries = []
 
@@ -157,7 +258,7 @@ class SpaceBoundaries(BaseModel):
                 if element.GlobalId == space.GlobalId:
                     continue
                 space_boundary = SpaceBoundary.from_space_and_element(
-                    bounding_box, element
+                    space_.bounding_box, element
                 )
                 if space_boundary:
                     space_boundaries.append(space_boundary)

{ifctrano-0.1.7.dist-info → ifctrano-0.1.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ifctrano
-Version: 0.1.7
+Version: 0.1.9
 Summary: Package for generating building energy simulation model from IFC
 Home-page: https://github.com/andoludo/ifctrano
 License: GPL V3
@@ -22,7 +22,7 @@ Description-Content-Type: text/markdown
 
 # ifctrano - IFC to Energy Simulation Tool
 
-📖 **Full Documentation:** 👉 [Trano Docs](https://andoludo.github.io/ifctrano/) 
+📖 **Full Documentation:** 👉 [ifctrano Docs](https://andoludo.github.io/ifctrano/) 
 
 ```bash
 pip install ifctrano

ifctrano-0.1.9.dist-info/RECORD

@@ -0,0 +1,13 @@
+ifctrano/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ifctrano/base.py,sha256=xpfZ27dZ5SZ5z2fz3N4GonkGWvXRYhMfOjoy94R4Yt8,5748
+ifctrano/bounding_box.py,sha256=OnkOR3NOyVRFSdo0d9BeFm93ZU40TV_gQSxYHOEPCYE,9382
+ifctrano/building.py,sha256=NoF0V5H_jDoyl0zkWPrSQa4xX0HIA23Kqu_TbH4Q56M,7134
+ifctrano/example/verification.ifc,sha256=L6YRD_rny7IEB4myA7uCLO6eI-xXOn2jp_67lw3lUrE,128600
+ifctrano/exceptions.py,sha256=1FQeuuq_lVZ4CawwewQvkE8OlDQwhBTbKfmc2FiZodo,431
+ifctrano/main.py,sha256=5S2K0dvFd5k15nsomeDmLiIxFlqYdFr2hdepDFqf0Fs,2672
+ifctrano/space_boundary.py,sha256=SxVXkBi8TNZfmPDFT-6epuewk8E9V1astVgcD3FT8ew,8617
+ifctrano-0.1.9.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+ifctrano-0.1.9.dist-info/METADATA,sha256=EJUPwFbIeYTFV7Jo0nNRF4Vppzu0ihJg7eB3_KFYuF0,3003
+ifctrano-0.1.9.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+ifctrano-0.1.9.dist-info/entry_points.txt,sha256=_2daDejazkphufyEu0m3lOeTio53WYmjol3KmSN0JM4,46
+ifctrano-0.1.9.dist-info/RECORD,,

ifctrano-0.1.9.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+ifctrano=ifctrano.main:app
+

ifctrano-0.1.7.dist-info/RECORD

@@ -1,12 +0,0 @@
-ifctrano/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ifctrano/base.py,sha256=vwWmzOTnMpE5rmnIti7QeG92Z_rpk-9nIrl7I9Or1cA,4971
-ifctrano/bounding_box.py,sha256=_cvS6G6RaNKCFIE3gaQO-bQTKOxIvn0xDZ4rKSCL5T4,8390
-ifctrano/building.py,sha256=0RCxlupyPl7c7d1F-JVL0mjDGpB7MPYVpoDuXFI0AeE,1940
-ifctrano/exceptions.py,sha256=_kntVIsqEvz3zxtJd8RougQRXEwjF5avarmGB-mig1w,228
-ifctrano/main.py,sha256=97Uh8JgjoeeeZ3VMP1_STpDH23mOlW2M9oo9gwECLPE,1411
-ifctrano/space_boundary.py,sha256=PkBiLPT26-Us7emyjqNUjKDL4GWMxfQQnHYOgRhelEI,5175
-ifctrano-0.1.7.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-ifctrano-0.1.7.dist-info/METADATA,sha256=1kgy06CAiqdoqALp5VPMAO9qSULiB1ecI4Su6NFd9Dc,3000
-ifctrano-0.1.7.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-ifctrano-0.1.7.dist-info/entry_points.txt,sha256=lHxD6pcOuPxITBoWjE35s4f6Dy7tzPa48ffuI-ehb2M,43
-ifctrano-0.1.7.dist-info/RECORD,,

ifctrano-0.1.7.dist-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-trano=ifctrano.main:app
-