honeybee_openstudio.schedule module

Utilities to convert schedule dictionaries to Python objects.

honeybee_openstudio.schedule.extract_all_schedules(os_model)

Extract all schedule objects from an OpenStudio Model.

Parameters:

os_model – The OpenStudio Model object from which schedules will be extracted.

Returns:

A dictionary of schedule objects with schedule identifiers as keys and schedule objects as values.

honeybee_openstudio.schedule.schedule_day_from_openstudio(os_day_schedule)

Convert OpenStudio ScheduleDay to Honeybee ScheduleDay.

honeybee_openstudio.schedule.schedule_day_to_openstudio(schedule_day, os_model)

Convert Honeybee ScheduleDay to OpenStudio ScheduleDay.

honeybee_openstudio.schedule.schedule_fixed_interval_from_openstudio(os_schedule, type_limits=None, is_leap_year=False)

Convert OpenStudio ScheduleFixedInterval to Honeybee ScheduleFixedInterval.

honeybee_openstudio.schedule.schedule_fixed_interval_to_openstudio(schedule, os_model)

Convert Honeybee ScheduleFixedInterval to OpenStudio ScheduleFixedInterval.

honeybee_openstudio.schedule.schedule_fixed_interval_to_openstudio_file(schedule, os_model, schedule_directory, include_datetimes=False)

Convert Honeybee ScheduleFixedInterval to OpenStudio ScheduleFile.

Parameters:

• schedule – The Honeybee ScheduleFixedInterval to be converted.

• os_model – The OpenStudio Model to which the ScheduleFile will be added.

• schedule_directory – Text string of a path to a folder on this machine to which the CSV version of the file will be written.

• include_datetimes – Boolean to note whether a column of datetime objects should be written into the CSV alongside the data. Default is False, which will keep the resulting CSV lighter in file size but you may want to include such datetimes in order to verify that values align with the expected timestep. Note that the included datetimes will follow the EnergyPlus interpretation of aligning values to timesteps in which case the timestep to which the value is matched means that the value was utilized over all of the previous timestep.

honeybee_openstudio.schedule.schedule_ruleset_from_openstudio(os_schedule, type_limits=None)

Convert OpenStudio ScheduleRuleset to Honeybee ScheduleRuleset.

honeybee_openstudio.schedule.schedule_ruleset_to_openstudio(schedule, os_model)

Convert Honeybee ScheduleRuleset to OpenStudio ScheduleRuleset.

honeybee_openstudio.schedule.schedule_to_openstudio(schedule, os_model, schedule_directory=None)

Convert any Honeybee energy material into an OpenStudio object.

Parameters:

• material – A honeybee-energy Python object of a material layer.

• os_model – The OpenStudio Model object to which the Room will be added.

• schedule_directory – An optional directory to be used to write Honeybee ScheduleFixedInterval objects to OpenStudio ScheduleFile objects instead of OpenStudio ScheduleFixedInterval, which translates to EnergyPlus Compact schedules.

Returns:

An OpenStudio object for the material.

honeybee_openstudio.schedule.schedule_type_limits_from_openstudio(os_type_limit)

Convert OpenStudio ScheduleTypeLimits to Honeybee ScheduleTypeLimit.

honeybee_openstudio.schedule.schedule_type_limits_to_openstudio(type_limit, os_model)

Convert Honeybee ScheduleTypeLimit to OpenStudio ScheduleTypeLimits.