Welcome to bim2sim’s documentation!

• Big Picture
  • What is bim2sim about?
  • How does bim2sim work?
  • Simulation Types
    • Building Performance Simulation (BPS)
      • Reasons to perform a BPS
      • Requirements for BPS in bim2sim
      • IFC Requirements
    • Heating Ventilation and Air Conditioning (HVAC) Simulation
      • Hydraulic Network
      • Generation Devices & Consumers
      • Control Logic
  • What are Plugins?
  • Compatibility
• User-Guide
  • PluginTemplate
    • How to install?
      • Step by step
      • Trouble Shooting
      • Docker
      • Test installation
    • How to create a project?
      • Console
      • Script
    • Structure of the plugin template
    • Examples
    • How to load an IFC file?
    • How to configure my project?
      • Simulation settings
      • Configuration file
      • Default tasks
      • Additional templates
    • How to run the project?
    • How to run the simulation?
    • How to analyze the project?
      • What kind of results exist?
      • What programs/tools to use for further analysis?
  • PluginTEASER
    • How to install?
      • Step by step
      • Test install
    • Structure of the plugin
    • How to create a project?
    • How to load an IFC file?
    • How to configure my project?
      • Simulation settings
      • Configuration file
      • Default tasks
      • Additional templates
    • How to run the project?
    • How to run the simulation?
    • How to analyze the project?
      • What kind of results exist?
      • What programs/tools to use for further analysis?
    • Enrichment
    • Space Boundary Usage
    • Zoning
      • External/Internal
      • Orientation
      • Usage
      • Window to wall ratio
  • PluginEnergyPlus
    • How to install?
      • Step by step
      • Trouble Shooting
      • Test install
    • Structure of the plugin
    • How to create a project?
    • How to load an IFC file?
    • How to configure my project?
      • Simulation settings
      • Configuration file
      • Default tasks
      • Additional templates
    • How to run the project?
    • How to run the simulation?
    • How to analyze the project?
      • What kind of results exist?
      • What programs/tools to use for further analysis?
    • EnergyPlus specific tasks
      • Validation of the IFC file
      • Geometric Preprocessing for EnergyPlus Export
      • Add 2b Space Boundaries
      • Set the Weather File
      • Initialize and Export the EnergyPlus IDF File
      • IDF Postprocessing
      • Export IDF Geometry for CFD Processing
      • Run EnergyPlus Simulation
    • EnergyPlusSimSettings
  • PluginComfort
    • How to install?
      • Step by step
      • Trouble Shooting
      • Test install
    • Structure of the plugin
    • Comfort specific tasks
      • Add Comfort Settings
      • Create result dataframe for comfort analysis
      • Plot comfort results
    • How to create a project?
    • How to load an IFC file?
    • How to configure my project?
      • Simulation settings
      • Configuration file
      • Default tasks
      • Additional templates
    • How to run the project?
    • How to run the simulation?
    • How to analyze the project?
      • What kind of results exist?
      • What programs/tools to use for further analysis?
  • PluginAixLib
    • How to install?
      • Step by step
      • Test install
    • Structure of the plugin
    • How to create a project?
    • How to load an IFC file?
    • How to configure my project?
      • Simulation settings
      • Configuration file
      • Default tasks
      • Additional templates
    • How to run the project?
    • How to run the simulation?
    • How to analyze the project?
      • What kind of results exist?
      • What programs/tools to use for further analysis?
  • PluginHKESim
    • How to install?
      • Step by step
      • Test install
    • Structure of the plugin
    • How to create a project?
    • How to load an IFC file?
    • How to configure my project?
      • Simulation settings
      • Configuration file
      • Default tasks
      • Additional templates
    • How to run the project?
    • How to run the simulation?
    • How to analyze the project?
      • What kind of results exist?
      • What programs/tools to use for further analysis?
  • PluginLCA
    • How to install?
      • Step by step
      • Test install
    • Structure of the plugin
    • How to create a project?
    • How to load an IFC file?
    • How to configure my project?
      • Simulation settings
      • Configuration file
      • Default tasks
      • Additional templates
    • How to run the project?
    • How to run the simulation?
    • How to analyze the project?
      • What kind of results exist?
      • What programs/tools to use for further analysis?
  • PluginCFD
    • Structure of the plugin
• Simulation-Guide
  • Simulation Types
    • Building Performance Simulation (BPS)
      • Reasons to perform a BPS
      • Requirements for BPS in bim2sim
      • IFC Requirements
    • Heating Ventilation and Air Conditioning (HVAC) Simulation
      • Hydraulic Network
      • Generation Devices & Consumers
      • Control Logic
• Advanced User-Guide
  • Concepts
    • Project
      • Functionality
    • Simulation settings
      • What are simulation settings?
      • How do settings work?
      • How to set simulation settings?
      • Want to set up your own workflow?
      • List of current simulation settings:
        • BaseSimSettings
        • PlantSimSettings
        • BuildingSimSettings
        • TEASERSimSettings
        • EnergyPlusSimSettings
        • CFDSimSettings
        • LCAExportSettings
        • ComfortSimSettings
    • Domains
    • Playground
    • Plugins
    • Tasks
      • What are Tasks for?
      • How are Tasks managed? The Playground
      • Special variables for Tasks
      • Writing your own Task
    • Elements
      • Functionality
      • Mapping
        • 1:many Mapping
        • many:1 Mapping
      • Element Types
    • Attributes
      • Which problem is addressed by attributes?
      • Concept / How does it work?
      • How are the attributes managed?
    • Finder
      • What does the finder?
      • I have my own tool, or I’m aware of more typical storage points, what to do?
    • Aggregations
      • What are aggregations used for?
      • How are aggregations implemented?
        • Find Matches
        • Get Edge Ports
        • Replacement
        • Merge graph
      • Improvements
      • What aggregations exist currently:
    • Decisions
    • Yielding
    • Logging
      • User logging
      • Developer logging
      • IFC Quality logging
  • Project File Structure
  • Writing your own bim2sim Plugin
    • Basics
    • Use a custom Plugin
      • Let bim2sim find your Plugin
      • Use in script
• Developer-Guide
  • How to Contribute?
    • What do I have to do, when I want to use bim2sim for other simulation tools?
      • Which files/functions needs to be adapted/created?
      • What is stored in tasks?
      • What is stored in projects?
      • What is stored in plugins?
      • What is stored in playgrounds?
  • Testing
    • Unit Testing
    • Integration Testing
    • Regression Testing
    • Run Tests Local
    • CI/CD
  • Docker image structure
  • Utilities for documentation
    • Visualization of bim2sim plugin structure
    • Run Sphinx local
      • Troubleshooting
        • Warning: import failures - No module named XXXX
        • Problems with code documentation

bim2sim code

• bim2sim
  • bim2sim package
    • run_project()
    • Subpackages
      • bim2sim.elements package
        • Subpackages
        • Submodules
        • bim2sim.elements.base_elements module
        • bim2sim.elements.bps_elements module
        • bim2sim.elements.hvac_elements module
      • bim2sim.examples package
        • Submodules
        • bim2sim.examples.e1_template_plugin module
        • bim2sim.examples.e2_interactive_project module
      • bim2sim.export package
        • Subpackages
      • bim2sim.kernel package
        • IFCDomainError
        • Subpackages
        • Submodules
        • bim2sim.kernel.decorators module
        • bim2sim.kernel.ifc_file module
        • bim2sim.kernel.log module
      • bim2sim.plugins package
        • Plugin
        • PluginBPSBase
        • add_plugins_to_path()
        • available_plugins()
        • get_plugin()
        • load_plugin()
        • Subpackages
      • bim2sim.tasks package
        • Subpackages
        • Submodules
        • bim2sim.tasks.base module
      • bim2sim.utilities package
        • Submodules
        • bim2sim.utilities.check_docstrings module
        • bim2sim.utilities.common_functions module
        • bim2sim.utilities.pyocc_tools module
        • bim2sim.utilities.svg_utils module
        • bim2sim.utilities.test module
        • bim2sim.utilities.types module
        • bim2sim.utilities.visualize_spaces module
    • 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
        • Project.config
        • Project.create()
        • Project.delete()
        • Project.finalize()
        • Project.formatter
        • Project.is_active()
        • Project.is_project_folder()
        • Project.reset()
        • Project.rewrite_config()
        • Project.run()
        • Project.set_user_logging_handler()
      • add_config_section()
      • config_base_setup()
      • open_config()
    • bim2sim.sim_settings module
      • AutoSettingNameMeta
      • BaseSimSettings
        • BaseSimSettings.add_space_boundaries
        • 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.update_from_config()
        • BaseSimSettings.weather_file_path
      • BooleanSetting
        • BooleanSetting.check_value()
      • BuildingSimSettings
        • BuildingSimSettings.add_shadings
        • BuildingSimSettings.add_space_boundaries
        • BuildingSimSettings.close_space_boundary_gaps
        • BuildingSimSettings.construction_class_walls
        • BuildingSimSettings.construction_class_windows
        • BuildingSimSettings.cooling
        • BuildingSimSettings.correct_space_boundaries
        • BuildingSimSettings.create_plots
        • BuildingSimSettings.deactivate_ahu
        • BuildingSimSettings.fix_type_mismatches_with_sb
        • BuildingSimSettings.heating
        • 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.year_of_construction_overwrite
      • ChoiceSetting
        • ChoiceSetting.check_setting_config()
        • ChoiceSetting.check_value()
      • NumberSetting
        • NumberSetting.check_setting_config()
        • NumberSetting.check_value()
      • PathSetting
        • PathSetting.check_value()
      • PlantSimSettings
        • PlantSimSettings.aggregations
        • PlantSimSettings.tolerance_connect_by_position
      • Setting
        • Setting.check_setting_config()
        • Setting.check_value()
        • Setting.initialize()
        • Setting.load_default()
      • SettingsManager
        • SettingsManager.names

documentation utilities

Indices and tables

• Index

• Module Index

• Search Page