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
- General hints and howtos
- Simulation-Guide
- Advanced User-Guide
- Developer-Guide
bim2sim code
- bim2sim
- bim2sim package
run_project()
- Subpackages
- Submodules
- bim2sim.project module
FolderStructure
FolderStructure.CONFIG
FolderStructure.DECISIONS
FolderStructure.EXPORT
FolderStructure.FINDER
FolderStructure.IFC_BASE
FolderStructure.LOG
FolderStructure.assets
FolderStructure.b2sroot
FolderStructure.complete_project_folder()
FolderStructure.config
FolderStructure.copy_assets()
FolderStructure.create()
FolderStructure.create_project_folder()
FolderStructure.decisions
FolderStructure.delete()
FolderStructure.enrichment
FolderStructure.export
FolderStructure.finder
FolderStructure.ifc_base
FolderStructure.is_project_folder()
FolderStructure.log
FolderStructure.root
FolderStructure.sub_dirs
Project
add_config_section()
config_base_setup()
open_config()
- bim2sim.sim_settings module
AutoSettingNameMeta
BaseSimSettings
BaseSimSettings.add_space_boundaries
BaseSimSettings.building_rotation_overwrite
BaseSimSettings.check_mandatory()
BaseSimSettings.close_space_boundary_gaps
BaseSimSettings.correct_space_boundaries
BaseSimSettings.create_external_elements
BaseSimSettings.dymola_simulation
BaseSimSettings.fuzzy_threshold
BaseSimSettings.group_unidentified
BaseSimSettings.load_default_settings()
BaseSimSettings.max_wall_thickness
BaseSimSettings.reset_guids
BaseSimSettings.stories_to_load_guids
BaseSimSettings.update_from_config()
BaseSimSettings.weather_file_path
BooleanSetting
BuildingSimSettings
BuildingSimSettings.add_shadings
BuildingSimSettings.add_space_boundaries
BuildingSimSettings.ahu_cooling_overwrite
BuildingSimSettings.ahu_dehumidification_overwrite
BuildingSimSettings.ahu_heat_recovery_efficiency_overwrite
BuildingSimSettings.ahu_heat_recovery_overwrite
BuildingSimSettings.ahu_heating_overwrite
BuildingSimSettings.ahu_humidification_overwrite
BuildingSimSettings.ahu_tz_overwrite
BuildingSimSettings.base_infiltration_rate_overwrite
BuildingSimSettings.close_space_boundary_gaps
BuildingSimSettings.construction_class_doors
BuildingSimSettings.construction_class_walls
BuildingSimSettings.construction_class_windows
BuildingSimSettings.cooling_tz_overwrite
BuildingSimSettings.correct_space_boundaries
BuildingSimSettings.create_plots
BuildingSimSettings.heating_tz_overwrite
BuildingSimSettings.layers_and_materials
BuildingSimSettings.plot_singe_zone_guid
BuildingSimSettings.prj_custom_usages
BuildingSimSettings.prj_use_conditions
BuildingSimSettings.run_period_end_day
BuildingSimSettings.run_period_end_month
BuildingSimSettings.run_period_start_day
BuildingSimSettings.run_period_start_month
BuildingSimSettings.set_run_period
BuildingSimSettings.setpoints_from_template
BuildingSimSettings.sim_results
BuildingSimSettings.split_bounds
BuildingSimSettings.split_shadings
BuildingSimSettings.use_constant_infiltration_overwrite
BuildingSimSettings.use_maintained_illuminance
BuildingSimSettings.year_of_construction_overwrite
ChoiceSetting
GuidListSetting
NumberSetting
PathSetting
PlantSimSettings
Setting
SettingsManager
- bim2sim package