honeybee_ph_utils.occupancy module

Utility functions for working with Honeybee-Energy Occupancy Loads and Schedules

honeybee_ph_utils.occupancy.hb_room_annual_avg_occupancy(_hb_room: room.Room) → float[source]

Returns the annual average occupancy (# ppl) of a honeybee-Room.

Will return the ‘mean_occupancy’ if there is one on the Schedule. Otherwise will calculate the value.

Arguments:

  • _hb_room (room.Room): The honeyebee-Room to calculate values for.

Returns:

  • (float): The honeybee-Room’s average annual occupancy (total number of people).

honeybee_ph_utils.occupancy.hb_room_peak_occupancy(_hb_room: room.Room) → float[source]

Returns a peak occupancy (# ppl) of a honeybee-Room.

Not all honeybee rooms have an occupancy (stairs, etc..) and so if there is no energy.people found, will return 0.

Arguments:

  • _hb_room (honeybee.room.Room): The honeyebee-Room to calculate values for.

Returns:

  • (float): The honeybee-Room’s peak occupancy (total number of people)

honeybee_ph_utils.occupancy.hb_room_ppl_per_area(_hb_room: room.Room) → float[source]

Returns a honeybee-Room’s occupancy load (people_per_area).

Note all honeybee-Rooms have an occupancy (stairs, etc) and so if there is no energy.pepple found, will return 0

Arguments:

  • _hb_room (honeybee.room.Room): The honeyebee-Room to get the value for.

Returns:

  • (float): The honeybee-Room’s occupancy load (people_per_area)