honeybee_radiance_postprocess.annual module

Shared functions for post-processing annual results.

honeybee_radiance_postprocess.annual.occupancy_schedule_8_to_6(timestep: int = 1, as_list: bool = False) → ndarray | list

Create an occupancy schedule for LEED (8 am to 6 pm).

Parameters:

• timestep – An integer value noting the number of timesteps per hour. Defaults to 1.

• as_list – Boolean toggle to output the schedule as a Python list instead of a NumPy array. Defaults to False.

Returns:

A schedule as an array or list.

honeybee_radiance_postprocess.annual.schedule_to_hoys(schedule: list | ndarray, sun_up_hours: list | ndarray = None, as_list: bool = False) → ndarray | list

Convert a schedule to hoys.

Parameters:

• schedule – A list of 8760 values for the occupancy schedule.

• sun_up_hours – An optional list of sun up hours as integers. If sun up hours are provided the function will exclude all values from the schedule that are not among the sun up hours. Defaults to None.

• as_list – Boolean toggle to output the schedule as a Python list instead of a NumPy array. Defaults to False.

Returns:

An array or list of occupancy expressed as hoys.