honeybee_radiance_postprocess.dynamic module

Post-processing classes for dynamic schedules.

class honeybee_radiance_postprocess.dynamic.ApertureGroupSchedule(identifier, schedule, is_static=None)[source]

Bases: object

ApertureGroupSchedule.

This class contains the dynamic states schedule of a single ApertureGroup.

Parameters

  • identifier – Identifier of the ApertureGroup.

  • schedule – A list or tuple of integer values.

Properties:

  • identifier

  • schedule

  • is_static

ToString()[source]

Overwrite .NET ToString.

classmethod from_dict(data)[source]

Initialize a ApertureGroupSchedule from a dictionary.

Parameters

data – A dictionary representation of an ApertureGroupSchedule object.

to_dict()[source]

Return ApertureGroupSchedule as a dictionary.

property identifier

Return identifier.

property is_static

Return True if schedule is static.

property schedule

Return ApertureGroup schedule.

class honeybee_radiance_postprocess.dynamic.DynamicSchedule(dynamic_schedule=None)[source]

Bases: object

DynamicSchedule.

This class contains a single property (dynamic_schedule). This property is a dictionary where keys are ApertureGroup identifiers and the value for each key is the dynamic schedule for the ApertureGroup.

Parameters

dynamic_schedule – A dictionary of ApertureGroup identifier and schedules.

Properties:

  • dynamic_schedule

ToString()[source]

Overwrite .NET ToString.

add_aperture_group_schedule(aperture_group_schedule)[source]

Add an ApertureGroupSchedule to the DynamicSchedule instance.

Parameters

aperture_group_schedule – An ApertureGroupSchedule object.

duplicate()[source]

Get a copy of this object.

filter_by_identifiers(identifiers)[source]

Filter the DynamicSchedule by identifiers.

This method returns a filtered DynamicSchedule object.

Parameters

identifiers – A list of identifiers.

Returns

A filtered DynamicSchedule object.

classmethod from_dict(data)[source]

Initialize a DynamicSchedule from a dictionary.

Parameters

data – A dictionary representation of a DynamicSchedule objects.

classmethod from_group_schedules(group_schedules)[source]

Initialize a DynamicSchedule from a list of ApertureGroupSchedules.

The method will automatically sense if there are duplicated groups in the list and ensure the group schedule only appears once.

Parameters

data – A dictionary representation of a DynamicSchedule objects.

classmethod from_json(json_file)[source]

Initialize a DynamicSchedule from a JSON file.

Parameters

json_file – Path to JSON file.

to_dict(simplified=False)[source]

Return DynamicSchedule as a dictionary.

to_json(folder=None, file_name=None, indent=None, simplified=False)[source]

Write a DynamicSchedule to JSON.

Parameters

  • folder – A text string for the directory where the JSON file will be written. If unspecified, the default simulation folder will be used. This is usually at “C:UsersUSERNAMEsimulation.”

  • file_name – _description_. Defaults to None.

  • indent – A positive integer to set the indentation used in the resulting JSON file. (Default: None).

Returns

Path to JSON file.

Return type

json_file

property dynamic_schedule

Return dynamic schedule as a dictionary.