bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus package

EnergyPlus plugin for bim2sim

Holds logic to run a simulation based on prepared ifc data

class bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.PluginEnergyPlus

Bases: Plugin

default_tasks: List[Type[ITask]] = [<class 'bim2sim.tasks.common.load_ifc.LoadIFC'>, <class 'bim2sim.tasks.common.check_ifc.CheckIfc'>, <class 'bim2sim.tasks.common.create_elements.CreateElementsOnIfcTypes'>, <class 'bim2sim.tasks.bps.sb_creation.CreateSpaceBoundaries'>, <class 'bim2sim.tasks.bps.sb_2b_generation.AddSpaceBoundaries2B'>, <class 'bim2sim.tasks.bps.sb_correction.CorrectSpaceBoundaries'>, <class 'bim2sim.tasks.common.create_relations.CreateRelations'>, <class 'bim2sim.tasks.bps.disaggr_creation.DisaggregationCreationAndTypeCheck'>, <class 'bim2sim.tasks.bps.enrich_material.EnrichMaterial'>, <class 'bim2sim.tasks.bps.enrich_use_cond.EnrichUseConditions'>, <class 'bim2sim.tasks.common.weather.Weather'>, <class 'bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task.ep_create_idf.CreateIdf'>, <class 'bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task.ep_idf_postprocessing.IdfPostprocessing'>, <class 'bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task.ep_idf_cfd_export.ExportIdfForCfd'>, <class 'bim2sim.tasks.common.serialize_elements.SerializeElements'>, <class 'bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task.ep_run_simulation.RunEnergyPlusSimulation'>, <class 'bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task.create_result_df.CreateResultDF'>, <class 'bim2sim.tasks.bps.plot_results.PlotBEPSResults'>]

name: str = 'EnergyPlus'

sim_settings

alias of EnergyPlusSimSettings

Subpackages

• bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.examples package
  • Submodules
  • bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.examples.e1_simple_project_energyplus module
    • run_example_1()
  • bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.examples.e2_complex_project_energyplus module
    • run_example_complex_building_energyplus()
  • bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.examples.e3_load_energyplus_simulation_results module
  • bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.examples.e4_simple_rotated_project_energyplus module
    • run_example_4()
• bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task package
  • Submodules
  • bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task.create_result_df module
    • CreateResultDF
      • CreateResultDF.format_dataframe()
      • CreateResultDF.map_zonal_results()
      • CreateResultDF.oriented_surface_names()
      • CreateResultDF.reads
      • CreateResultDF.run()
      • CreateResultDF.select_wanted_results()
      • CreateResultDF.touches
  • bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task.ep_create_idf module
    • CreateIdf
      • CreateIdf.add_shading_control()
      • CreateIdf.add_shadings()
      • CreateIdf.apply_system_sizing()
      • CreateIdf.check_preprocessed_materials_and_constructions()
      • CreateIdf.export_geom_to_idf()
      • CreateIdf.get_preprocessed_materials_and_constructions()
      • CreateIdf.idf_validity_check()
      • CreateIdf.init_idf()
      • CreateIdf.init_zone()
      • CreateIdf.init_zonegroups()
      • CreateIdf.init_zonelist()
      • CreateIdf.reads
      • CreateIdf.run()
      • CreateIdf.set_day_hvac_template()
      • CreateIdf.set_day_week_year_schedule()
      • CreateIdf.set_equipment()
      • CreateIdf.set_ground_temperature()
      • CreateIdf.set_heating_and_cooling()
      • CreateIdf.set_hvac_template()
      • CreateIdf.set_infiltration()
      • CreateIdf.set_lights()
      • CreateIdf.set_natural_ventilation()
      • CreateIdf.set_output_variables()
      • CreateIdf.set_people()
      • CreateIdf.set_preprocessed_construction_elem()
      • CreateIdf.set_preprocessed_material_elem()
      • CreateIdf.set_preprocessed_window_material_elem()
      • CreateIdf.set_simulation_control()
      • CreateIdf.touches
      • CreateIdf.write_schedule()
    • IdfObject
      • IdfObject.get_circular_shape()
      • IdfObject.map_boundary_conditions()
      • IdfObject.map_surface_types()
      • IdfObject.process_circular_shapes()
      • IdfObject.process_other_shapes()
      • IdfObject.set_construction_name()
      • IdfObject.set_idfobject_attributes()
      • IdfObject.set_idfobject_coordinates()
      • IdfObject.set_preprocessed_construction_name()
  • bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task.ep_idf_cfd_export module
    • ExportIdfForCfd
      • ExportIdfForCfd.combine_space_stl_files()
      • ExportIdfForCfd.combine_stl_files()
      • ExportIdfForCfd.combined_space_stl()
      • ExportIdfForCfd.export_2b_bounds_to_stl()
      • ExportIdfForCfd.export_bounds_per_space_to_stl()
      • ExportIdfForCfd.export_bounds_to_stl()
      • ExportIdfForCfd.export_single_bound_to_stl()
      • ExportIdfForCfd.export_space_bound_list()
      • ExportIdfForCfd.reads
      • ExportIdfForCfd.run()
      • ExportIdfForCfd.write_triang_face()
  • bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task.ep_idf_postprocessing module
    • IdfPostprocessing
      • IdfPostprocessing.reads
      • IdfPostprocessing.run()
      • IdfPostprocessing.write_zone_names()
  • bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task.ep_ifc_validation module
    • IfcValidation
      • IfcValidation.reads
      • IfcValidation.run()
    • SpaceBoundaryValidation
  • bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task.ep_run_simulation module
    • RunEnergyPlusSimulation
      • RunEnergyPlusSimulation.reads
      • RunEnergyPlusSimulation.run()
  • bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task.ep_visualize_results module
    • VisualizeResults
      • VisualizeResults.reads
      • VisualizeResults.run()
  • bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task.load_energyplus_results module
    • LoadEnergyPlusResults
      • LoadEnergyPlusResults.run()
      • LoadEnergyPlusResults.touches
• bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.utils package
  • Submodules
  • bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.utils.utils_postprocessing module
    • PostprocessingUtils
      • PostprocessingUtils.azimuth_orientations
      • PostprocessingUtils.export_df_for_webtool()
      • PostprocessingUtils.read_csv_and_format_datetime()
      • PostprocessingUtils.shift_dataframe_to_midnight()
      • PostprocessingUtils.true_azimuth()
  • bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.utils.utils_visualization module
    • VisualizationUtils
      • VisualizationUtils.add_legend()
      • VisualizationUtils.display_occ_shapes()
      • VisualizationUtils.get_column_from_ep_results()
      • VisualizationUtils.interpolate_to_rgb()
      • VisualizationUtils.rgb()
      • VisualizationUtils.rgb_color()
      • VisualizationUtils.visualize_zones()

Submodules

bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.sim_settings module

class bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.sim_settings.EnergyPlusSimSettings

Bases: BuildingSimSettings

Defines simulation settings for EnergyPlus Plugin.

This class defines the simulation settings for the EnergyPlus Plugin. It inherits all choices from the BuildingSimulation settings. EnergyPlus specific settings are added here, such as simulation control parameters and export settings.

add_natural_ventilation

add_shadings

add_window_shading

cfd_export

close_space_boundary_gaps

control_operative_temperature

correct_space_boundaries

enforce_system_sizing

ep_install_path

ep_version

heat_recovery_latent

heat_recovery_sensible

heat_recovery_type

hvac_off_at_night

natural_ventilation_approach

outdoor_air_economizer

outdoor_air_per_area

outdoor_air_per_person

output_format

output_keys

residential

run_for_sizing_periods

run_for_weather_period

run_full_simulation

solar_distribution

split_bounds

split_shadings

system_sizing

system_weather_sizing

unit_conversion

ventilation_demand_control

weather_file_for_sizing