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

ifctrano/exceptions.py

@@ -14,5 +14,13 @@ class SpaceSurfaceAreaNullError(Exception):
     pass
 
 
+class NoIfcSpaceFoundError(Exception):
+    pass
+
+
 class InvalidLibraryError(Exception):
     pass
+
+
+class VectorWithNansError(Exception):
+    pass

ifctrano/main.py

@@ -1,4 +1,6 @@
+import shutil
 from pathlib import Path
+from tempfile import TemporaryDirectory
 from typing import Annotated, get_args
 
 import typer
@@ -45,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

@@ -8,10 +8,19 @@ import ifcopenshell.util.shape
 from ifcopenshell import entity_instance, file
 from pydantic import BaseModel, Field
 from trano.data_models.conversion import SpaceParameter  # type: ignore
-from trano.elements import Space as TranoSpace, ExternalWall, Window, BaseWall  # type: ignore
-from trano.elements.construction import Construction, Layer, Material  # 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,
@@ -19,6 +28,8 @@ from ifctrano.base import (
     BaseModelConfig,
     CommonSurface,
     ROUNDING_FACTOR,
+    CLASH_CLEARANCE,
+    Vector,
 )
 from ifctrano.bounding_box import OrientedBoundingBox
 
@@ -78,12 +89,8 @@ class Space(GlobalId):
         )
 
     def space_name(self) -> str:
-        main_name = (
-            remove_non_alphanumeric(self.name)
-            if self.name
-            else remove_non_alphanumeric(self.entity.GlobalId)
-        )
-        return f"space_{main_name}_{self.entity.GlobalId}"
+        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(
@@ -98,6 +105,34 @@ 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):
@@ -106,27 +141,44 @@ class SpaceBoundary(BaseModelConfig):
     common_surface: CommonSurface
     adjacent_spaces: List[Space] = Field(default_factory=list)
 
-    def model_element(self, exclude_entities: List[str]) -> Optional[BaseWall]:
+    def boundary_name(self) -> str:
+        return f"{self.entity.is_a()}_{remove_non_alphanumeric(self.entity.GlobalId)}"
+
+    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(
+                name=self.boundary_name(),
                 surface=self.common_surface.area,
-                azimuth=Azimuth.south,
+                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(
+                name=self.boundary_name(),
                 surface=self.common_surface.area,
-                azimuth=Azimuth.south,
+                azimuth=azimuth,
                 tilt=Tilt.wall,
-                construction=construction,
+                construction=glass,
             )
         if "roof" in self.entity.is_a().lower():
             return ExternalWall(
+                name=self.boundary_name(),
                 surface=self.common_surface.area,
-                azimuth=Azimuth.south,
+                azimuth=azimuth,
                 tilt=Tilt.ceiling,
                 construction=construction,
             )
@@ -158,7 +210,16 @@ class SpaceBoundaries(BaseModel):
     space: Space
     boundaries: List[SpaceBoundary] = Field(default_factory=list)
 
-    def model(self, exclude_entities: List[str]) -> 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(),
@@ -166,11 +227,7 @@ class SpaceBoundaries(BaseModel):
                 floor_area=self.space.floor_area,
                 average_room_height=self.space.average_room_height,
             ),
-            external_boundaries=[
-                boundary.model_element(exclude_entities)
-                for boundary in self.boundaries
-                if boundary.model_element(exclude_entities)
-            ],
+            external_boundaries=external_boundaries,
         )
 
     @classmethod
@@ -188,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 = []
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ifctrano
-Version: 0.1.8
+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.8.dist-info/RECORD

@@ -1,12 +0,0 @@
-ifctrano/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ifctrano/base.py,sha256=VjGWioeysspdTrgofhykw0eh6n9UkaXHp5gvOSVJ4hY,4991
-ifctrano/bounding_box.py,sha256=G0FcqCNG-nBrUkA5Hw8wWqvJODxWUxOo_x8jrk63YAc,8983
-ifctrano/building.py,sha256=mrqMAtPWmTerLXdtFHTvGLxXI5bg23gqEftlquSMgtw,5129
-ifctrano/exceptions.py,sha256=_kdQ4BfNq6RijIeFEcDsKJliXDW_QHzfUhdhEE_I1V0,332
-ifctrano/main.py,sha256=m8SpF6s7543d5tr3hkL9FXGAYnEblk7-xM8xygiwl3o,1605
-ifctrano/space_boundary.py,sha256=4Mk6eEBcA6ard0YWf5uHnaHu1Ik75Ekzg106baAGzU4,7029
-ifctrano-0.1.8.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-ifctrano-0.1.8.dist-info/METADATA,sha256=-wJb4lz-M2hjdzbTVrr-_Un9YHnqvIl3BiEe4IX5wGI,3000
-ifctrano-0.1.8.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-ifctrano-0.1.8.dist-info/entry_points.txt,sha256=_2daDejazkphufyEu0m3lOeTio53WYmjol3KmSN0JM4,46
-ifctrano-0.1.8.dist-info/RECORD,,