honeybee_openstudio.simulation module¶
Methods to write Honeybee-energy SimulationParameters to OpenStudio.
- honeybee_openstudio.simulation.assign_epw_to_model(epw_file, os_model, set_climate_zone=False)[source]¶
Assign an EPW file to an OpenStudio Model.
- Parameters:
epw_file – Path to an EPW file to be assigned to the OpenStudio Model.
os_model – The OpenStudio Model object to which the EPW will be assigned.
set_climate_zone – A boolean to note whether the EPW file should be used to set the OpenStudio Model’s ASHRAE climate zone if it has not already been specified.
- honeybee_openstudio.simulation.design_day_to_openstudio(design_day, os_model)[source]¶
Convert Ladybug DesignDay to OpenStudio DesignDay.
- Parameters:
design_day – A Ladybug DesignDay to be translated to OpenStudio.
os_model – The OpenStudio Model object.
- honeybee_openstudio.simulation.run_period_to_openstudio(run_period, os_model)[source]¶
Convert Honeybee RunPeriod to OpenStudio RunPeriod.
- Parameters:
run_period – A Honeybee-energy RunPeriod to be translated to OpenStudio.
os_model – The OpenStudio Model object.
- honeybee_openstudio.simulation.shadow_calculation_to_openstudio(shadow_calc, os_model)[source]¶
Convert Honeybee ShadowCalculation to OpenStudio ShadowCalculation.
- Parameters:
shadow_calc – A Honeybee-energy ShadowCalculation to be translated to OpenStudio.
os_model – The OpenStudio Model object.
- honeybee_openstudio.simulation.simulation_control_to_openstudio(control, os_model)[source]¶
Convert Honeybee SimulationControl to OpenStudio SimulationControl.
- Parameters:
control – A Honeybee-energy SimulationControl to be translated to OpenStudio.
os_model – The OpenStudio Model object.
- honeybee_openstudio.simulation.simulation_output_to_openstudio(sim_output, os_model)[source]¶
Convert Honeybee SimulationOutput to a list of OpenStudio OutputVariables.
- Parameters:
sim_output – A Honeybee-energy SimulationOutput to be translated to OpenStudio.
os_model – The OpenStudio Model object.
- honeybee_openstudio.simulation.simulation_parameter_to_openstudio(sim_par, seed_model=None)[source]¶
Convert Honeybee SimulationParameter to an OpenStudio model.
- Parameters:
sim_par – A Honeybee-energy SimulationParameter to be translated to OpenStudio.
seed_model – An optional OpenStudio Model object to which the Honeybee Model will be added. If None, a new OpenStudio Model will be initialized within this method. (Default: None).