Welcome to bim2sim’s documentation!
bim2sim
bim2sim is a library to create simulation models for different purposes based on BIM models in the IFC format. The project is based on a base code that provides the possiblity to map the IFC data into a uniform meta strucuture. This structure can then be used to create simulation models for different purposes which is done by plugins. The corresponding project BIM2SIM (see founding section below) adressed the following four domains:
Building Performance Simulation (BPS)
Heating, Ventilation, Air Conditioning (HVAC)
Life Cycle Assessment (LCA)
The focus of the currently released tool is on BPS and HVAC but we already provide basic methods for CFD and LCA as well. The base structure is shown below:

Installation and Usage
You can find detailed documentation and description how to install and to use in our documentation. We recommend reading at least:
Big Picture to understand the concepts of bim2sim
PluginTemplate - How to install? to understand how to install the Base of the framework.
Acknowledgements
The tool was developed during the project “BIM2SIM - Methodenentwicklung zur Erstellung von Simulationsmodellen aus Daten des Building Information Modeling”. The project was funded by the Federal Ministry for Economic Affairs and Energy in germany under the grant number 03ET1562A. The ongoing development is funded by the follow up project “BIM2Praxis - Integration of methods for the creation of simulation models based on Building Information Modeling into practice” with funding from the Federal Ministry for Economic Affairs and Climate Action under the grant number 3EN1050A. The authors of the tool gratefully acknowledge the financial support of the German Federal Ministry for Economic Affairs and Energy and the Federal Ministry for Economic Affairs and Climate Action in Germany.
License
bim2sim is developed and released by the following three partners under the LGPL-3.0 license:
Institute for Energy Efficient Buildings and Indoor Climate (RWTH Aachen University)
E3D - Institute of Energy Efficiency and Sustainable Building (RWTH Aachen University)

Upcoming Features:
bim2sim is still under heavy development and you can find a lot of features that we want to improve or implement inside the issue section. Anyway here are some of the major ones that we plan to implement:
[ ] release of an interactive webtool that has its own inbuilt IFC viewer to support decision making along the model geenration process
[ ] interactive visualization of hydraulic networks graphs for HVAC part
[ ] implementation of curtain walls for BPS part
[ ] support of AHU and ventilation simulations with Modelica
[ ] automated integration of weather files based of location of building
[ ] … have a look at the issues
Contents of this documentation
- Big Picture
- User-Guide
- PluginTemplate
- PluginTEASER
- PluginEnergyPlus
- PluginComfort
- PluginAixLib
- PluginHKESim
- PluginLCA
- PluginOpenFOAM
- General hints and howtos
- Simulation-Guide
- Advanced User-Guide
- Concepts
- Project File Structure
- Writing your own bim2sim Plugin
- Developer-Guide
bim2sim code
- bim2sim
- bim2sim package
run_project()- Subpackages
- Submodules
- bim2sim.project module
FolderStructureFolderStructure.CONFIGFolderStructure.DECISIONSFolderStructure.EXPORTFolderStructure.FINDERFolderStructure.IFC_BASEFolderStructure.LOGFolderStructure.assetsFolderStructure.b2srootFolderStructure.complete_project_folder()FolderStructure.configFolderStructure.copy_assets()FolderStructure.create()FolderStructure.create_project_folder()FolderStructure.decisionsFolderStructure.delete()FolderStructure.enrichmentFolderStructure.exportFolderStructure.finderFolderStructure.ifc_baseFolderStructure.is_project_folder()FolderStructure.logFolderStructure.rootFolderStructure.sub_dirs
Projectadd_config_section()config_base_setup()open_config()
- bim2sim.sim_settings module
AutoSettingNameMetaBaseSimSettingsBaseSimSettings.add_space_boundariesBaseSimSettings.building_rotation_overwriteBaseSimSettings.check_mandatory()BaseSimSettings.close_space_boundary_gapsBaseSimSettings.correct_space_boundariesBaseSimSettings.create_external_elementsBaseSimSettings.dymola_simulationBaseSimSettings.fuzzy_thresholdBaseSimSettings.group_unidentifiedBaseSimSettings.group_unidentified_BaseSimSettings.load_default_settings()BaseSimSettings.max_wall_thicknessBaseSimSettings.reset_guidsBaseSimSettings.stories_to_load_guidsBaseSimSettings.update_from_config()BaseSimSettings.weather_file_path
BooleanSettingBuildingSimSettingsBuildingSimSettings.add_shadingsBuildingSimSettings.add_space_boundariesBuildingSimSettings.ahu_cooling_overwriteBuildingSimSettings.ahu_dehumidification_overwriteBuildingSimSettings.ahu_heat_recovery_efficiency_overwriteBuildingSimSettings.ahu_heat_recovery_overwriteBuildingSimSettings.ahu_heating_overwriteBuildingSimSettings.ahu_humidification_overwriteBuildingSimSettings.ahu_tz_overwriteBuildingSimSettings.base_infiltration_rate_overwriteBuildingSimSettings.close_space_boundary_gapsBuildingSimSettings.construction_class_doorsBuildingSimSettings.construction_class_wallsBuildingSimSettings.construction_class_windowsBuildingSimSettings.cooling_tz_overwriteBuildingSimSettings.correct_space_boundariesBuildingSimSettings.create_plotsBuildingSimSettings.heating_tz_overwriteBuildingSimSettings.layers_and_materialsBuildingSimSettings.plot_singe_zone_guidBuildingSimSettings.prj_custom_usagesBuildingSimSettings.prj_use_conditionsBuildingSimSettings.run_period_end_dayBuildingSimSettings.run_period_end_monthBuildingSimSettings.run_period_start_dayBuildingSimSettings.run_period_start_monthBuildingSimSettings.set_run_periodBuildingSimSettings.setpoints_from_templateBuildingSimSettings.sim_resultsBuildingSimSettings.split_boundsBuildingSimSettings.split_shadingsBuildingSimSettings.use_constant_infiltration_overwriteBuildingSimSettings.use_maintained_illuminanceBuildingSimSettings.year_of_construction_overwrite
ChoiceSettingGuidListSettingNumberSettingPathSettingPlantSimSettingsSettingSettingsManager
- bim2sim package