- [source code]

List of all energy attirbutes assigned to Honeybee Faces and Subfaces.

- [source code]

Get a ConstructionSet from the standards library using a climate zone, building vintage and construction type.

Inputs

• climate_zone [Required]

  An integer between 1 and 8 for the ASHRAE climate zone in which the building is located. ASHRAE climate zones exist for all locations on Earth and can typically be looked up online or within the .stat file that downloads next to the .epw file. The climate zone is used to determine the amount of code-recommended insulation and solar heat gain protection for the construction set. The Honeybee "Climate Zones" component lists all of the climate zones supported by the library.

• vintage

  Text for the building vintage to search (eg. "2019", "pre_1980", etc.). The Honeybee "Building Vintages" component lists all of the vintages available in the library. Default: "2019" (for ASHRAE 90.1 2019). Note that vintages are often called "templates" within the OpenStudio standards gem and so this property effective maps to the standards gem "template".

• constr_type

  Text for the construction type of the set. (eg. "SteelFramed", "WoodFramed", "Mass", "Metal Building"). The Honeybee "Construction Types" component lists all of the construction types available in the library.

Outputs

• constr_set

  A ConstructionSet identifier that can be applied to Honeybee Rooms.

- [source code]

Provides a list of available building programs in the ProgramType library.

- [source code]

Search for available ProgramTypes within the honeybee energy standards library.

Note that the Room ProgramTypes output from this component effectively map to space types within OpenStudio.

Inputs

• bldg_prog

  Text for the building program to search (eg. "LargeOffice", "MidriseApartment", etc.). The Honeybee "Building Programs" component lists all of the building programs available in the library. If None, all ProgramTypes within the library will be output (filtered by keywords_ below).

• vintage

  Text for the building vintage to search (eg. "2019", "pre_1980", etc.). The Honeybee "Building Vintages" component lists all of the vintages available in the library. Default: "2019" (for ASHRAE 90.1 2019 | IECC 2015). Note that vintages are often called "templates" within the OpenStudio standards gem and so this property effective maps to the standards gem "template".

• keywords

  Optional keywords to be used to narrow down the output list of room programs. If nothing is input here, all available room programs will be output.

Outputs

• room_prog

  A list of room program identifiers that meet the input criteria and can be applied to Honeybee Rooms.

- [source code]

Provides a list of available building vintages in the library.

- [source code]

Create a ConstructionSet object containing all energy constructions needed to create an energy model. ConstructionSets can be assigned to Honeybee Rooms to specify all default constructions on the Room.

Inputs

• name

  Text to set the name for the ConstructionSet and to be incorporated into a unique ConstructionSet identifier.

• base_constr_set

  An optional ConstructionSet object that will be used as the starting point for the new ConstructionSet output from this component. This can also be text for the name of a ConstructionSet within the library such as that output from the "HB Search Construction Sets" component. If None, the Honeybee "Generic Default Construction Set" will be used as the base.

• exterior_subset

  A construction subset list from the "HB Exterior Construction Subset" component. Note that None values in this list correspond to no change to the given construction in the baseconstr_set.

• ground_subset

  A construction subset list from the "HB Ground Construction Subset" component. Note that None values in this list correspond to no change to the given construction in the baseconstr_set.

• interior_subset

  A construction subset list from the "HB Interior Construction Subset" component. Note that None values in this list correspond to no change to the given construction in the baseconstr_set.

• subface_subset

  A construction subset list from the "HB Subface Subset" component. Note that None values in this list correspond to no change to the given construction in the baseconstr_set.

Outputs

• constr_set

  A ConstructionSet object that can be assigned to Honeybee Rooms in order to specify all default constructions on the Room.

- [source code]

Create a list of ground constructions that can be used to edit or create a ConstructionSet object.

Inputs

• ground_wall

  A construction object for underground walls (or text for the identifier of the construction within the library).

• ground_roof

  A construction object for underground roofs (or text for the identifier of the construction within the library).

• ground_floor

  A construction object for ground-contact floors (or text for the identifier of the construction within the library).

Outputs

• ground_set

  A list of ground constructions that can be used to edit or create a ConstructionSet object.

- [source code]

Search for available ConstructionSets within the honeybee energy standards library.

Inputs

• keywords

  Optional keywords to be used to narrow down the output list of construction sets. If nothing is input here, all available construction sets will be output.

• join_words

  If False or None, this component will automatically split any strings of multiple keywords (spearated by spaces) into separate keywords for searching. This results in a greater liklihood of finding an item in the search but it may not be appropropriate for all cases. You may want to set it to True when you are searching for a specific phrase that includes spaces. (Default: False).

Outputs

• constr_sets

  A list of ConstructionSet identifiers that can be applied to Honeybee Rooms.

- [source code]

Create a ProgramType object by blending other ProgramTypes together using a weighted average based on program ratios.

Inputs

• name

  Text to set the name for the ProgramType and to be incorporated into a unique ProgramType identifier.

• programs [Required]

  A list of ProgramType objects that will be averaged together to make a new ProgramType.

• ratios

  A list of fractional numbers with the same length as the input programs that sum to 1. These will be used to weight each of the ProgramType objects in the resulting average. If None, the input program objects will be weighted equally. Default: None.

Outputs

• program

  A ProgramType object that's a weighted average between the input _programs.

- [source code]

Create a ProgramType object possessing all schedules and loads defining the usage of a space.

ProgramTypes can be assigned to Honeybee Rooms to specify all default schedules and loads on the Room.

Inputs

• name

  Text to set the name for the ProgramType and to be incorporated into a unique ProgramType identifier.

• base_program

  An optional ProgramType object that will be used as the starting point for the new ProgramType output from this component. This can also be text for the name of a ProgramType within the library such as that output from the "HB Search Program Types" component. If None, a Plenum program type will be used as the base with no loads, setpoints, or ventilation requirements assigned.

• people

  A People object to describe the occupancy of the program. If None, no occupancy will be assumed for the program. (Default: None).

• lighting

  A Lighting object to describe the lighting usage of the program. If None, no lighting will be assumed for the program. (Default: None).

• electric_equip

  An ElectricEquipment object to describe the usage of electric equipment within the program. If None, no electric equipment will be assumed for the program. (Default: None).

• gas_equip

  A GasEquipment object to describe the usage of gas equipment within the program. If None, no gas equipment will be assumed for the program. (Default: None).

• hot_water

  A ServiceHotWater object to describe the usage of hot water within the program. If None, no hot water will be assumed for the program. (Default: None).

• infiltration

  An Infiltration object to describe the outdoor air leakage of the program. If None, no infiltration will be assumed for the program. (Default: None).

• ventilation

  A Ventilation object to describe the minimum outdoor air requirement of the program. If None, no ventilation requirement will be assumed for the program. (Default: None).

• setpoint

  A Setpoint object to describe the temperature and humidity setpoints of the program. If None, the ProgramType cannot be assigned to a Room that is conditioned. (Default: None).

Outputs

• program

  A ProgramType object that can be assigned to Honeybee Rooms in order to specify all default schedules and loads on the Room.

- [source code]

Provides a list of available building construction types in the ConstructionSet library.

- [source code]

Create a list of exterior subface (apertures + doors) constructions that can be used to edit or create a ConstructionSet object.

Inputs

• window

  A construction object for apertures with an Outdoors boundary condition and a Wall face type for their parent face. This can also be text for the identifier of the construction within the library.

• skylight

  A construction object for apertures with an Outdoors boundary condition and a RoofCeiling or Floor face type for their parent face. This can also be text for the identifier of the construction within the library.

• operable

  A construction object for apertures with an Outdoors boundary condition and True is_operable property. This can also be text for the identifier of the construction within the library.

• exterior_door

  A construction object for opaque doors with an Outdoors boundary condition and a Wall face type for their parent face. This can also be text for the identifier of the construction within the library.

• overhead_door

  A construction object for opaque doors with an Outdoors boundary condition and a RoofCeiling or Floor face type for their parent face. This can also be text for the identifier of the construction within the library.

• glass_door

  A construction object for all glass doors with an Outdoors boundary condition. This can also be text for the identifier of the construction within the library.

Outputs

• subface_set

  A list of exterior subface constructions that can be used to edit or create a ConstructionSet object.

- [source code]

Make boundary conditions of Rooms or Faces adiabatic by face type.

Inputs

• hb_objs [Required]

  Honeybee Faces or Rooms to which adiabatic boundary conditions will be assigned.

• exterior_walls

  If True, all exterior walls of the input Rooms or Faces will be set to adiabatic. This can also be a list of boolean values and different adiabatic values will be assigned based on the cardinal direction, starting with north and moving clockwise.

• roofs

  If True, all exterior roofs of the input Rooms or Faces will be set to adiabatic.

• exposed_floors

  If True, all exposed floors of the input Rooms or Faces will be set to adiabatic.

• interior_walls

  If True, all interior walls of the input Rooms or Faces will be set to adiabatic.

• interior_floors

  If True, all interior floors and ceilings of the input Rooms or Faces will be set to adiabatic.

Outputs

• hb_objs

  The input honeybee objects with their boundary conditions edited.

- [source code]

Change the properties of Honeybee Rooms to reflect those of a ground surface.

This is particularly useful for setting up outdoor thermal comfort maps that account for the surface temperature of the ground. Modeling the ground as a room this way will ensure that shadows other objects cast upon it are accounted for along with the storage of heat in the ground surface.

The turning of a Room into a ground entails:

• Setting all constructions to be indicative of a certain soil type. * Setting all Faces except the roof to have a Ground boundary condition. * Removing all loads and schedules assigned to the Room.

All values for the typical soil_types are taken from the Engineering Toolbox, specifically these pages: Soil Conductivity - http://www.engineeringtoolbox.com/thermal-conductivity-d_429.html Soil Density - http://www.engineeringtoolbox.com/dirt-mud-densities-d_1727.html Soil Heat Capacity - http://www.engineeringtoolbox.com/specific-heat-capacity-d_391.html

Inputs

• rooms [Required]

Honeybee Rooms to be converted into ground objects.

• soil_constr

An OpaqueConstruction that reflects the soil type of the ground. This can also be text for a construction to be looked up in the opaque construction library. If a multi-layered construction is input, the multiple layers will only be used for the roof Face of the Room and all other Faces will get a construction with the inner-most layer assigned. Some common types of soil constructions contained in the default honeybee standards library are listed below. (Default: Concrete Pavement). Grassy Lawn Dry Sand Dry Dust Moist Soil Mud Concrete Pavement Asphalt Pavement Solid Rock

Outputs

• rooms

Rooms that have had their properties altered to be representative of ground conditions.

-

List of all energy attirbutes assigned to Honeybee Rooms.

-

Provides a list of available climate zones in the library.

-

Assign internal thermal masses to Rooms, which can be used to account for the effects of furniture inside Rooms or other massive building components like staircases, hearths, etc.

The component accepts either Rhino geometry (representing furniture or massive elements) or a numerical value of the mass's surface area. Several of these components can be used in a series to descibe different internal masses made of different materials.

Note that internal masses assigned this way cannot "see" solar radiation that may potentially hit them and, as such, caution should be taken when using this component with internal mass objects that are not always in shade. Masses are factored into the the thermal calculations of the Room by undergoing heat transfer with the indoor air.

Inputs

• rooms [Required]

  Honeybee Rooms to which internal masses should be assigned.

• geo_or_area [Required]

  A list of Rhino breps or meshes representing the surfaces of internal masses that are exposed to the air of the Room. Alternatively, this can be a number or list of numbers representing the surface area of the internal masses (in square meters) that are exposed to the Room air.

  In the case of Rhino geometry representing the surfaces of internal masses, this component will determine which Room the geometry is in. However, geometry must lie COMPLETELY inside a single Room and cannot span between Rooms or span outside the building. If a geometry lies between two Rooms, it should be split in two along the boundary between the Rooms. Also note that geometries are assumed to have only one side exposed to the Room air so, if they are meant to represent a 2-sided object, the geometry should be duplicated and offset.

  In the case of numbers representing the the surface area of the internal masses, inputs can be either a single number (which will be used to put internal masses into all Rooms using the specified surface area), or it can be a list of numbers that matches the input Rooms, which can be used to assign different amounts of mass surface area to different Rooms. All numbers are assumed to be in square meters.

• construction [Required]

  An OpaqueConstruction object that represents the material that the internal thermal mass is composed of. This can also be text for the identifier of the construction within the library.

• name

  An optional text name for the internal mass. This can be useful for keeping track of different internal masses when using several of these components in series. If unspecified, a unique one will be generated.

Outputs

• report

  Reports, errors, warnings, etc.

• rooms

  The input Rooms with internal masses assigned.

-

Create a boundary condition representing a custom temperature and/or heat transfer coefficient on the other side of a face.

Inputs

• temperature

A temperature value in Celsius to note the temperature on the other side of the object. If unspecified, the outdoor air temperature will be used.

• heat_coeff

A value in W/m2-K to indicate the combined convective/radiative film coefficient. If equal to 0, then the specified temperature above is equal to the exterior surface temperature. Otherwise, the temperature above is considered the outside air temperature and this coefficient is used to determine the difference between this outside air temperature and the exterior surface temperature. (Default: 0).

Outputs

• bc

A BoundaryCondition object that can be assigned to any honeybee Face object (using the "HB Face" component or the "HB Properties by Guide Surface").

- [source code]

Create a list of exterior constructions that can be used to edit or create a ConstructionSet object.

Inputs

• exterior_wall

  A construction object for exterior walls (or text for the identifier of the construction within the library).

• exterior_roof

  A construction object for exterior roofs (or text for the identifier of the construction within the library).

• exposed_floor

  A construction object for exposed floors (or text for the identifier of the construction within the library).

Outputs

• exterior_set

  A list of exterior constructions that can be used to edit or create a ConstructionSet object.

- [source code]

Create a list of interior constructions that can be used to edit or create a ConstructionSet object.

Inputs

• interior_wall

  A construction object for interior walls (or text for the identifier of the construction within the library).

• ceiling

  A construction object for ceilings (or text for the identifier of the construction within the library).

• interior_floor

  A construction object for interior floors (or text for the identifier of the construction within the library).

• interior_window

  A construction object for all apertures with a Surface boundary condition. This can also be text for the identifier of the construction within the library.

• interior_door

  A construction object for all opaque doors with a Surface boundary condition. This can also be text for the identifier of the construction within the library.

• int_glass_door

  A construction object for all glass doors with a Surface boundary condition. This can also be text for the identifier of the construction within the library.

Outputs

• interior_set

  A list of interior constructions that can be used to edit or create a ConstructionSet object.

- [source code]

Set any Faces of Rooms with missing adjacencies to Adiabatic.

This is useful when simulating a subset of Rooms from a larger Model.

If any of the Faces with missing adjacencies have sub-faces, these will be removed in order to accommodate the adiabatic condition. Similarly, if the Face is an AirBoundary, the type will be set to a Wall.

Inputs

• rooms [Required]

A list of Honeybee Rooms which will have its adjacencies patched with Adiabatic boundary conditions. This can also be an entire honyebee Model. Any adjacnecy not found across all of the rooms will be replaced with an Adiabatic boundary.

Outputs

• rooms

Rooms that have had their missing adjacencies patched.

- [source code]

Turn Honeybee Rooms into Plenums with no internal loads.

This includes removing all people, lighting, equipment, hot water, and mechanical ventilation. By default, the heating/cooling system and setpoints will also be removed but they can optionally be kept. Infiltration is kept by default but can optionally be removed as well.

This is useful to appropriately assign properties for closets, underfloor spaces, and drop ceilings.

Inputs

• rooms [Required]

Honeybee Rooms to be converted into plenums.

• conditioned

Boolean to indicate whether the plenum is conditioned with a heating/cooling system. If True, the setpoints of the Room will also be kept in addition to the heating/cooling system (Default: False).

• remove_infilt

Boolean to indicate whether infiltration should be removed from the Rooms. If False, infiltration will be preserved and will be the only load assinged to the plenum. (Default: False).

• include_floor

Boolean to indicate whether the floor area of the plenum contributes to the Model it is a part of. Note that this will not affect the floor_area property of this Room but it will ensure the Room's floor area is excluded from any calculations when the Room is part of a Model and when it is simulated in EnergyPlus.

Outputs

• rooms

Rooms that have had their interinal loads removed to reflect a plenum space.