honeybee.search module

Collection of methods for searching for keywords and filtering lists by keywords. This module also included methods to get nested attributes of objects.

This is useful for cases like the following:

  • Searching through the honeybee-radiance modifier library.

  • Searching through the honeybee-energy material, construction, schedule, constructionset, or programtype libraries.

  • Searching through EnergyPlus IDD or RDD to find possible output variables to request form the simulation.

honeybee.search.any_keywords_in_string(name, keywords)[source]

Check whether any keywords in an array exist within a given string.

Parameters

  • name – A string which will be tested for whether it possesses any of the keywords.

  • keywords – An array of strings representing keywords, which will be searched for in the name.

honeybee.search.filter_array_by_keywords(array, keywords, parse_phrases=True)[source]

Filter an array of strings to get only those containing the given keywords.

This method is case insensitive, allowing the searching of keywords across different cases of letters.

Parameters

  • array – An array of strings which will be filtered to get only those containing the given keywords.

  • keywords – An array of strings representing keywords.

  • parse_phrases – If True, this method will automatically parse any strings of multiple keywords (separated by spaces) into separate keywords for searching. This results in a greater likelihood that someone finds what they are searching for in large arrays but it may not be appropriate for all cases. You may want to set it to False when you are searching for a specific phrase that includes spaces. Default: True.

honeybee.search.get_attr_nested(obj_instance, attr_name, decimal_count=None, cast_to_str=True)[source]

Get the attribute of an object while allowing the request of nested attributes.

Parameters

  • obj_instance – An instance of a Python object. Typically, this is a honeybee object like a Model, Room, Face, Aperture, Door, or Shade.

  • attr_name – A string of an attribute that the input obj_instance should have. This can have ‘.’ that separate the nested attributes from one another. For example, ‘properties.energy.construction’.

  • decimal_count – An optional integer to be used to round the property to a number of decimal places if it is a float. (Default: None).

  • cast_to_str – Boolean to note whether attributes with a type other than float should be cast to strings. If False, the attribute will be returned with the original object type. (Default: True).

Returns

A string or number for tha attribute assigned ot the obj_instance. If the input attr_name is a valid attribute for the object but None is assigned, the output will be ‘None’. If the input attr_name is not valid for the input object, ‘N/A’ will be returned.