honeybee_plus.radiance.resultcollection.timeseries module

Result collection for daylight studies with several hours.

Use this PointInTime result grid to load the results from database for daylight factor, vertical sky component, and point-in-time illuminance or radiation studies.

class honeybee_plus.radiance.resultcollection.timeseries.TimeSeries(db_file, grid_id=0, recipe_id=200000)

Bases: honeybee_plus.radiance.resultcollection.resultgrid.ResultGrid

annual_sunlight_exposure(threshold=1000, sids_hourly=None, occ_hours=None, target_hours=None)

Annual Solar Exposure (ASE).

Calculate number of hours that this point is exposed to more than 1000lux of direct sunlight. The point meets the traget in the number of hours is less than 250 hours per year.

Parameters

• threshold – threshold for daylight autonomy in lux (default: 1000).

• blinds_state_ids – List of state ids for all the sources for input hoys. If you want a source to be removed set the state to -1. ase must be calculated without dynamic blinds but you can use this option to study the effect of different blind states.

• occ_schedule – An annual occupancy schedule.

• target_hours – Target minimum hours (default: 250).

Returns

Success as a Boolean, Number of hours, Problematic hours

blind_schedule_based_on_ase(threshold=1000, target_percentage=2, occ_hours=None, sid_combinations=None)

daylight_autonomy(threshold=300, occ_hours=None, sids_hourly=None)

Calculate daylight autonomy and continious daylight autonomy.

Parameters

• da_threshold – threshold for daylight autonomy in lux (default: 300).

• blinds_state_ids – List of state ids for all the sources for input hoys. If you want a source to be removed set the state to -1.

• occ_schedule – An annual occupancy schedule.

Returns

Daylight autonomy

property hoys

Return hours of the year for results.

For point-in-time result grid this will be a tuple with a single item.

property moys

Return minutes of the year.

For point-in-time result grid this will be a tuple with a single item.

percentage_area_more_than(threshold=1000, direct=True)

property recipe_id

Recipe type id for this result grid.

spatial_daylight_autonomy()

useful_daylight_illuminance(udi_min_max=None, occ_hours=None, sids_hourly=None)

Calculate useful daylight illuminance.

Parameters

• udi_min_max – A tuple of min, max value for useful daylight illuminance (default: (100, 2000)).

• blinds_state_ids – List of state ids for all the sources for input hoys. If you want a source to be removed set the state to -1.

• occ_schedule – An annual occupancy schedule.

Returns

Useful daylight illuminance, Less than UDI, More than UDI

values(hoys=None, sids_hourly=None, group_by=0, direct=False)

Get values for several hours from all sources based on state_id.

Parameters

• hoy – hour of the year.

• sids_hourly – List of state ids for all the sources for an hour. If you want a source to be removed set the state to -1. By default states will be set to 0 for all the sources during all the hours of the year.

• group_by – 0-1. Use group_by to switch how values will be grouped. By default results will be grouped for each sensor. in this case the first item in results will be a list of values for the first sensor during hoys. If set to 1 the results will be grouped by timestep. In this case the first item will be list of values for all the sensors at the first timestep. This mode is useful to load all the hourly results for points at a certian hour to calculate values for the whole grid. A good example is calculating % area which receives more than 2000 lux at every hour during the year.

• direct – Set to True for direct values instead of total values. If direct values are not available an exption will raise (default: False).

Returns

A tuple of values grouped based on group_by input.

values_cumulative(hoys=None, sids_hourly=None, group_by=0, direct=False)

Get cumulative value for several hours from all sources based on state_id.

Parameters

• hoy – hour of the year.

• sids_hourly – List of state ids for all the sources for an hour. If you want a source to be removed set the state to -1. By default states will be set to 0 for all the sources during all the hours of the year.

• group_by – 0-1. Use group_by to switch how values will be grouped. By default results will be grouped for each sensor. in this case the first item in results will be a list of values for the first sensor during hoys. If set to 1 the results will be grouped by timestep. In this case the first item will be list of values for all the sensors at the first timestep. This mode is useful to load all the hourly results for points at a certian hour to calculate values for the whole grid. A good example is calculating % area which receives more than 2000 lux at every hour during the year.

• direct – Set to True for direct values instead of total values. If direct values are not available an exption will raise (default: False).

Returns

A tuple of cumulative values grouped based on group_by input.

values_hourly(hoy, sids=0)

Get values for an hour of the year.

Parameters

• hoy – Hour of the year.

• sid – Unique id for source at a certain state. Default is set to 0 for sky contribution. Use source_id method to get the id if you don’t know the correct id value.

Returns

A tuple for hourly values for this grid.

values_max(hoys=None, sids_hourly=None, group_by=0, direct=False)

Get maximum value for several hours from all sources based on state_id.

Parameters

• hoy – hour of the year.

• sids_hourly – List of state ids for all the sources for an hour. If you want a source to be removed set the state to -1. By default states will be set to 0 for all the sources during all the hours of the year.

• group_by – 0-1. Use group_by to switch how values will be grouped. By default results will be grouped for each sensor. in this case the first item in results will be a list of values for the first sensor during hoys. If set to 1 the results will be grouped by timestep. In this case the first item will be list of values for all the sensors at the first timestep. This mode is useful to load all the hourly results for points at a certian hour to calculate values for the whole grid. A good example is calculating % area which receives more than 2000 lux at every hour during the year.

• direct – Set to True for direct values instead of total values. If direct values are not available an exption will raise (default: False).

Returns

A tuple of maximum values grouped based on group_by input.

values_min(hoys=None, sids_hourly=None, group_by=0, direct=False)

Get minimum value for several hours from all sources based on state_id.

Parameters

• hoy – hour of the year.

• sids_hourly – List of state ids for all the sources for an hour. If you want a source to be removed set the state to -1. By default states will be set to 0 for all the sources during all the hours of the year.

• group_by – 0-1. Use group_by to switch how values will be grouped. By default results will be grouped for each sensor. in this case the first item in results will be a list of values for the first sensor during hoys. If set to 1 the results will be grouped by timestep. In this case the first item will be list of values for all the sensors at the first timestep. This mode is useful to load all the hourly results for points at a certian hour to calculate values for the whole grid. A good example is calculating % area which receives more than 2000 lux at every hour during the year.

• direct – Set to True for direct values instead of total values. If direct values are not available an exption will raise (default: False).

Returns

A tuple of minimum values grouped based on group_by input.