bim2sim.plugins.PluginComfort.bim2sim_comfort package

EnergyPlus plugin for bim2sim

Holds logic to run a simulation based on prepared ifc data

class bim2sim.plugins.PluginComfort.bim2sim_comfort.PluginComfort

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.PluginComfort.bim2sim_comfort.task.ep_comfort_settings.ComfortSettings'>, <class 'bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task.ep_idf_cfd_export.ExportIdfForCfd'>, <class 'bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task.ep_run_simulation.RunEnergyPlusSimulation'>, <class 'bim2sim.tasks.common.serialize_elements.SerializeElements'>, <class 'bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task.create_result_df.CreateResultDF'>, <class 'bim2sim.plugins.PluginComfort.bim2sim_comfort.task.create_result_df.CreateResultDF'>, <class 'bim2sim.plugins.PluginComfort.bim2sim_comfort.task.plot_comfort_results.PlotComfortResults'>]

elements: set = {<class 'bim2sim.elements.base_elements.Material'>, <class 'bim2sim.elements.bps_elements.Door'>, <class 'bim2sim.elements.bps_elements.Wall'>, <class 'bim2sim.elements.bps_elements.Site'>, <class 'bim2sim.elements.bps_elements.LayerSet'>, <class 'bim2sim.elements.bps_elements.Storey'>, <class 'bim2sim.elements.bps_elements.Slab'>, <class 'bim2sim.elements.bps_elements.ExternalSpatialElement'>, <class 'bim2sim.elements.bps_elements.Window'>, <class 'bim2sim.elements.bps_elements.BPSProductWithLayers'>, <class 'bim2sim.elements.bps_elements.GroundFloor'>, <class 'bim2sim.elements.bps_elements.OuterDoor'>, <class 'bim2sim.elements.bps_elements.InnerWall'>, <class 'bim2sim.elements.bps_elements.ThermalZone'>, <class 'bim2sim.elements.bps_elements.InnerFloor'>, <class 'bim2sim.elements.bps_elements.Building'>, <class 'bim2sim.elements.bps_elements.InnerDoor'>, <class 'bim2sim.elements.bps_elements.Layer'>, <class 'bim2sim.elements.bps_elements.OuterWall'>, <class 'bim2sim.elements.bps_elements.Roof'>}

name: str = 'Comfort'

sim_settings

alias of ComfortSimSettings

Subpackages

• bim2sim.plugins.PluginComfort.bim2sim_comfort.examples package
  • Submodules
  • bim2sim.plugins.PluginComfort.bim2sim_comfort.examples.e1_simple_project_comfort_energyplus module
    • run_example_1()
  • bim2sim.plugins.PluginComfort.bim2sim_comfort.examples.e3_load_comfort_simulation_results module
    • run_example_load_existing_project()
• bim2sim.plugins.PluginComfort.bim2sim_comfort.task package
  • Submodules
  • bim2sim.plugins.PluginComfort.bim2sim_comfort.task.create_result_df module
    • CreateResultDF
      • CreateResultDF.format_dataframe()
      • CreateResultDF.reads
      • CreateResultDF.run()
      • CreateResultDF.touches
  • bim2sim.plugins.PluginComfort.bim2sim_comfort.task.ep_comfort_settings module
    • ComfortSettings
      • ComfortSettings.add_comfort_to_people_enrichment()
      • ComfortSettings.add_comfort_to_people_manual()
      • ComfortSettings.add_comfort_variables()
      • ComfortSettings.define_comfort_usage_dict()
      • ComfortSettings.reads
      • ComfortSettings.remove_duplicate_names()
      • ComfortSettings.remove_empty_zones()
      • ComfortSettings.run()
      • ComfortSettings.set_day_week_year_limit_schedule()
      • ComfortSettings.touches
  • bim2sim.plugins.PluginComfort.bim2sim_comfort.task.ep_comfort_visualization module
    • ComfortVisualization
      • ComfortVisualization.reads
      • ComfortVisualization.run()
      • ComfortVisualization.visualize_calendar()
      • ComfortVisualization.visualize_comfort()
  • bim2sim.plugins.PluginComfort.bim2sim_comfort.task.ep_load_idf module
    • LoadIdf
      • LoadIdf.run()
      • LoadIdf.touches
  • bim2sim.plugins.PluginComfort.bim2sim_comfort.task.plot_comfort_results module
    • PlotComfortResults
      • PlotComfortResults.apply_en16798_to_all_zones()
      • PlotComfortResults.apply_en16798_to_single_zone()
      • PlotComfortResults.final
      • PlotComfortResults.plot_new_en16798_adaptive_count()
      • PlotComfortResults.pmv_plot()
      • PlotComfortResults.reads
      • PlotComfortResults.rename_duplicates()
      • PlotComfortResults.rename_zone_usage()
      • PlotComfortResults.run()
      • PlotComfortResults.table_bar_plot_16798()
      • PlotComfortResults.visualize_calendar()
• bim2sim.plugins.PluginComfort.bim2sim_comfort.utils package
  • Submodules
  • bim2sim.plugins.PluginComfort.bim2sim_comfort.utils.utils_comfort_templates module

Submodules

bim2sim.plugins.PluginComfort.bim2sim_comfort.sim_settings module

class bim2sim.plugins.PluginComfort.bim2sim_comfort.sim_settings.ComfortSimSettings

Bases: EnergyPlusSimSettings

prj_use_conditions

rename_plot_keys

rename_plot_keys_path

use_dynamic_clothing