ifctrano 0.10.0__tar.gz → 0.11.0__tar.gz

{ifctrano-0.10.0 → ifctrano-0.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ifctrano
-Version: 0.10.0
+Version: 0.11.0
 Summary: Package for generating building energy simulation model from IFC
 License: GPL V3
 License-File: LICENSE
@@ -16,8 +16,8 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: ifcopenshell (>=0.8.1.post1,<0.9.0)
 Requires-Dist: open3d (>=0.19.0,<0.20.0)
 Requires-Dist: shapely (>=2.0.7,<3.0.0)
-Requires-Dist: trano (>=0.12.0,<0.13.0)
-Requires-Dist: typer (>=0.12.5,<0.13.0)
+Requires-Dist: trano (>=0.13.0,<0.14.0)
+Requires-Dist: typer (>=0.19.2,<0.20.0)
 Requires-Dist: vedo (>=2025.5.3,<2026.0.0)
 Project-URL: Repository, https://github.com/andoludo/ifctrano
 Description-Content-Type: text/markdown
@@ -134,7 +134,21 @@ ifctrano create /path/to/your.ifc IDEAS
 ```bash
 ifctrano create /path/to/your.ifc reduced_order
 ```
+---
+
+### 📁 Generate yaml configuration from IFC
+
+Instead of directly generating a Modelica model from an IFC file, this command creates a configuration .yaml file compatible with the Trano
+ Python package (https://github.com/andoludo/trano). This configuration file can be reviewed, adapted, and enriched before generating the final Modelica model, allowing for verification and customization of the translation process.
+```bash
+ifctrano config /path/to/your.ifc
+```
+
+Once the YAML configuration file has been generated and adapted, the following command can be used to generate and/or simulate the model.
 
+```bash
+ifctrano from-config /path/to/your.yaml
+```
 ---
 
 ### 🧱 Show Space Boundaries

{ifctrano-0.10.0 → ifctrano-0.11.0}/README.md

@@ -110,7 +110,21 @@ ifctrano create /path/to/your.ifc IDEAS
 ```bash
 ifctrano create /path/to/your.ifc reduced_order
 ```
+---
+
+### 📁 Generate yaml configuration from IFC
+
+Instead of directly generating a Modelica model from an IFC file, this command creates a configuration .yaml file compatible with the Trano
+ Python package (https://github.com/andoludo/trano). This configuration file can be reviewed, adapted, and enriched before generating the final Modelica model, allowing for verification and customization of the translation process.
+```bash
+ifctrano config /path/to/your.ifc
+```
+
+Once the YAML configuration file has been generated and adapted, the following command can be used to generate and/or simulate the model.
 
+```bash
+ifctrano from-config /path/to/your.yaml
+```
 ---
 
 ### 🧱 Show Space Boundaries

{ifctrano-0.10.0 → ifctrano-0.11.0}/ifctrano/main.py

@@ -2,14 +2,17 @@ import shutil
 import webbrowser
 from pathlib import Path
 from tempfile import TemporaryDirectory
-from typing import Annotated, get_args
+from typing import Annotated, get_args, Callable
 
 import typer
 from rich.progress import Progress, SpinnerColumn, TextColumn
+from trano.data_models.conversion import convert_network  # type: ignore
+from trano.elements.library.library import Library  # type: ignore
 from trano.reporting.html import to_html_reporting  # type: ignore
 from trano.reporting.reporting import ModelDocumentation  # type: ignore
 from trano.reporting.types import ResultFile  # type: ignore
 from trano.simulate.simulate import simulate  # type: ignore
+from trano.topology import Network  # type: ignore
 from trano.utils.utils import is_success  # type: ignore
 
 from ifctrano.base import Libraries
@@ -22,6 +25,45 @@ CHECKMARK = "[green]✔[/green]"
 CROSS_MARK = "[red]✘[/red]"
 
 
+def _create_network(model: str, library: str) -> Network:
+    library_ = Library.from_configuration(library)
+    model_ = Path(model).resolve()
+    return convert_network(str(model_.stem), model_, library=library_)
+
+
+def _simulate(
+    modelica_model_path: Path, create_network_callable: Callable[[], Network]
+) -> None:
+    print("Simulating...")
+    try:
+        results = simulate(modelica_model_path.parent, create_network_callable())
+    except Exception as e:
+        print(f"{CROSS_MARK} Simulation failed: {e}")
+        return
+    if not is_success(results):
+        print(f"{CROSS_MARK} Simulation failed. See logs for more information.")
+        return
+
+    result_path = (
+        Path(modelica_model_path.parent)
+        / "results"
+        / f"{modelica_model_path.stem.lower()}.building_res.mat"
+    )
+    if not result_path.exists():
+        print(
+            f"{CROSS_MARK} Simulation failed. Result file not found in {result_path}."
+        )
+        return
+    reporting = ModelDocumentation.from_network(
+        create_network_callable(),
+        result=ResultFile(path=result_path),
+    )
+    html = to_html_reporting(reporting)
+    report_path = Path(modelica_model_path.parent / f"{modelica_model_path.stem}.html")
+    report_path.write_text(html)
+    webbrowser.open(f"file://{report_path}")
+
+
 @app.command()
 def config(
     model: Annotated[
@@ -54,6 +96,43 @@ def config(
         print(f"{CHECKMARK} configuration file generated: {config_path}.")
 
 
+@app.command()
+def from_config(
+    model: Annotated[
+        str,
+        typer.Argument(help="Path to the configuration yaml file."),
+    ],
+    library: Annotated[
+        str,
+        typer.Argument(help="Modelica library to be used for simulation."),
+    ] = "Buildings",
+    simulate_model: Annotated[
+        bool,
+        typer.Option(help="Simulate the generated model."),
+    ] = False,
+) -> None:
+    with Progress(
+        SpinnerColumn(),
+        TextColumn("[progress.description]{task.description}"),
+        transient=True,
+    ) as progress:
+        modelica_model_path = Path(model).resolve().with_suffix(".mo")
+        task = progress.add_task(
+            description=f"Generating model {modelica_model_path.name} with library {library}",
+            total=None,
+        )
+        network = _create_network(model, library)
+        modelica_model = network.model()
+        progress.update(task, completed=True)
+        task = progress.add_task(description="Writing model to file...", total=None)
+        modelica_model_path.write_text(modelica_model)
+        progress.remove_task(task)
+        print(f"{CHECKMARK} Model generated at {modelica_model_path}")
+        create_network_callable = lambda: _create_network(model, library)  # noqa: E731
+        if simulate_model:
+            _simulate(modelica_model_path, create_network_callable)
+
+
 @app.command()
 def create(
     model: Annotated[
@@ -97,42 +176,11 @@ def create(
         modelica_model_path.write_text(modelica_network.model())
         progress.remove_task(task)
         print(f"{CHECKMARK} Model generated at {modelica_model_path}")
+        create_network_callable = lambda: building.create_network(  # noqa: E731
+            library=library  # type: ignore
+        )
         if simulate_model:
-            print("Simulating...")
-            try:
-                results = simulate(
-                    modelica_model_path.parent,
-                    building.create_network(
-                        library=library  # type: ignore
-                    ),  # TODO: cannot use the network after creating he model
-                )
-            except Exception as e:
-                print(f"{CROSS_MARK} Simulation failed: {e}")
-                return
-            if not is_success(results):
-                print(f"{CROSS_MARK} Simulation failed. See logs for more information.")
-                return
-
-            result_path = (
-                Path(modelica_model_path.parent)
-                / "results"
-                / f"{modelica_model_path.stem.lower()}.building_res.mat"
-            )
-            if not result_path.exists():
-                print(
-                    f"{CROSS_MARK} Simulation failed. Result file not found in {result_path}."
-                )
-                return
-            reporting = ModelDocumentation.from_network(
-                building.create_network(library=library),  # type: ignore
-                result=ResultFile(path=result_path),
-            )
-            html = to_html_reporting(reporting)
-            report_path = Path(
-                modelica_model_path.parent / f"{modelica_model_path.stem}.html"
-            )
-            report_path.write_text(html)
-            webbrowser.open(f"file://{report_path}")
+            _simulate(modelica_model_path, create_network_callable)
 
 
 @app.command()

{ifctrano-0.10.0 → ifctrano-0.11.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ifctrano"
-version = "0.10.0"
+version = "0.11.0"
 description = "Package for generating building energy simulation model from IFC"
 authors = ["Ando Andriamamonjy <andoludovic.andriamamonjy@gmail.com>"]
 license = "GPL V3"
@@ -11,9 +11,9 @@ keywords = ["BIM","IFC","energy simulation", "modelica", "building energy simula
 [tool.poetry.dependencies]
 python = ">=3.10,<3.13"
 ifcopenshell = "^0.8.1.post1"
-trano = "^0.12.0"
+trano = "^0.13.0"
 shapely = "^2.0.7"
-typer = "^0.12.5"
+typer = "^0.19.2"
 vedo = "^2025.5.3"
 open3d = "^0.19.0"