Grasshopper Docs

Community documentation for Grasshopper add-ons & plugins

Honeybee

ADDON. Version 0.0.65. Released on 2020-Jan-01. Provides 220 components. Created by Ladybug Tools. Features 50 video tutorials.
Honeybee connects Grasshopper3D to validated simulation engines such as EnergyPlus, Radiance, Daysim and OpenStudio for building energy, comfort, daylighting and lighting simulation.
00 | Honeybee
01 | Daylight | Material
02 | Daylight | Light Source
03 | Daylight | Recipes
04 | Daylight | Daylight
05 | Energy | Building Program
06 | Energy | Material | Construction
07 | Energy | Schedule
08 | Energy | Set Zone Properties
09 | Energy | HVACSystems
10 | Energy | Energy
11 | THERM
12 | Developers
13 | WIP

10 | Energy | Energy

Surface Data Based On Type
Use this component to separate grafed lists of surface data that come out of the "Honeybee_Read EP Surface Result" component based on rough surface type
Read Microclimate Matrix
This component reads the results of an Adaptive Indoor Comfort Analysis
Energy Shade Benefit Evaluator
This is a component for visualizing the desirability of shade in terms of energy simulation results by using solar vectors, the outdoor temperature, and the simulation hating load, cooling load, and beam gain
Make Adiabatic
Make Adiabatic
Visualize Microclimate Map
Use this component to produce a colored mesh from a comfResultsMtx
Read generation system results
This component reads the results of an EnergyPlus simulation from the WriteIDF Component or any EnergyPlus result
Open Studio to gb XML
Use this component to export OpenStudio model to gbXML file
PMV Comfort Analysis Recipe
Use this component to assemble an adaptive comfort recipe for the "Honeybee_Annual Indoor Comfort Analysis" component
Export To Open Studio
Use this component to export HBZones into an OpenStudio file, and run them through EnergyPlus
Run Energy Simulation
Use this component to export HBZones into an IDF file, and run them through EnergyPlus
Shadow Par
EnergyPlus Shadow Parameters
Read HVAC Sizing
This component parses an
gb XML to Honeybee
Import gbXML files as Honeybee zones
Simulation Control
Use this component to set EnergyPlus Simulation Controls such as whether to run certain types of HVAC sizing calculations, etc
Read EP Result
This component reads the results of an EnergyPlus simulation from the WriteIDF Component or any EnergyPlus result
Color Surfaces by EP Result
Use this component to color zone surfaces based on EnergyPlus data out of the "Honeybee_Read EP Surface Result" component
Thermal Autonomy Analysis
Use this component to calculate 'Occupied Thermal Comfort Percent' (occTCP) and 'Thermal Autonomy' (TA) from the resultd of a Microclimate Map Analysis
Generate EP Output
This component helps select simulation outputs that can be hooked into the "Honyebee_Export to OpenStudio" component
Make Adiabatic by Name
Make Adiabatic
Construct Energy Balance
This component accepst the outputs of the "Read EP Result" and the "Read EP Surface Result" components and outputs a data tree with all of the building-wide energy balance terms
Normalize Data by Floor Area
This component takes data that has been output from a simulation and normalizes the results by the floor area of the HBZones
Apply Open Studio Measure
This component applies an OpenStudio measure to an OpenStudio file
Adaptive Comfort Analysis Recipe
Use this component to assemble an adaptive comfort recipe for the "Honeybee_Annual Indoor Comfort Analysis" component
Color Zones by EP Result
Use this component to color zones based on EnergyPlus data out of the "Honeybee_Read EP Result" component or zone comfort analyses out of the comfort calculator components
EP context Surfaces
prepare shading/context geometries
Balance Temperature Calculator
Use this component to calculate a rough building (or zone) balance temperatrue from a Honeybee energy simulation
Read Result Dictionary
This component parses an
Indoor View Factor Calculator
Use this component to generate test points within a zone and calculate the view factor from each of these points to the other zurfaces in a zone as well as the sky
Re-run IDF
This is a component for running a previoulsy-generated
PET Analysis Recipe
Use this component to assemble an adaptive comfort recipe for the "Honeybee_Annual Indoor Comfort Analysis" component
Re-run OSM
This is a component for running a previoulsy-generated
Energy Simulation Par
EnergyPlus Shadow Parameters
Read EP Custom Result
This component reads the results of an EnergyPlus simulation from the "Export to OpenStudio" Component or any EnergyPlus result
Read EP Surface Result
This component reads the results of an EnergyPlus simulation from the WriteIDF Component or any EnergyPlus result
Lookup Energy Plus Folder
Search Energy Simulation Folder
Read EP HVAC Result
This component reads the results of an EnergyPlus simulation from the WriteIDF Component or any EnergyPlus result
Microclimate Map Analysis
Use this component runs an annual comfort assessment off of EnergyPlus results and write all values into csv files
Matrix to Data Tree
This component converts a comfort result matrix into a Grasshopper Data Tree with numerical values
Surface Data Based On Type Detailed
Use this component to separate grafed lists of surface data that come out of the "Honeybee_Read EP Surface Result" component based on rough surface type
Outdoor Comfort Analysis Recipe
Use this component to assemble an adaptive comfort recipe for the "Honeybee_Annual Indoor Comfort Analysis" component
Energy Plus Window Shade Generator
Use this component to generate shades for Honeybee zone windows
Add Internal Mass to Zone
Use this component to assign internal thermal masses to zones, which can be used to account for the effects of furniture inside zones or massive building components like hearths and chimneys
Make Adiabatic By Type
Use this component to make certain surface types of a zone adiabatic

00 | Honeybee

Move Honeybee
Move Honeybee Objects
Honeybee
This component carries all of Honeybee's main classes
Separate Zones By Orientation
Separate zones based on orientation
Separate conditioned and unconditioned zones
Separate zones into conditioned and unconditioned
Decompose Based On Type
Use this component to break down the geometry of your zone by the surface type
Separate Zones By Program
Separate zones based on zone program
Item Selector (List)
Allows you to select an item or items from an input list
Intersect Masses
Use this component to take a list of closed breps (polysurfaces) that you intend to turn into HBZones and split their component surfaces to ensure that there are matching surfaces between each of the adjacent zones
create HBSrfs
Create a Honeybee surface, which can be plugged into the "Run Daylight Sumilation" component or combined with other surfaces to make HBZones with the "createHBZones" component
Change HBObj Name
Change Honeybee Object Names
Decompose Based On Boundary Condition
Decompose zone surfaces by boundary condition
Ask Me
Use this component to get basic information on Honeybee Objects, whether they are HBSrfs or HBZones
Dump Honeybee Objects
Dump Honeybee Objects
Use this component to dump Honeybee objects to a file on your system
Find Non-Convex
In EnergyPlus, Solar distribution determines how EnergyPlus treats the beam solar radiation and reflectances from exterior surfaces that strike the building, and ultimately, enter the zone
Skylight Based on Ratio
Use this component to generate windows for a HBSurface or HBZone based on a desired window-to-wall ratio
Masses2Zones
Use this component to take any list of closed breps and turn them into Honeybee Zones with all of the properties needed to run them through an energy simulation
Split Floor2Thermal Zones
Use this component to divide up a brep (polysurface) representative of a building floor into smaller volumes that roughly correspond to how a generic EnergyPlus model should be zoned
Extrude Windows
Extrude pseudo walls from window polygons
orient HBGlz
Use this component to set the orientation(s) of the glazing
Zone Attribute List (zoneAttributeList)
Provides a list of preset values to choose from
Surface Attribute List (srfAttributeList)
Provides a list of surface attributes to choose from and plug into the Honeybee_Label Surfaces Component
Perimeter Core Zoning
Separate zones into perimeter and core
Open File Directory
Ues this component to Open a file/directory in windows explorer
create HBZones
Create an HBZone from HB Surfaces
Label Zones
Use this component to lablel zones with their names in the Rhino scene
Mirror Honeybee
Mirror Honeybee Objects
add HBGlz
Use this component to add a custom glazing surface to a HBSurface or HBZone
Scale Honeybee
Scale Honeybee Objects Non-Uniformly
Solve Adjacencies
Solve adjacencies
Decompose HBZone
Decompose Honeybee Zone
Glazing Parameters List
Use this component to generate lists of glazing ratios, breakUp diatance, window heigths, sill heights, or vertical glazing splits for the four primary cardinal directions
Select by Type
Select surfaces by type
Get or Set HB Object Name
Change Honeybee Object Names
Remove Glazing
Remove Glazing
Label Zone Surfaces
Use this component to lablel HBSurfaces or HBZones with their names or energy/daylight properties in the Rhino scene
Separate Zones By Floor
Separate zones based on floor height
Rotate Honeybee
Rotate Honeybee Objects
Split Building Mass2Floors
Use this component to divide up a brep (polysurface) representative of a complete building massing into floors
Load Honeybee Objects
Load Honeybee Objects
Use this component to load Honeybee objects from a file on your system
Glazing based on ratio
Use this component to generate windows for a HBSurface or HBZone based on a desired window-to-wall ratio

04 | Daylight | Daylight

False Color
False Color
Daysim Occupancy Generator Based On List
Daysim Occupancy Generator
Daysim calculates the outputs for the hours that the space is occupied
Read All the Hourly Results from Annual Daylight Study
Read the results of the annual study for a all the hours of the year for all the points
Daysim Occupancy Generator
Daysim Occupancy Generator
Daysim calculates the outputs for the hours that the space is occupied
Lighting control Recipe
Daysim electrical lighting control
Convert TIF to HDR
Convert HDR to TIF
Set Exposure for HDR
Set Exposure for HDR
Convert HDR to GIF
Convert HDR to GIF
Convert IMG
Convert Image
Convert HDR to TIF
Convert HDR to TIF
Read Annual Result I
Read Annual Daylight Results I [Standard Daysim Results]
Read Annual Result II
Read Annual Daylight Results II [Daysim]
Lookup Daylighting Folder
Search Simulation Folder
Glare Analysis
Glare Analysis
This component is using evalglare for glare calculations
Read Hourly Results from Annual Daylight Study
Read the results of the annual study for a single hour of the year
Read RAD Result
Read Radiance Results
Read DS Result for a point
Read Daysim result for a test point
Import rad
Import a rad file to gh
This component is just a proof of concept for now and needs major modifications
MSH2RAD
Convert a mesh to RAD file
Import dgp File
Import Annual Daylight Glare Probability
Import Pts File
Import Radiance Test Grid
Run Daylight Simulation
export geometries to rad file, and run daylighting/energy simulation
Refine Daylight Simulation
Refine simulation for an existing Radiance scene (
Daysim Electrical Lighting Use
Daysim's electrical lighting use
Daysim shading group sensors
Daysim shading group sensors
Read here for more information about Daysim sensors here: http://daysim
Daysim Annual Profiles
Read Daysim Annual Profiles

08 | Energy | Set Zone Properties

Set Energy Plus Zone Loads
Use this component to change the occupancy, lighting, equipment, etc
Create EP Ground
Use this component to change the properties of a zone to refelct those of a ground
Set EP Zone Interior Construction
Set EP Zones Interior Construction
inf ORvent Per Area Calculator
Use this component to transform ACH or inifitration per area of facade to m3/s-m2
Set Energy Plus Zone Schedules
Use this component to change the schedules of your HBZones
Lighting Density Calculator
Use this component to calculate the Lighting Density Per Area Load from information about your bulb, fixture type, mainteneance, and required lighting level
Set EP Air Flow
Use this component to edit the airflow between your zones's air walls and/or set natural ventilation
Set Loads And Schedules
Set schedules and loads for zones based on program
Set EP Surface Construction
Add Glazing
Set EP Zone Underground Construction
Update EP construction of zone based on type
Set Zone Properties
Use this component to set HBZone properties
By default these values will be automatically calculated by EnergyPlus
Set Energy Plus Zone Thresholds
Use this component to set Zone Thresholds like daylighting thresholds and setpoints
Add Earthtube
Use this component to add an Energy Plus earth tube to a Zone
Set EP Zone Construction
Update EP construction of zone based on type
Create EP Plenum
Use this component to turn a HBZone into a 'Plenum Zone' with no internal loads

01 | Daylight | Material

Radiance Trans Material By Color
Radiance Trans Material
This component is useful to create translucent materials
Radiance Mirror Material By Color
Radiance Mirror Material By Color
Read more here to understand Radiance materials: http://www
Radiance Mirror Material
Radiance Mirror Material
Read more here to understand Radiance materials: http://www
Set Radiance Materials
Radiance Default Materials
Radiance Metal Material By Color
Radiance Metal Material By Color
Create a Standard Radiance Metal Material
Radiance Trans Material
Radiance Trans Material
This component is useful to create translucent materials
Radiance Opaque Material
Radiance Opaque Material
Create a Standard Radiance Opaque Material
Radiance BSDF Material
Radiance BSDF Material
Create RADIANCE BSDF material
Radiance Materials Info
Radiance Materials Info
Radiance Glass Material
Radiance Glass Material
Read more here to understand Radiance materials: http://www
Radiance Glass Material By Color
Radiance Glass Material By Color
Read more here to understand Radiance materials: http://www
Radiance Metal Material
Radiance Opaque Material
Create a Standard Radiance Opaque Material
Radiance Opaque Material By Color
Radiance Opaque Material By Color
Create a Standard Radiance Opaque Material
Call from Radiance Library
Call Radiance Materials from Library
Add to Radiance Library
Add Radiance Materials to Library

03 | Daylight | Recipes

Advanced Dynamic Shading Recipe
Advanced Shading Recipe for Annual Simulation with Daysim
Conceptual Dynamic Shading Recipe
Conceptual Shading Recipe for Annual Simulation with Daysim
You need to add sensor points later in the Daysim result reader
Image Based Simulation
Analysis Recipie for Image-Based Analysis
Generate Zone Test Points
Genrate Test Points for all Floor Surfaces in Honeybee Zone
Vertical Sky Component
Analysis Recipie for Vertical Sky Component, which is typically used to evaluate daylight and sky access in urban areas
DSParameters
Analyses Recipe for Annual Daylight Simulation with Daysim
Annual Daylight Simulation
Analysis Recipe for Annual Daylighting Simulation
RADParameters
Radiance Parameters - Standard
Check here for more details: http://radsite
Daylight Factor Simulation
Analysis Recipie for Daylight Factor Analysis
Ambient Resolution
Use this component to calculate the ambient resoluation (ar) needed to resolve a detail of a diven dimension in Rhino model units
Generate Test Points
Genrate Test Points
Daysim Glare Control Recipe
Glare Control Recipe for Annual Simulation with Daysim "Based on exterior illuminance and/or position of the sun"
You need to add an external sensor later in the Daysim result reader
Daysim Shading State
Daysim Shading State for Advanced Dynamic Shading
Grid Based Simulation
Analysis Recipie for Grid-Based Analysis

06 | Energy | Material | Construction

Energy Plus Glass Material
Use this component to create a custom material for glass, which can be plugged into the "Honeybee_EnergyPlus Construction" component
Search EP Construction
Search EnergyPlus construction based on Energy modeling standards, climate zone, surface type and building program
Energy Plus Shade Material
Use this component to create a custom material for shades, which can be plugged into the "Honeybee_EnergyPlus Window Shade Generator" component
Energy Plus No Mass Opaque Material
Use this component to create a custom opaque material that has no mass, which can be plugged into the "Honeybee_EnergyPlus Construction" component
Energy Plus Construction
Use this component to make your own EnergyPlus construction
Energy Plus Window Material
Use this component to create a custom window material that has no mass, which can be plugged into the "Honeybee_EnergyPlus Construction" component
R-Value With Air Films
Use this component to account for air films in the U-Value and R-Value of any decomposed Honeybee construction or material
Add to Energy Plus Library
Add EnergyPlus Material, Construction or Schedule to Library
Energy Plus Opaque Material
Use this component to create a custom opaque material, which can be plugged into the "Honeybee_EnergyPlus Construction" component
Decompose EP Construction
Decompose EnergyPlus Construction
Decompose EP Material
Decompose EnergyPlus Material
Call from EP Construction Library
Call from EP Library
Energy Plus Window Air Gap
Use this component to create a custom material for a window air gap, which can be plugged into the "Honeybee_EnergyPlus Construction" component

11 | THERM

Create Therm Boundaries
Use this component to create a THERM boundary condition
Import THERM XML
Use this component to read the content of a THERM XML file into Grasshopper
Import WINDOW Glz System
Use this component to import the content of a LBNL WINDOW text file report as a series of polygons and boundary conditions that can be plugged into the "Write THERM File' component
Read THERM Result
Use this component to import the colored mesh results from a THERM simulation
Assembly Uvalue
Use this component to calculate the assembly U-Value for a window given an input window geometry, center of glass U-value, and frame+edge U-value
Therm Material to Energy Plus Material
Use this component to create a custom opaque material, which can be plugged into the "Honeybee_EnergyPlus Construction" component
Therm Material
Use this component to create a custom THERM material, which can be plugged into the "Honeybee_Create Therm Polygons" component
Import WINDOW IDF Report
Use this component to import an EnergyPlus window construction from LBNL WINDOW
Create Therm Polygons
Use this component to create a THERM polygon with material properties
Custom Radiant Environment
Use this component to create a custon radiant environment for THERM boundary condition
Thermally Bridged EP Construction
Use this component to adjust the U-value an EP construction without any thermal bridges to account for birdges by adjusting the condutivity of one of the materials
Write THERM File
Use this component to write your THERM polygons and boundary conditions into a therm XML that can be opened ready-to-run in THERM

02 | Daylight | Light Source

Generate Sky With Certain Illuminance level
Genrate a Uniform CIE Sky Based on Illuminace Value
Generate Dark Sky
This component generates a dark sky with 0 illuminance
IES Luminaire
This is the core component for adding photometric data into a lighting simulation
Generate Average Sky
Generate Average Climate Based Sky
This component generate an average climate based data for a single hour during a month
IES Luminaire Zone
This component is to be used for specifying the location of luminaires for electric lighting simulations
Generate Cumulative Sky
This component generate a cumulative sky using GenCumulativeSky
Generate Custom Sky
Genrate Custom Sky
This component generate a custom sky based on user's input
Generate Standard CIE Sky
Genrate Standard CIE Sky
Generate Climate Based Sky
Genrate Climate Based Sky
This component generate a climate based sky for any hour of the year
IES Custom Lamp
This component can be used to specify a lamp of custom chromaticity, color or color temperature
IES Project
This component is meant for summarizing the details of all the luminaires used in a simulation
Watch The Sky
Watch The Sky

09 | Energy | HVACSystems

generationsystem
Use this component to create a Honeybee generator system
Load Open Studio Measure
This component loads OpenStudio measureds into Honeybee
simple Inverter
Provided by Honeybee 0
HVACSystems List (HVACSystemsList)
List of available HVAC templates that can be assigned to HBZones
Assign HVAC System
Use this component to assign OpenStudio Systems to your HBZones
HVAC Cooling Details
Use this component to set the parameters of a HVAC cooling system that has been assigned with the "Honeybee_HVAC Systems" component
HVAC Air Details
Use this component to set the parameters of a HVAC ventilation system (or air side) that has been assigned with the "Honeybee_Assign HVAC System" component
HVAC Heating Details
Use this component to set the parameters of a HVAC heating system that has been assigned with the "Honeybee_HVAC Systems" component
Generator PV
Provided by Honeybee 0

07 | Energy | Schedule

Daily Schedule
Use this component to make daily schedules for "Honeybee_AnnualSchedule"
Create CSV Schedule
Use this component to write custom
Seasonal Schedule
Use this component to generate a seasonal schedule (aka
Constant Schedule
Use this component to generate a schedule with a constant value or a schedule with 24 values that repeat in the same 24-hour pattern every day
Search EP Schedule Library
Filter EP Schedule Library
Annual Schedule
Use this component to generate schedules that can be assigned to HBZones
Decompose Energy Plus Schedule
Decompose Schedule
Call from EP Schedule Library
Call from EP Schedule Library
Convert Energy Plus Schedule to Values
Use this component to make a 3D chart in the Rhino scene of any climate data or hourly simulation data

05 | Energy | Building Program

List Zone Programs
Find list of spaces for each space based on program
Get Zone Energy Plus Loads
Look up loads for a Honeybee Zone
Get Energy Plus Loads
Look up loads for an specific bldgProgram and zoneProgram
bldg Programs (bldgPrograms)
Provides a list of available building programs from the template
Get Energy Plus Schedules
Look up schedules for an specific bldgProgram and zoneProgram
Get Zone Energy Plus Schedules
Look up schedules for a Honeybee Zone

13 | WIP

Import idf
import an idf file to gh
This version only imports the geometries
Constructions, schedules and systems will be neglected
Visualise Honeybeegeneration cashflow
Use this component to the calculate and visualise the financial value of Honeybee generation systems over 25 years
Condensation calculator
Use this component to calculate the Dew Point, Relative Humidity and Condensation on each layer of a wall
Customize Energy Plus Objects
Customize EnergyPlus Objects [NOT READY YET!]
Export EPC
Export to Energy Performace Calculator (EPC)

12 | Developers

Update Honeybee
This component [removes | updates] Honeybee components from [grasshopper | a source folder]

Video Tutorials

Site design © Robin Rodricks.   Co-created by Andrew Heumann.   Honeybee and associated data © 2020 Ladybug Tools.  
Rhinoceros and Grasshopper are registered trademarks of Robert McNeel & Associates.  Hosted by GitHub

Report an Issue  |  Terms of Service