honeybee_energy.cli.lib module¶

honeybee energy standards library commands.

honeybee_energy.cli.lib.construction_sets(climate_zone=None, vintage=None, construction_type=None, keyword=None, join_words=False, json_objects=False, output_file=None, split_words=True, identifiers=True)[source]¶

Get a list of all construction sets in the standards library.

Parameters:

climate_zone – An optional integer between 0 and 8 for the ASHRAE climate zone for which construction sets will be filtered. This can include the letter associated with the zone (eg. 5A).
vintage – Optional text for the building vintage to filter the sets. Choose from: “2019”, “2016”, “2013”, “2010”, “2007”, “2004”, “1980_2004”, “pre_1980”.
construction_type – Optional text for the construction type to filter the sets. Choose from: “SteelFramed”, “WoodFramed”, “Mass”, “Metal Building”.
keyword – An optional keyword to be used to filter the output list of construction sets. This can also be a list of keywords which will collectively be used to filter the results. If None, all available construction sets will be output. (Default: None).
join_words – Boolean to note whether strings of multiple keywords (separated by spaces) are joined together or will be split into separate keywords for searching. This results in a greater likelihood of finding an item but is not desirable when searching for a specific word sequence. (Default: False).
json_objects – Boolean to note whether the output should be formatted as an array of JSON objects instead of a plain text list of the construction set identifiers currently in the library. (Default: False).
output_file – Optional file to output the full report of the validation. If None, the string will simply be returned from this method.

honeybee_energy.cli.lib.opaque_constructions(keyword=None, join_words=False, json_objects=False, output_file=None, split_words=True, identifiers=True)[source]¶

Get a list of all opaque constructions in the standards library.

Parameters:

keyword – An optional keyword to be used to filter the output list of constructions. This can also be a list of keywords which will collectively be used to filter the results. If None, all available constructions will be output. (Default: None).
join_words – Boolean to note whether strings of multiple keywords (separated by spaces) are joined together or will be split into separate keywords for searching. This results in a greater likelihood of finding an item but is not desirable when searching for a specific word sequence. (Default: False).
json_objects – Boolean to note whether the output should be formatted as an array of JSON objects instead of a plain text list of the construction identifiers currently in the library. (Default: False).
output_file – Optional file to output the full report of the validation. If None, the string will simply be returned from this method.

honeybee_energy.cli.lib.opaque_materials(keyword=None, join_words=False, json_objects=False, output_file=None, split_words=True, identifiers=True)[source]¶

Get a list of all opaque materials in the standards library.

Parameters:

keyword – An optional keyword to be used to filter the output list of materials. This can also be a list of keywords which will collectively be used to filter the results. If None, all available materials will be output. (Default: None).
join_words – Boolean to note whether strings of multiple keywords (separated by spaces) are joined together or will be split into separate keywords for searching. This results in a greater likelihood of finding an item but is not desirable when searching for a specific word sequence. (Default: False).
json_objects – Boolean to note whether the output should be formatted as an array of JSON objects instead of a plain text list of the material identifiers currently in the library. (Default: False).
output_file – Optional file to output the full report of the validation. If None, the string will simply be returned from this method.

honeybee_energy.cli.lib.program_types(building_type=None, vintage=None, keyword=None, join_words=False, json_objects=False, output_file=None, split_words=True, identifiers=True)[source]¶

Get a list of all construction sets in the standards library.

Parameters:

building_type – Optional text to filter the programs by building type (eg. “LargeOffice”, “MidriseApartment”, etc.).
vintage – Optional text for the building vintage to filter the programs. Choose from: “2019”, “2016”, “2013”, “2010”, “2007”, “2004”, “1980_2004”, “pre_1980”.
keyword – An optional keyword to be used to filter the output list of programs. This can also be a list of keywords which will collectively be used to filter the results. If None, all available programs will be output. (Default: None).
join_words – Boolean to note whether strings of multiple keywords (separated by spaces) are joined together or will be split into separate keywords for searching. This results in a greater likelihood of finding an item but is not desirable when searching for a specific word sequence. (Default: False).
json_objects – Boolean to note whether the output should be formatted as an array of JSON objects instead of a plain text list of the program identifiers currently in the library. (Default: False).
output_file – Optional file to output the full report of the validation. If None, the string will simply be returned from this method.

honeybee_energy.cli.lib.schedule_type_limits(keyword=None, join_words=False, json_objects=False, output_file=None, split_words=True, identifiers=True)[source]¶

Get a list of all schedule type limits in the standards library.

Parameters:

keyword – An optional keyword to be used to filter the output list of limits. This can also be a list of keywords which will collectively be used to filter the results. If None, all available limits will be output. (Default: None).
join_words – Boolean to note whether strings of multiple keywords (separated by spaces) are joined together or will be split into separate keywords for searching. This results in a greater likelihood of finding an item but is not desirable when searching for a specific word sequence. (Default: False).
json_objects – Boolean to note whether the output should be formatted as an array of JSON objects instead of a plain text list of the limit identifiers currently in the library. (Default: False).
output_file – Optional file to output the full report of the validation. If None, the string will simply be returned from this method.

honeybee_energy.cli.lib.schedules(keyword=None, join_words=False, json_objects=False, output_file=None, split_words=True, identifiers=True)[source]¶

Get a list of all schedules in the standards library.

Parameters:

keyword – An optional keyword to be used to filter the output list of schedules. This can also be a list of keywords which will collectively be used to filter the results. If None, all available limits will be output. (Default: None).
join_words – Boolean to note whether strings of multiple keywords (separated by spaces) are joined together or will be split into separate keywords for searching. This results in a greater likelihood of finding an item but is not desirable when searching for a specific word sequence. (Default: False).
json_objects – Boolean to note whether the output should be formatted as an array of JSON objects instead of a plain text list of the schedule identifiers currently in the library. (Default: False).
output_file – Optional file to output the full report of the validation. If None, the string will simply be returned from this method.

honeybee_energy.cli.lib.shade_constructions(keyword=None, join_words=False, json_objects=False, output_file=None, split_words=True, identifiers=True)[source]¶

Get a list of all shade constructions in the standards library.

Parameters:

keyword – An optional keyword to be used to filter the output list of constructions. This can also be a list of keywords which will collectively be used to filter the results. If None, all available constructions will be output. (Default: None).
join_words – Boolean to note whether strings of multiple keywords (separated by spaces) are joined together or will be split into separate keywords for searching. This results in a greater likelihood of finding an item but is not desirable when searching for a specific word sequence. (Default: False).
json_objects – Boolean to note whether the output should be formatted as an array of JSON objects instead of a plain text list of the construction identifiers currently in the library. (Default: False).
output_file – Optional file to output the full report of the validation. If None, the string will simply be returned from this method.

honeybee_energy.cli.lib.window_constructions(keyword=None, join_words=False, json_objects=False, output_file=None, split_words=True, identifiers=True)[source]¶

Get a list of all window constructions in the standards library.

Parameters:

keyword – An optional keyword to be used to filter the output list of constructions. This can also be a list of keywords which will collectively be used to filter the results. If None, all available constructions will be output. (Default: None).
join_words – Boolean to note whether strings of multiple keywords (separated by spaces) are joined together or will be split into separate keywords for searching. This results in a greater likelihood of finding an item but is not desirable when searching for a specific word sequence. (Default: False).
json_objects – Boolean to note whether the output should be formatted as an array of JSON objects instead of a plain text list of the construction identifiers currently in the library. (Default: False).
output_file – Optional file to output the full report of the validation. If None, the string will simply be returned from this method.

honeybee_energy.cli.lib.window_materials(keyword=None, join_words=False, json_objects=False, output_file=None, split_words=True, identifiers=True)[source]¶

Get a list of all window materials in the standards library.

Parameters:

keyword – An optional keyword to be used to filter the output list of materials. This can also be a list of keywords which will collectively be used to filter the results. If None, all available materials will be output. (Default: None).
join_words – Boolean to note whether strings of multiple keywords (separated by spaces) are joined together or will be split into separate keywords for searching. This results in a greater likelihood of finding an item but is not desirable when searching for a specific word sequence. (Default: False).
json_objects – Boolean to note whether the output should be formatted as an array of JSON objects instead of a plain text list of the material identifiers currently in the library. (Default: False).
output_file – Optional file to output the full report of the validation. If None, the string will simply be returned from this method.