Skip to main content

Package for generating building energy simulation model from IFC

Project description

ifctrano - IFC to Energy Simulation Tool


📖 Full Documentation: 👉 ifctrano Docs

Generate Modelica building models directly from IFC files — with support for simulation, visualization, and multiple libraries.

Overview

ifctrano is yet another IFC to energy simulation tool designed to translate Industry Foundation Classes (IFC) models into energy simulation models in Modelica.

Key Differentiator

Unlike most translation approaches that rely on space boundaries (IfcRelSpaceBoundary) (e.g. see An automated IFC-based workflow for building energy performance simulation with Modelica), ifctrano operates solely on geometrical representation. This is crucial because space boundaries are rarely available in IFC models. Instead, ifctrano requires at least the definition of IfcSpace objects to build energy simulation models.

Space-Zone Mapping

For now, each space is considered as a single thermal zone, and the necessary space boundaries are automatically generated.

Why ifctrano?

✅ No reliance on IfcRelSpaceBoundary

✅ Works with geometric representation only

✅ Supports Modelica-based energy simulation

Tested on multiple open-source IFC files

Open Source IFC Test Files

ifctrano has been tested using open-source IFC files from various repositories:

🚀 Installation

📦 Install ifctrano

!!! warning Trano requires python 3.9 or higher and docker to be installed on the system.

ifctrano is a Python package that can be installed via pip.

pip install ifctrano

✅ Verify Installation

Run the following commands to ensure everything is working:

ifctrano --help
ifctrano verify

🔧 Optional Dependencies

🐳 Docker (for simulation)

To enable model simulation using the official OpenModelica Docker image, install Docker Desktop:

👉 https://docs.docker.com/desktop/

Required for using the --simulate-model flag.


🧠 Graphviz (for layout visualization)

ifctrano leverages Graphviz to optimize component layout in generated Modelica models. It is optional, but recommended.

📥 Install on Windows

🐧 Install on Linux

sudo apt update
sudo apt install graphviz

⚙️ Usage

📁 Generate Modelica models from IFC

🏢 Using the Buildings library

ifctrano create /path/to/your.ifc

🏫 Using the IDEAS library

ifctrano create /path/to/your.ifc IDEAS

🧮 Using the Reduced Order library

ifctrano create /path/to/your.ifc reduced_order

🧱 Show Space Boundaries

To visualize the computed space boundaries:

ifctrano create /path/to/your.ifc --show-space-boundaries

🔁 Simulate the Model

Run a full simulation after model generation:

ifctrano create /path/to/your.ifc --simulate-model

Make sure Docker is installed and running before simulating.


💡 ifctrano aims to make energy simulation model generation from IFC files simpler, more accessible, and less reliant on incomplete IFC attributes. 🚀

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ifctrano-0.4.0.tar.gz (30.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ifctrano-0.4.0-py3-none-any.whl (32.3 kB view details)

Uploaded Python 3

File details

Details for the file ifctrano-0.4.0.tar.gz.

File metadata

  • Download URL: ifctrano-0.4.0.tar.gz
  • Upload date:
  • Size: 30.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.10

File hashes

Hashes for ifctrano-0.4.0.tar.gz
Algorithm Hash digest
SHA256 9fcd7d91b2eb1d8d4aa9cc86641a7205af689087838ef4591e4227fdb1b580d6
MD5 40b8c910b6a8f0f29e9840c0fb2cebc5
BLAKE2b-256 58bdfcc9f0d860a18c3a0878eff27b6c6792b7aa64b1aea85e698470814dc5b0

See more details on using hashes here.

File details

Details for the file ifctrano-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: ifctrano-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 32.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.10

File hashes

Hashes for ifctrano-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ec36ce7c0bad18b7b62a6f9eabf320987d9df519f3766353a8c0d0ff0cf1e37a
MD5 c20cbe55b9e7f46bf9213db38cb4a603
BLAKE2b-256 8575f1e6e1865f8358da0aa7ff29cb582b28a3415a81ea189401ff1f975b1852

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page