honeybee_energy.cli.lib module

honeybee energy standards library commands.

honeybee_energy.cli.lib.construction_set_by_id(construction_set_id, include_defaults=False, abridged=False, output_file=None, complete=True, none_defaults=True)[source]

Get a construction set definition from the standards lib with its identifier.

Parameters:

  • construction_set_id – The identifier of a construction set in the library.

  • include_defaults – Boolean to note whether default constructions in the set should be included in or should be None.

  • abridged – Boolean to note whether an abridged definition should be returned.

  • output_file – Optional file to output the result. If None, the string will be returned from this method.

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 result. If None, the string will be returned from this method.

honeybee_energy.cli.lib.construction_sets_by_id(construction_set_ids, include_defaults=False, abridged=False, output_file=None, complete=True, none_defaults=True)[source]

Get several construction set definitions from the standards lib at once.

Parameters:

  • construction_set_ids – Any number of construction set identifiers to be retrieved from the library.

  • include_defaults – Boolean to note whether default constructions in the set should be included in or should be None.

  • abridged – Boolean to note whether an abridged definition should be returned.

  • output_file – Optional file to output the result. If None, the string will be returned from this method.

honeybee_energy.cli.lib.constructions_by_id(construction_ids, abridged=False, output_file=None, complete=True)[source]

Get several construction definitions from the standards lib at once.

Parameters:

  • construction_ids – Any number of construction identifiers to be retrieved from the library.

  • abridged – Boolean to note whether an abridged definition should be returned.

  • output_file – Optional file to output the result. If None, the string will be returned from this method.

honeybee_energy.cli.lib.materials_by_id(material_ids, output_file=None)[source]

Get several material definitions from the standards lib at once.

Parameters:

  • material_ids – A list of identifiers for materials in the library.

  • output_file – Optional file to output the result. If None, the string will be returned from this method.

honeybee_energy.cli.lib.opaque_construction_by_id(construction_id, abridged=False, output_file=None, complete=True)[source]

Get an opaque construction definition from the standards lib with its identifier.

Parameters:

  • construction_id – The identifier of an opaque construction in the library.

  • abridged – Boolean to note whether an abridged definition should be returned.

  • output_file – Optional file to output the result. If None, the string will 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 result. If None, the string will be returned from this method.

honeybee_energy.cli.lib.opaque_material_by_id(material_id, output_file=None)[source]

Get an opaque material definition from the standards lib with its identifier.

Parameters:

  • material_id – The identifier of an opaque material in the library.

  • output_file – Optional file to output the result. If None, the string will 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 result. If None, the string will be returned from this method.

honeybee_energy.cli.lib.program_type_by_id(program_type_id, abridged=False, output_file=None, complete=True)[source]

Get a program type definition from the standards lib with its identifier.

Parameters:

  • program_type_id – The identifier of a program type in the library.

  • abridged – Boolean to note whether an abridged definition should be returned.

  • output_file – Optional file to output the result. If None, the string will 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 result. If None, the string will be returned from this method.

honeybee_energy.cli.lib.program_types_by_id(program_type_ids, abridged=False, output_file=None, complete=True)[source]

Get a program type definition from the standards lib with its identifier.

Parameters:

  • program_type_ids – Any number of program type identifiers to be retrieved from the library.

  • abridged – Boolean to note whether an abridged definition should be returned.

  • output_file – Optional file to output the result. If None, the string will be returned from this method.

honeybee_energy.cli.lib.schedule_by_id(schedule_id, abridged=False, output_file=None, complete=True)[source]

Get a schedule definition from the standards lib with its identifier.

Parameters:

  • schedule_id – The identifier of a schedule in the library.

  • abridged – Boolean to note whether an abridged definition should be returned.

  • output_file – Optional file to output the result. If None, the string will be returned from this method.

honeybee_energy.cli.lib.schedule_type_limit_by_id(schedule_type_limit_id, output_file=None)[source]

Get a schedule type limit definition from the standards lib with its identifier.

Parameters:

  • schedule_type_limit_id – The identifier of a schedule type limit in the library.

  • output_file – Optional file to output the result. If None, the string will 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 result. If None, the string will be returned from this method.

honeybee_energy.cli.lib.schedule_type_limits_by_id(schedule_type_limit_ids, output_file=None)[source]

Get several schedule type limit definitions from the standards lib at once.

Parameters:

  • schedule_type_limit_ids – Any number of schedule type limit identifiers to be retrieved from the library.

  • output_file – Optional file to output the result. If None, the string will 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 result. If None, the string will be returned from this method.

honeybee_energy.cli.lib.schedules_by_id(schedule_ids, abridged=False, output_file=None, complete=True)[source]

Get a schedule definition from the standards lib with its identifier.

Parameters:

  • schedule_ids – Any number of schedule identifiers to be retrieved from the library.

  • abridged – Boolean to note whether an abridged definition should be returned.

  • output_file – Optional file to output the result. If None, the string will be returned from this method.

honeybee_energy.cli.lib.shade_construction_by_id(construction_id, output_file=None)[source]

Get a shade construction definition from the standards lib with its identifier.

Parameters:

  • construction_id – The identifier of a shade construction in the library.

  • output_file – Optional file to output the result. If None, the string will 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 result. If None, the string will be returned from this method.

honeybee_energy.cli.lib.window_construction_by_id(construction_id, abridged=False, output_file=None, complete=True)[source]

Get a window construction definition from the standards lib with its identifier.

Parameters:

  • construction_id – The identifier of a window construction in the library.

  • abridged – Boolean to note whether an abridged definition should be returned.

  • output_file – Optional file to output the result. If None, the string will 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 result. If None, the string will be returned from this method.

honeybee_energy.cli.lib.window_material_by_id(material_id, output_file=None)[source]

Get a window material definition from the standards lib with its identifier.

Parameters:

  • material_id – The identifier of an window material in the library.

  • output_file – Optional file to output the result. If None, the string will 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 result. If None, the string will be returned from this method.