honeybee_plus.schedule module

Honeybee schedule.

Use this class to create schecules.

class honeybee_plus.schedule.Schedule(values, hoys=None)[source]

Bases: object

Schedule.

values

Schedule values.

hoys

List of hours of the year for this values.

ToString()[source]

Overwrite .NET ToString.

classmethod eight_am_to_six_pm()[source]

An 8am to 6pm schedule for IES-LM-83-12 requirements.

This schedule includes 10 hours per day from 8am to 6pm.

classmethod from_analysis_period(occ_period=None, off_hours=None, weekend=None, default_value=None)[source]

Create a schedule from Ladybug’s AnalysisPeriod.

Parameters

  • occ_period – An analysis period for occupancy. Default is (8, 17).

  • off_hours – A list of hours that building is unoccupied during the occupancy period everyday (e.g. lunch break). Default is an hour lunch break at (12, 13). Use -1 for no break during the day.

  • weekend – A list of numbers to indicate the weekend days. [0] None, [1-7] MON to SUN. Default is 6, 7 (SAT, SUN).

  • default_value – Default value for occupancy hours (Default: 1).

classmethod from_workday_hours(occ_hours=None, off_hours=None, weekend=None, default_value=None)[source]

Create a schedule from Ladybug’s AnalysisPeriod.

Parameters

  • occ_hours – Start and end hour of work day as a tuple. Default is (8, 17).

  • off_hours – A list of hours that building is unoccupied during the occupancy period everyday (e.g. lunch break). Default is an hour lunch break at (12, 13). Use -1 for no break during the day.

  • weekend – A list of numbers to indicate the weekend days. [0] None, [1-7] MON to SUN. Default is 6, 7 (SAT, SUN).

  • default_value – Default value for occupancy hours (Default: 1).

property hours

Tuple of values in this schedule.

property occupied_hours

Occupied hours of the year as a set.

property values

Tuple of values in this schedule.

write(file_path)[source]

Write the schedule to a csv file.