gbxml2idf

This is a python-based script written to convert gbXML(BIM) file to an IDF(EnergyPlus) file.

https://github.com/udaragithub/gbxml2idf

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.9%) to scientific vocabulary

Keywords

bim energy energyplus gbxml idf
Last synced: 6 months ago · JSON representation ·

Repository

This is a python-based script written to convert gbXML(BIM) file to an IDF(EnergyPlus) file.

Basic Info
  • Host: GitHub
  • Owner: Udaragithub
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 13 MB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Topics
bim energy energyplus gbxml idf
Created almost 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

gbXML to IDF Translator

The gbXML2IDF translator is a newly created middleware solution built on Python. This translator facilitates the conversion of Building Information Modeling (BIM) models from the gbXML format, to Energy Plus model, the IDF format. The gbXML is an open-source schema tailored for containing the necessary data for energy simulations and IDF is a format for Building Energy Modeling (BEM) files supported by the EnergyPlus simulation engine.

This tool functions by mapping various building properties from the gbXML schema to the IDF data format. It extracts details such as geometry, thermal properties, heat gains, occupancy/lighting/equipment schedules, and HVAC specifics from the gbXML file and converts them into IDF data classes. Furthermore, it incorporates default schedules, HVAC objects, and output objects from a library to supplement any missing data.

A rich picture of data mapping is shown below,

How to use this script?

Before you use this script, you need to prepare the BIM model using the PDS-template.rte Revit template file. Then run energy model preparation command in Revit and export gbXML file from the software.

[!IMPORTANT] Spaces must be defined for enclosed areas (Ex- bed rooms) and the correct space type should be selected from the items with BIM abbrevation in the Revit template file. You can select Adiabatic floor or walls to model adiabatic surfaces

  • Step 01 - Install python packages : lxml, xgbxml, eppy
  • Step 02 - Download gbxmlconvertor.py, GUI01BIM2BEM_Convertor.py and Template files folder in to the same folder
  • Step 03 - Modify Two template files (IDFtemplate.idf and IDFschedules.idf files) if needed.
  • Step 04 - Run GUI01BIM2BEMConvertor.py and input, working folder (which contains gbXML file), IDFtemplate.idf file location and IDF-Schedule.idf file location)
  1. eplusrevit.idf - Ready-to-simulate IDF file
  2. material_data.csv - Summary of material data mapping (Material name of BIM file) and corresponding IDF name
  3. space_data.csv - Summary of space data (name, occupants, heat gain values) and corresponding IDF name

[!WARNING] In the latest version of the translator, occupancy,lighting and equipment schedules are mapped by the name in Revit template file. If you do not use the template file, there will be errors in IDF file. Now following files will be created in the working folder.

Are you familiar with Dynamo for Revit?

A seperate Dynamo script is prepared which converts Autodesk Revit model into an IDF file with a single-click. Check the Dynamo script folder

Validation of the translator with test cases

To be updated

Research works

To be updated

Owner

  • Login: Udaragithub
  • Kind: user

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: gbXML2IDF
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Perera
    family-names: Udara Sachinthana
    email: mail.sachinthana@gmail.com
    affiliation: University of Moratuwa
    orcid: 'https://orcid.org/0000-0002-3585-0940'
repository-code: 'https://github.com/Udaragithub/gbXML2IDF'
abstract: >-
  This is a python-based script written to convert
  gbXML(BIM) file to an IDF(EnergyPlus) file.
keywords:
  - gbxml
  - bim
  - energyplus
license: MIT
version: '1'
date-released: '2024-05-01'

GitHub Events

Total
Last Year