Post on 08-Jul-2018
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 2/510
0
1
1.1
1.1.1
1.1.2
1.1.3
1.1.4
1.1.5
1.1.6
1.1.7
1.1.8
1.1.9
1.1.10
1.1.11
1.1.121.1.13
1.1.14
1.1.15
1.1.16
1.1.17
1.1.18
1.1.19
1.1.20
1.1.21
1.1.22
1.1.23
1.1.24
1.1.25
1.1.26
1.1.27
Table of Contents
What is this premier?
Components
00 | Honeybee
AskMe
Honeybee
IntersectMasses
SplitBuildingMass
DecomposeHBZone
Glazing_Par ameters_List
Glazing_based_on _ratio
Masses2Zones
Solve_Adjacencies
addHBGlz
createHBSrfs
createHBZonesDecompose_Based_On_Boundary_Condition
Decompose_Based_On_Type
Label_Zone_Surfaces
Label_Zones
Surface_Attribute_List
Zone_Attribute_List
Item_Selector
ChangeHBObjName
Get_or_Set_HB_Object_Name
PerimeterCoreZoning
Remove_Glazing
Select_by_Type
Separate_By_Normal
Separate_Zones_By_Floor
Separate_Zones_By_Orientation
Honeybee Primer
2
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 3/510
1.1.28
1.1.29
1.2
1.2.1
1.2.2
1.2.3
1.2.4
1.2.5
1.2.6
1.2.7
1.2.8
1.2.9
1.2.10
1.2.11
1.2.12
1.2.13
1.2.14
1.2.15
1.3
1.3.1
1.3.2
1.3.3
1.3.4
1.3.5
1.3.6
1.3.7
1.3.8
1.4
1.4.1
1.4.2
1.4.3
1.4.4
1.4.5
1.4.6
Separate_Zones_By_Program
Separate_conditioned_and_unconditioned_zones
01 | Daylight | Material
Radiance_Glass_Material
Radiance_Opaque_Material
Add_to_Radiance_Library
Call_from_Radiance_Library
Radiance_Materials_Info
Set_Radiance_Materials
Radiance_BSDF_Material
Radiance_Glass_Material_By_Color
Radiance_Metal_Material
Radiance_Metal_Material_By_Color
Radiance_Mirror_Material
Radiance_Mirror_Material_By_Color
Radiance_Opaque_Material_By_Color
Radiance_Trans_Material
Radiance_Trans_Material_By_Color
02 | Daylight | Sky
Generate_Climate_Based_Sky
Generate_Cumulative_Sky
Generate_Standard_CIE_Sky
Watch_The_Sky
Generate_Average_Sky
Generate_Custom_Sky
Generate_Dark_Sky
Generate_Sky_With_Certain_Illuminance_level
03 | Daylight | Recipes
Annual_Daylight_Simulation
Daylight_Factor_Simulation
Generate_Test_Points
Grid_Based_Simulation
Image_Based_Simulation
Vertical_Sky_Component
Honeybee Primer
3
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 4/510
1.4.7
1.4.8
1.4.9
1.4.10
1.4.11
1.4.12
1.4.13
1.5
1.5.1
1.5.2
1.5.3
1.5.4
1.5.5
1.5.6
1.5.7
1.5.8
1.5.9
1.5.10
1.5.11
1.5.12
1.5.13
1.5.14
1.5.15
1.5.16
1.5.17
1.5.18
1.5.19
1.5.20
1.5.21
1.5.22
1.5.23
1.5.241.5.25
DSParameters
RADParameters
Advanced_Dynamic_Shading_Recipe
Conceptual_Dynamic_Shading_Recipe
Daysim_Glare_Control_Recipe
Daysim_Shading_State
Generate_Zone_Test_Points
04 | Daylight | Daylight
Glare_Analysis
Run_Daylight_Simulation
Import_rad
Read_Annual_Result_I
Read_Annual_Result_II
Read_RAD_Result
Convert_HDR_to_GIF
FalseColor
Import_Pts_File
Import_dgp_File
Lookup_Daylighting_Folder
Daysim_Annual_Profiles
Daysim_Electrical_Lighting_Use
Daysim_Occupancy_Generator
Daysim_Occupancy_Generator_Based_On_List
Daysim_User_Profiles
Daysim_shading_group_sensors
Lighting_control_Recipe
Convert_HDR_to_TIF
Convert_TIF_to_HDR
MSH2RAD
Read_All_the_Hourly_Results_from_Annual_Daylight_Study
Read_DS_Result_for_a_point
Read_Hourly_Results_from_Annual_Daylight_StudyRefine_Daylight_Simulation
Honeybee Primer
4
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 5/510
1.5.26
1.6
1.6.1
1.6.2
1.6.3
1.6.4
1.7
1.7.1
1.7.2
1.7.3
1.7.4
1.7.5
1.7.6
1.7.7
1.7.8
1.7.9
1.7.10
1.7.11
1.7.12
1.7.13
1.8
1.8.1
1.8.2
1.8.3
1.8.4
1.8.5
1.8.6
1.8.7
1.9
1.9.1
1.9.2
1.9.3
1.9.4
1.9.5
Set_Exposure_for_HDR
05 | Energy | Building Program
ListZonePrograms
bldgPrograms
Get_EnergyPlus_Loads
Get_EnergyPlus_Schedules
06 | Energy | Material | Construction
EnergyPlus_Construction
EnergyPlus_NoMass_Opaque_Material
EnergyPlus_Window_Material
Search_EP_Construction
Add_to_EnergyPlus_Library
Call_from_EP_Construction_Library
Decompose_EP_Construction
Decompose_EP_Material
EnergyPlus_Glass_Material
EnergyPlus_Opaque_Material
EnergyPlus_Shade_Material
EnergyPlus_Window_Air_Gap
R-Value_With_Air_Films
07 | Energy | Schedule
Call_from_EP_Schedule_Library
Convert_EnergyPlus_Schedule_to_Values
Decompose_EnergyPlus_Schedule
Search_EP_Schedule_Library
Create_CSV_Schedule
Get_Zone_EnergyPlus_Loads
Get_Zone_EnergyPlus_Schedules
08 | Energy | Set Zone Properties
Set_EP_Zone_Construction
Set_EnergyPlus_Zone_Loads
Set_EnergyPlus_Zone_Schedules
Set_Loads_And_Schedules
AddEarthtube
Honeybee Primer
5
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 6/510
1.9.6
1.9.7
1.9.8
1.9.9
1.9.10
1.9.11
1.9.12
1.9.13
1.9.14
1.10
1.10.1
1.10.2
1.10.3
1.10.4
1.10.5
1.10.6
1.10.7
1.10.8
1.10.9
1.10.10
1.10.11
1.10.12
1.10.13
1.10.14
1.10.15
1.10.16
1.10.17
1.10.18
1.10.19
1.10.20
1.10.21
1.10.221.10.23
Create_EP_Ground
Create_EP_Plenum
Honeybee_Lighting_Density_Calculator
Honeybee_infORventPerArea_Calculator
Set_EP_Air_Flow
Set_EP_Surface_Construction
Set_EP_Zone_Interior_Construction
Set_EP_Zone_Underground_Construction
Set_EnergyPlus_Zone_Thresholds
09 | Energy | Energy
Export_To_OpenStudio
_Run_Energy_Simulation
Add_Internal_Mass_to_Zone
EnergyPlus_Window_Shade_Generator
Honeybee_EP_context_Surfaces
Make_Adiabatic_By_Type
Generate_EP_Output
OpenStudioHVACSystemsList
OpenStudio_Systems
Set_Ideal_Air_Loads_Parameters
Import_idf
Read_EP_Result
Read_EP_Surface_Result
Surface_Data_Based_On_Type_Detailed
Color_Surfaces_by_EP_Result
Color_Zones_by_EP_Result
Energy_Shade_Benefit_Evaluator
Optimal_Shade_Creator
Adaptive_Comfort_Analysis_Recipe
Indoor_View_Factor_Calculator
Microclimate_Map_Analysis
Outdoor_Comfort_Analysis_RecipePMV_Comfort_Analysis_Recipe
Honeybee Primer
6
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 7/510
1.10.24
1.10.25
1.10.26
1.10.27
1.10.28
1.10.29
1.10.30
1.10.31
1.10.32
1.10.33
1.10.34
1.10.35
1.11
1.11.1
1.11.2
1.11.3
1.11.4
1.11.5
1.11.6
1.11.7
1.11.8
1.12
1.12.1
1.13
1.13.1
1.13.2
1.13.3
1.13.4
1.13.5
1.13.6
1.13.7
1.13.8
1.13.9
1.13.10
Read_Microclimate_Matrix
Thermal_Autonomy_Analysis
Visualize_Microclimate_Map
Balance_Temperature_Calculator
Construct_Energy_Balance
Energy_Simulation_Par
Make_Adiabatic
Re-run_IDF
Read_EP_HVAC_Result
ShadowPar
Simulation_Control
Surface_Data_Based_On_Type
10 | Energy | AirsideSystems
OpenStudio_Air_Handler_Detail
OpenStudio_Airside_Economizer_Detail
OpenStudio_DX_Cooling_Coil
OpenStudio_DX_Heating_Coil
OpenStudio_Evaporative_Condenser
OpenStudio_Fan_Detail
OpenStudio_Mechanical_Controller
OpenStudio_Availability_Manager_List
11 | Developers
Update_Honeybee
12 | WIP
Apply_OpenStudio_Measure
Convert_IMG
Create_Pollinator
Customize_EnergyPlus_Objects
ExportEPC
Extrude_Windows
GrizzlyBear
Import_IES
Load_OpenStudio_Measure
open_Pollination
Honeybee Primer
7
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 8/510
1.13.11
1.13.12
1.13.13
1.13.14
1.13.15
1.13.16
1.13.17
1.13.18
1.13.19
1.13.20
1.13.21
1.13.22
1.13.23
1.13.24
1.13.25
1.13.26
1.13.27
1.13.28
1.13.29
1.13.30
1.13.31
1.13.32
1.13.33
1.13.34
1.13.35
Get_Annual_SQL_Data
OpenStudio_Central_Plant_Orchestrator
OpenStudio_Cooling_Tower
OpenStudio_EIR_Chiller
OpenStudio_Hot_Water_Boiler
FileExplorer
Generator_PV
Generator_Wind_Horizontialaxis
generationsystem
simple_Inverter
Create_Therm_Boundaries
Create_Therm_Polygons
Import_THERM_XML
Read_THERM_Result
Therm_Material
Therm_Material_to_EnergyPlus_Material
Write_THERM_File
Mirror_Honeybee
Move_Honeybee
Rotate_Honeybee
IES_Custom_Lamp
IES_Luminaire
IES_Luminaire_Zone
Read_generation_system_results
Visualise_Honeybeegeneration_cashflow
Honeybee Primer
8
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 9/510
honeybee-primer
This primer is generated by script. Feel free to edit the pages and send pull requests. Here
is the source of this primer .
Honeybee for Grasshopper Honeybee connects Grasshopper3D to EnergyPlus, Radiance, Daysim and OpenStudio for
building energy and daylighting simulation.The Honeybee project intends to make many of
the features of these simulation tools available in a parametric way.
You need to have Ladybug installed in order to run Honeybee.
Honeybee Primer
9What is this premier?
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 10/510
Useful links
Honeybee on Github
Honeybee group page on Grasshopper
Facebook page
Honeybee on Twitter
Honeybee Primer
10What is this premier?
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 11/510
Component list:
AskMe
Honeybee IntersectMasses
SplitBuildingMass
DecomposeHBZone
Glazing_Parameters_List
Glazing_based_on_ratio
Masses2Zones
Solve_Adjacencies
addHBGlz
createHBSrfs
createHBZones
Decompose_Based _On_Boundary_Condition
Decompose_Based_On_Type
Label_ Zone_Surfaces
Label_ Zones
Surface_Attribute_ List
Zone_ Attribute_List
Item_Selector
ChangeHBObjName
Get_or_Set_HB_Object_Name
PerimeterCoreZoning Remove_Glazing
Select_by_Type
Separate_By_Normal
Separate_Zones_By_Floor
Separate_Zones_By_Orientation
Separate_Zones_By_Program
Separate_conditioned_and_unconditioned_zones
Honeybee Primer
1100 | Honeybee
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 12/510
AskMe
Use this component to get basic information on Honeybee Objects, whether they are HBSrfs
or HBZones. -
Inputs
HBObjects [Required]
Any valid Honeybee object.
Outputs
Honeybee Primer
12 AskMe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 13/510
readMe!
Information about the Honeybee object. Connect to a panel to visualize.
Check Hydra Example Files for AskMe
Honeybee Primer
13 AskMe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 14/510
Honeybee
This component carries all of Honeybee's main classes. Other components refer to these
classes to run the studies. Therefore, you need to let her fly before running the studies so
the classes will be copied to Rhinos shared space. So let her fly! - Honeybee: A Plugin for
Environmental Analysis (GPL) started by Mostapha Sadeghipour Roudsari You should have
received a copy of the GNU General Public License along with Honeybee; If not, see
http://www.gnu.org/licenses/ . @license GPL-3.0+ http://spdx.org/licenses/GPL-3.0+ Source
code is available at: https://github.com/mostaphaRoudsari/Honeybee -
Inputs
Honeybee Primer
14Honeybee
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 15/510
defaultFolder [Optional]
Optional input for Honeybee default folder. If empty default folder will be set to
C:\ladybug or C:\Users\%USERNAME%\AppData\Roaming\Ladybug\
Outputs
Vviiiiiiiiiizzz!
Current Honeybee mood!!!
Check Hydra Example Files for Honeybee
Honeybee Primer
15Honeybee
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 16/510
IntersectMasses
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. Matching surfaces and surface areas betweem
adjacent zones are necessary to ensure that the conductive heat flow calculation occurs
correctly across the surfaces in an energy simulation. Note that the input here should be
closed volumes that are adjacent to each other and touching. They should not volumetrically
overlap. Also note that, while the component has been written in a manner that rarely fails if
the input geometry obeys the provisions above, there are still some very complex cases thatcan be incorrect. As such, it is recommended that you bake the output of this component
Honeybee Primer
16IntersectMasses
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 17/510
and check it in Rhino before turning the breps into HBZones. This component will get you
most of the way there but these volumetric operations can be difficult to pull off with a
surface modeler like Rhino so you should really check the output. -
Inputs
bldgMassesBefore [Required]
Script input bldgMassesBefore.
Outputs
bldgMassesAfter
The same input closed breps that have had their component surfaces split by adjacentpolysurfaces to have matching surfaces between adjacent breps. It is recommended
that you bake this output and check it in Rhino before turning the breps into HBZones.
Check Hydra Example Files for IntersectMasses
Honeybee Primer
17IntersectMasses
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 18/510
SplitBuildingMass
Use this component to divide up a brep (polysurface) representative of a complete building
massing into smaller volumes that roughly correspond to how a generic EnergyPlus model
should be zoned. This generic zoning will divide the input mass into seprate floors based on
an input floor height. This zoning can also divide up each floor into a core and perimeter
zones, which helps account for the different microclimates you would get on each of the
different orientations of a building. If you have a single mass representing two towers off of a
podium, the two towers are not a continuous mass and you should therefore send each
tower and the podium in as a separate Brep into this component. The component will work for courtyard buildings. Core and perimeter zoneing should work for almost all masses
where all walls are planar. It works in a limited number of cases that have both curved and
Honeybee Primer
18SplitBuildingMass
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 19/510
planar walls. Also, it is important to note that, if your offset depth is so large in comparison to
your building depth as to create perimeter zones that intersect one another, the whole floor
will be returned as a single zone. While this component can usually get you the most of the
way there, it is still recommended that you bake the output and check the geometry in Rhino
before turning the breps into HBZones. The assumption about an E+ zone is that the air is
well mixed and all at the same temperature. Therefore, it is usually customary to break up a
building depending on the areas where you would expect different building microclimates to
exist. This includes breaking up the building into floors (since each floor can have a different
microclimate) and breanking up each floor into a core zone and perimeter zones (since each
side of the buidling gets a different amount of solar gains and losses/gains through the
envelope). This component helps break up building masses in such a manner. -
Inputs
bldgMasses [Required]
A Closed brep or list of closed breps representing a building massing.
bldgsFlr2FloorHeights [Optional]
A list of floor heights in Rhino model units that will be used to make each floor of the
building. The list should run from bottom floor to top floor. Alternatively, you can input a
text string that codes for how many floors of each height you want. For example,
inputting "2@4" (without quotations) will make two ground floors with a height of 4 Rhino
model units. Simply typing "@3" will make all floors 3 Rhino model units. Putting in lists
of these text strings will divide up floors accordingly. For example, the list "1@5 2@4
@3" will make a ground floor of 5 units, two floors above that at 4 units and all
remaining floors at 3 units.
perimeterZoneDepth [Optional]
A list of perimeter zone depths in Rhino model units that will be used to divide up each
floor of the building into core and perimeter zones. The list should run from bottom floor
to top floor. Alternatively, you can input a text string that codes for which floors you want
at which zone depth. For example, inputting "2@4" (without quotations) will divide up
the two ground floors with a perimeter zone depth of 4 Rhino model units. Simply typing
"@3" will divide up all floors with a zone depth of 3 Rhino model units. Putting in lists of
these text strings will divide up floors accordingly. For example, the list "1@5 2@4 @3"
will make a ground floor divided up with a zone depth of 5 units, two floors divided at 4
units and all remaining floors at 3 units.
runIt [Required]
Honeybee Primer
19SplitBuildingMass
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 20/510
Script variable Python
Outputs
readMe!
...
splitBldgMasses
The building mass split up into zone geometries.
Check Hydra Example Files for SplitBuildingMass
Honeybee Primer
20SplitBuildingMass
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 21/510
DecomposeHBZone
Decompose Honeybee Zone -
Inputs
HBZone [Required]
Honeybee Zone
Outputs
Honeybee Primer
21DecomposeHBZone
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 22/510
HBSurfaces
Honeybee Surfaces
Check Hydra Example Files for DecomposeHBZone
Honeybee Primer
22DecomposeHBZone
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 23/510
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. Depeding on your
intended use of the numbers connected to this component, they should be plugged into the
glzRatio, breakUpWindow , windowHeight, sillHeight , or splitGlzVertically_ inputs of the
"Glazing based on ratio" component. -
Inputs
northGlzParam [Default]
Honeybee Primer
23Glazing_Parameters_List
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 24/510
Glazing parameter for the north side of a building.
westGlzParam [Default]
Glazing parameter for the west side of a building.
southGlzParam [Default]
Glazing parameter for the south side of a building.
eastGlzParam [Default]
Glazing parameter for the east side of a building.
Outputs
glzParamList
A list of glazing parameters for different cardinal directions to be plugged into either the
glzRatio, breakUpWindow , windowHeight, sillHeight , or splitGlzVertically_ input of the
"Glazing based on ratio" component.
Check Hydra Example Files for Glazing Parameters List
Honeybee Primer
24Glazing_Parameters_List
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 25/510
Glazing based on ratio
Use this component to generate windows for a HBSurface or HBZone based on a desired
window-to-wall ratio. In addition to generating window geometry that corresponds with the
input ratio, this component also allows you a fairly high level of control over the window
geometry. The first way in which you gain additional control over geometry is the option of
whether you want to generate a single window for each surface, which is good for making
energy simulations run fast, or you want to use the glazig ratio to create several windows
distributed across the surfaces, which is often necessary to have accurate daylight
simulations or high-resolution thermal maps. If you break up the window into several ones,you also have the ability to set the distance between each of the windows along the surface.
Honeybee Primer
25Glazing_based_on_ratio
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 26/510
If you input wall surfaces that have perfectly horizontal tops and/or bottoms, you also have
access to a number of other other inputs such as window height, the sill height, and whether
you want to split the glazing vertically into two windows. -
Inputs
HBObjects [Required]
Honeybee thermal zones or surfaces for which glazing should be generated.
glzRatio [Required]
The fraction of the wall surface that should be glazed. This input only accepts values
between 0 and 0.95 (we don't go all of the way up to 1 because EnergyPlus does not
like this). This input can also accept lists of values and will assign different glazing ratiosbased on cardinal direction, starting with north and moving counter-clockwise. Note that
glazing ratio always takes priority over the windowHeight and sillHeight inputs below.
breakUpWindow [Optional]
Set to "True" to generate a distributed set of multiple windows on walls and set to
"False" to generate just a single window per rectangular wall surface. This input can
also accept lists of boolean values and will assign different 'BreakUpWindow' values
based on cardinal direction, starting with north and moving counter-clockwise. A singlewindow for each surface is good for making energy simulations run fast while several
distributed windows is often necessary to have accurate daylight simulations or high-
resolution thermal maps. The default is set to "True" to generate multiple distributed
windows.
breakUpDist [Optional]
An optional number in Rhino model units that sets the distance between individual
windows on rectangular surfaces when the breakUpWindow_ input above is set to'True'. This input can also accept lists of values and will assign different sill heights
based on cardinal direction, starting with north and moving counter-clockwise. Note that
this input will be over-ridden at high glazing ratios or window heights. The default is set
to 2 meters.
windowHeight [Optional]
An optional number in Rhino model units that sets the height of your windows on
rectangular surfaces when the breakUpWindow_ input above is set to 'True'. This inputcan also accept lists of values and will assign different window heights based on
cardinal direction, starting with north and moving counter-clockwise. Note that this input
Honeybee Primer
26Glazing_based_on_ratio
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 27/510
will be over-ridden at high glazing ratios. The default is set to 2 meters.
sillHeight [Optional]
An optional number in Rhino model units that sets the distance from the floor to the
bottom of your windows on rectangular surfaces when the breakUpWindow_ input
above is set to 'True'. This input can also accept lists of values and will assign different
sill heights based on cardinal direction, starting with north and moving counter-
clockwise. Note that this input will be over-ridden at high glazing ratios or window
heights. The default is set to 0.8 meters (or 80 centimeters).
splitGlzVertDist [Optional]
An optional number in Rhino model units that splits the windows on rectangular
surfaces into two with a vertical distance between them equal to this input when the
breakUpWindow_ input above is set to 'True'. This input can also accept lists of values
and will assign different vertical distances based on cardinal direction, starting with
north and moving counter-clockwise. Note that this input will be over-ridden at high
glazing ratios, high window heights, or high sill heights.
skyLightRatio [Optional]
If you have input a full zone or list of zones as your HBObjects, use this input to
generate skylights on the roof surfaces. A single window for each surface is good for making energy simulations run fast while several distributed windows is often necessary
to have accurate daylight simulations or high-resolution thermal maps. The default is set
to "True" to generate multiple distributed windows.
breakUpSkylight [Optional]
Set to "True" to generate a distributed set of multiple windows for skylights and set to
"False" to generate just a single window per roof surface.
skyLightBreakUpDist [Optional]
An optional number in Rhino model units that sets the distance between individual
skylights when the breakUpSkylight_ input above is set to 'True'. The default is set to 3
meters.
runIt [Required]
set runIt to True to generate the glazing
Outputs
Honeybee Primer
27Glazing_based_on_ratio
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 28/510
readMe!
...
HBObjWGLZ
Newhoneybee zones that contain glazing surfaces based on the parameters above.
Check Hydra Example Files for Glazing based on ratio
Honeybee Primer
28Glazing_based_on_ratio
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 29/510
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. This includes
constructions of the surfaces, boundary condtions of all of the surfaces (ie ground, exterior,
etc), schedules+ loads for occupancy/internal electronics, and settings for an HVAC system
if isContitioned is set to True. -
Inputs
zoneMasses [Required]
Honeybee Primer
29Masses2Zones
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 30/510
A list of closed breps or a single closed brep that represents the geometry of the zone(s)
that will be output from this component.
zoneNames [Optional]
A list of names for the zones that will be output from this component. Default names will
be applied to zones based on their order in the list if this value is left empty.
zonePrograms [Optional]
A list of zone programs from the Honeybee_ListZonePrograms component that matches
the number of breps in the _zoneMasses list. These zone programs will be applied to
the zones that are output from this component and will be used to set the shcedules and
loads of these programs. This input can also be a single zoneProgram to be applied to
all of the coneected zones. If no value is connected here, the zone program
Office::OpenOffice will be applied to the zones.
isConditioned [Optional]
A list of True/False values that matches the number of breps in the _zoneMasses list.
These True/False values will be applied to the ouput zones to either condition them with
an Ideal Air Loads System (True) or not condition them at all (False). This input can also
be a single True/False value that can be applied to all of the connected zones. If no
value is connected here, all zones will be conditioned with an Ideal Air Loads System bydefault.
maxRoofAngle [Optional]
Maximum angle from z vector that the surface will be assumed as a roof. Default is 30
degrees
createHBZones [Required]
Set to True to generate the zones and assign energy simulation properties to your connected _zoneMasses.
Outputs
readMe!
...
HBZones
Honeybee zones that have all of the properties necessary for an energy simulation
Honeybee Primer
30Masses2Zones
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 31/510
assigned to them. Connect these to a "Honeybee_Label Zones" component to see
some of these properties.
Check Hydra Example Files for Masses2Zones
Honeybee Primer
31Masses2Zones
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 32/510
Solve Adjacencies
Solve adjacencies -
Inputs
HBZones [Required]
A list of Honeybee zones for which you want to calculate whether they are next to each
other.
altConstruction [Optional]
Honeybee Primer
32Solve_Adjacencies
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 33/510
An optional alternate EP construction to assign to all adjacent surfaces. The default is
set to be "Interior Wall", "Interior Foor" or "Interior Ceiling" or "Interior Window"
depending on the type of surface that is adjacent.
altBC [Optional]
An optional alternate boundary condition such as "Adiabatic". The default will be
"Surafce", which ensures that heat flows across each adjacent surface to a neighboring
zone.
tolerance [Optional]
The tolerance in Rhino model units that will be used determine whether two zones are
adjacent to each other. If no value is input here, the component will use the tolerance of
the Rhino model document.
removeCurrentAdjc [Optional]
If you are using this component after already solving for the adjacencies between some
of the zones previously, set this to "False" in order to remeber the previously determined
adcacency conditions. If set to "True", the current adjacencies will be removed. The
default is set to "False" in order to remeber your previously-set adjacencies.
findAdjc [Required]
Set to "True" to solve adjacencies between zones.
Outputs
readMe!
A report of the found adjacencies.
HBZonesWADJ
A list of Honeybee zones with adjacencies solved.
Check Hydra Example Files for Solve Adjacencies
Honeybee Primer
33Solve_Adjacencies
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 34/510
addHBGlz
Use this component to add a custom glazing surface to a HBSurface or HBZone. -
Inputs
HBObj [Required]
A HBZone or HBSurface to which you would like to add a customized glazing surface.
childSurfaces [Required]
A surface or list of surfaces that represent the custom window(s) that you would like to
Honeybee Primer
34addHBGlz
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 35/510
add. Note that these surfaces should be co-planar to the connected HBSurface or one
of the surfaces of the connected HBZones.
childSurfacesName [Optional]
An optional list of names for child surfaces. If names are provided the length of names
should be the same as _childSurfaces.
EPConstructions [Optional]
An optional EnergyPlus construction to set the material construction of the window
added to the HBSurface or HBZone. This can be either the name of a window
construction from the OpenStudio library (coming out of the 'Honeybee_Call from EP
Construction Library' component) or a custom window construction you created from the
'Honeybee_EnergyPlus Construction' component.
RADMaterials [Optional]
An optional Radiance material to set the material of the window added to the HBSurface
or HBZone. This can be either the name of a window material from the default Radaince
library (coming out of the 'Honeybee_Call from Radiance Library' component) or a
custom window material you created from any of the Radiance material components
(like the 'Honeybee_Radiance Glass Material' component).
Outputs
HBObjWGLZ
The Honeybee surface or zone with assigned glazing (in case of success).
Check Hydra Example Files for addHBGlz
Honeybee Primer
35addHBGlz
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 36/510
createHBSrfs
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. -
Inputs
geometry [Required]
List of Breps
Honeybee Primer
36createHBSrfs
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 37/510
srfName [Optional]
Optional name for surface
srfType [Optional]
Optional input for surface type > 0- 'WALL' 0.5- 'UndergroundWall' 1- 'ROOF' 1.5-
'UndergroundCeiling' 2- 'FLOOR' 2.25- 'UndergroundSlab' 2.5- 'SlabOnGrade' 2.75-
'ExposedFloor' 3- 'CEILING' 4- 'AIRWALL' 5- 'WINDOW' 6- 'SHADING'
EPBC [Optional]
'Ground', 'Adiabatic', 'Outdoors'
EPConstruction [Default]
Optional EnergyPlus construction
RADMaterial [Default]
Optional Radiance Material
Outputs
readMe!
...
HBSurface
Honeybee zone as the result
Check Hydra Example Files for createHBSrfs
Honeybee Primer
37createHBSrfs
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 38/510
createHBZones
Create an HBZone from HB Surfaces
-
Inputs
name [Required]
The name of the zone as a string
Honeybee Primer
38createHBZones
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 39/510
zoneProgram [Optional]
Optional input for the program of this zone
HBSurfaces [Required]
A list of Honeybee Surfaces
isConditioned [Optional]
True/False value. This value will be applied to the ouput zone to either condition them
with an Ideal Air Loads System (True) or not condition them at all (False). If no value is
connected here, all zones will be conditioned with an Ideal Air Loads System by default.
Outputs
readMe!
...
HBZone
Honeybee zone as the result
Check Hydra Example Files for createHBZones
Honeybee Primer
39createHBZones
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 40/510
Decompose Based On Boundary Condition
Decompose zone surfaces by boundary condition -
Inputs
HBZone [Required]
Honeybee Zone
Outputs
Honeybee Primer
40Decompose_Based_On_Boundary_Condition
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 41/510
outdoors
A list of surfaces which has outdoors boundary condition
surface
A list of surfaces which has surface boundary condition
adiabatic
A list of surfaces which has adiabatic boundary condition
ground
A list of surfaces which has ground boundary condition
Check Hydra Example Files for Decompose Based On Boundary Condition
Honeybee Primer
41Decompose_Based_On_Boundary_Condition
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 42/510
Decompose Based On Type
Use this component to break down the geometry of your zone by the surface type. This is
useful for previewing your zones in the rhino scene and making sure that each surface of
your zones has the correct surface type. -
Inputs
HBZone [Required]
Honeybee Zones for which you want to preview the different surface types.
Honeybee Primer
42Decompose_Based_On_Type
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 43/510
Outputs
walls
A list of the exterior walls of your zones as breps. Connect to a Grasshopper "Preview"
component to add color to the breps.
interiorWalls
A list of the interior walls of your zones as breps. Connect to a Grasshopper "Preview"
component to add color to the breps.
airWalls
A list of the air walls of your zones as breps. Connect to a Grasshopper "Preview"
component to add color to the breps.
windows
A list of windows of your zones as breps. Connect to a Grasshopper "Preview"
component to add color to the breps.
interiorWindows
A list of interior windows of your zones as breps. Connect to a Grasshopper "Preview"
component to add color to the breps.
skylights
A list of skylights of your zones as breps. Connect to a Grasshopper "Preview"
component to add color to the breps.
roofs
A list of roofs of your zones as breps. Connect to a Grasshopper "Preview" component
to add color to the breps.
ceilings
A list of ceilings of your zones as breps. Connect to a Grasshopper "Preview"
component to add color to the breps.
floors
A list of floors of your zones as breps. Connect to a Grasshopper "Preview" componentto add color to the breps.
Honeybee Primer
43Decompose_Based_On_Type
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 44/510
exposedFloors
A list of floors exposed to the outside air as breps. Connect to a Grasshopper "Preview"
component to add color to the breps.
groundFloors
A list of ground floors of your zones as breps. Connect to a Grasshopper "Preview"
component to add color to the breps.
undergroundWalls
A list of underground walls of your zones as breps. Connect to a Grasshopper "Preview"
component to add color to the breps.
undergroundSlabs
A list of underground floor slabs of your zones as breps. Connect to a Grasshopper
"Preview" component to add color to the breps.
undergroundCeilings
A list of underground ceilings of your zones as breps. Connect to a Grasshopper
"Preview" component to add color to the breps.
shadings
A list of shadings of your zones as breps. Connect to a Grasshopper "Preview"
component to add color to the breps.
Check Hydra Example Files for Decompose Based On Type
Honeybee Primer
44Decompose_Based_On_Type
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 45/510
Label Zone Surfaces
Use this component to lablel HBSurfaces or HBZones with their names or energy/daylight
properties in the Rhino scene. This is useful for checking whether certain properties have
been assigned correctly. -
Inputs
HBObjects [Required]
The HBZones out of any of the HB components that generate or alter zones. Note that
these should ideally be the zones that are fed into the Run Energy Simulation
Honeybee Primer
45Label_Zone_Surfaces
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 46/510
component. Zones read back into Grasshopper from the Import idf component will not
align correctly with the EP Result data.
attribute [Optional]
A text string for the surface attribute that you are interested in lableing the surfaces with.
Possible inputs include "name", "construction" or any other Honeybee attribute. Use the
"Honeybee_Surface Attribute List" to see all possibilities.
windows [Optional]
Set to "True" to have the component label the window surfaces in the model instead of
the opaque surfaces. By default, this is set to "False" to label just the opaque surfaces.
textHeight [Optional]
An optional number for text height in Rhino model units that can be used to change the
size of the label text in the Rhino scene. The default is set based on the dimensions of
the zones.
font [Optional]
An optional number that can be used to change the font of the label in the Rhino scene.
The default is set to "Verdana".
recallHBHive [Optional]
Set to "True" to recall the zones from the hive each time the input changes and "False"
to simply copy the zones to memory. Calling the zones from the hive can take some
more time but this is necessary if you are making changes to the zones and you want to
check them. Otherwise, if you are just scrolling through attributes, it is nice to set this to
"False" for speed. The default is set to "True" as this is safer.
Outputs
surfaceTxtLabels
The names of each of the connected zone surfaces.
labelBasePts
The basepoint of the text labels. Use this along with the surfaceAttributes ouput above
and a GH "TexTag3D" component to make your own lables.
brepTxtLabels
Honeybee Primer
46Label_Zone_Surfaces
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 47/510
A set of surfaces indicating the names of each zone surface as they correspond to the
branches in the EP surface results.
surfaceWireFrames
Script variable Python
Check Hydra Example Files for Label Zone Surfaces
Honeybee Primer
47Label_Zone_Surfaces
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 48/510
Label Zones
Use this component to lablel zones with their names in the Rhino scene. This can help
ensure that the correct names are assigned to each zone and can help keep track of zones
and zone data throughout analysis. -
Inputs
HBZones [Required]
The HBZones out of any of the HB components that generate or alter zones. Note that
these should ideally be the zones that are fed into the Run Energy Simulation
Honeybee Primer
48Label_Zones
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 49/510
component. Zones read back into Grasshopper from the Import idf component will not
align correctly with the EP Result data.
attribute [Optional]
A text string for the zone attribute that you are interested in lableing the zones with.
Possible inputs include "name", "zoneProgram", "isConditioned" or any other Honeybee
attribute. Use the "Honeybee_Zone Attribute List" to see all possibilities.
textHeight [Optional]
An optional number for text height in Rhino model units that can be used to change the
size of the label text in the Rhino scene. The default is set based on the dimensions of
the zones.
font [Optional]
An optional number that can be used to change the font of the label in the Rhino scene.
The default is set to "Verdana".
recallHBHive [Optional]
Set to "True" to recall the zones from the hive each time the input changes and "False"
to simply copy the zones to memory. Calling the zones from the hive can take some
more time but this is necessary if you are making changes to the zones and you want tocheck them. Otherwise, if you are just scrolling through attributes, it is nice to set this to
"False" for speed. The default is set to "True" as this is safer.
Outputs
zoneTxtLabels
The label names of each of the connected zones. Connect this ouput and the one bleow
to a Grasshopper "TexTag3D" component to make your own lables.
labelBasePts
The basepoint of the text labels. Use this along with the ouput above and a
Grasshopper "TexTag3D" component to make your own lables.
brepTxtLabels
A set of surfaces indicating the names of each zone as they correspond to the branches
in the EP results and the name of the zone in the headers of data.
Honeybee Primer
49Label_Zones
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 50/510
zoneWireFrames
Script variable Python
Check Hydra Example Files for Label Zones
Honeybee Primer
50Label_Zones
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 51/510
Surface Attribute List
Provides a list of surface attributes to choose from and plug into the Honeybee_Label
Surfaces Component
Inputs
Check Hydra Example Files for Surface Attribute List
Honeybee Primer
51Surface_Attribute_List
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 52/510
Zone Attribute List
Provides a list of preset values to choose from
Inputs
Check Hydra Example Files for Zone Attribute List
Honeybee Primer
52Zone_Attribute_List
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 53/510
ChangeHBObjName
Change Honeybee Object Names -
Inputs
HBObjects [Required]
Script variable Python
names [Required]
List of new names for HBObjects
Honeybee Primer
53ChangeHBObjName
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 54/510
Outputs
HBObjects
Script variable Python
Check Hydra Example Files for ChangeHBObjName
Honeybee Primer
54ChangeHBObjName
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 55/510
Get or Set HB Object Name
Change Honeybee Object Names -
Inputs
HBObjects [Required]
Script variable Python
names [Optional]
List of new names for HBObjects
Honeybee Primer
55Get_or_Set_HB_Object_Name
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 56/510
Outputs
HBObjects
Renamed Honeybee objects
names
Renamed Honeybee objects
Check Hydra Example Files for Get or Set HB Object Name
Honeybee Primer
56Get_or_Set_HB_Object_Name
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 57/510
PerimeterCoreZoning
Separate zones into perimeter and core -
Inputs
HBZones [Required]
Script variable Python
Outputs
Honeybee Primer
57PerimeterCoreZoning
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 58/510
perimeters
Script output perimeters.
interiors
Script output interiors.
Check Hydra Example Files for PerimeterCoreZoning
Honeybee Primer
58PerimeterCoreZoning
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 59/510
Remove Glazing
Remove Glazing -
Inputs
HBZones [Required]
A list of Honeybee Zones, this component can only use Honeybee Zones
srfIndex [Optional]
Currently not functional do not connect anything here...
Honeybee Primer
59Remove_Glazing
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 60/510
pattern [Optional]
Currently not functional do not connect anything here...
windowName [Optional]
The names of windows to remove, you can get the names of windows from the
surfaceTxtLabels output of the component Honeybee_Label Zone Surfaces.
Outputs
readMe!
Information about the Honeybee object
Pattern to remove glazings from
surfaces. E.g a list of True,False will
remove every second glazing assuming
every surface in each Honeybee zone
has a glazing.
HBZones
Script variable changeName
Check Hydra Example Files for Remove Glazing
Honeybee Primer
60Remove_Glazing
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 61/510
Select by Type
Select surfaces by type -
Inputs
HBZones [Required]
Honeybee Zones
showWalls [Default]
Set to true to output the walls
Honeybee Primer
61Select_by_Type
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 62/510
showWindows [Default]
Set to true to output the windows
showAirWalls [Default]
Set to true to output the air walls
showFloors [Default]
Set to true to output the floors
showCeilings [Default]
Script input showCeilings.
showRoofs [Default]
Set to true to output the roofs
Outputs
surfaces
Output surfaces as Grasshopper objects
HBSurfaces
The output surfaces as Honeybee surfaces
Check Hydra Example Files for Select by Type
Honeybee Primer
62Select_by_Type
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 63/510
Separate By Normal
Separate surfaces by normal -
Inputs
geometry [Required]
Brep geometries
maxUpDecAngle [Default]
Maximum normal declination angle from ZAxis that should be still considerd up
Honeybee Primer
63Separate_By_Normal
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 64/510
maxDownDecAngle [Default]
Maximum normal declination angle from ZAxis that should be still considerd down
Outputs
lookingUp
List of surfaces which are looking upward
lookingDown
List of surfaces which are looking downward
lookingSide
List of surfaces which are looking to the sides
Check Hydra Example Files for Separate By Normal
Honeybee Primer
64Separate_By_Normal
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 65/510
Separate Zones By Floor
Separate zones based on floor height -
Inputs
HBZones [Required]
List of HBZones
Outputs
Honeybee Primer
65Separate_Zones_By_Floor
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 66/510
floorHeights
List of floor heights
HBZones
Honeybee zones. Each branch represents a different floor
Check Hydra Example Files for Separate Zones By Floor
Honeybee Primer
66Separate_Zones_By_Floor
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 67/510
Separate Zones By Orientation
Separate zones based on orientation -
Inputs
HBZones [Required]
List of HBZones
onlyWGlz [Optional]
Only consider surfaces with glazing
Honeybee Primer
67Separate_Zones_By_Orientation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 68/510
Outputs
orientations
List of orientation vectors
HBZones
Honeybee zones. Each branch represents a different orientation
Check Hydra Example Files for Separate Zones By Orientation
Honeybee Primer
68Separate_Zones_By_Orientation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 69/510
Separate Zones By Program
Separate zones based on zone program -
Inputs
HBZones [Required]
List of HBZones
Outputs
Honeybee Primer
69Separate_Zones_By_Program
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 70/510
zonePrograms
List of programs
HBZones
Honeybee zones. Each branch represents a different program
Check Hydra Example Files for Separate Zones By Program
Honeybee Primer
70Separate_Zones_By_Program
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 71/510
Separate conditioned and unconditionedzones
Separate zones into conditioned and unconditioned -
Inputs
HBZones [Required]
List of Honeybee zones
Outputs
Honeybee Primer
71Separate_conditioned_and_unconditioned_zones
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 72/510
conditionedZones
List of conditioned Honeybee zones
unconditionedZones
List of unconditioned Honeybee zones
Check Hydra Example Files for Separate conditioned and unconditioned zones
Honeybee Primer
72Separate_conditioned_and_unconditioned_zones
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 73/510
Component list:
Radiance_Glass_Material
Radiance_Opaque_Material Add_to_Radiance_Library
Call_from_Radiance_Library
Radiance_Materials_Info
Set_Radiance_Materials
Radiance_BSDF_Material
Radiance_Glass_Material_By_Color
Radiance_Metal_Material
Radiance_Metal_Material_By_Color
Radiance_Mirror_Material
Radiance_Mirror_Material_By_Color
Radiance_Opaque_Material_By_Color
Radiance_Trans_Material
Radiance_Trans_Material_By_Color
Honeybee Primer
7301 | Daylight | Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 74/510
Radiance Glass Material
Radiance Glass Material Read more here to understand Radiance materials:
http://www.artifice.com/radiance/rad_materials.html -
Inputs
materialName [Required]
Unique name for this material
RTransmittance [Required]
Honeybee Primer
74Radiance_Glass_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 75/510
Transmittance for red. The value should be between 0 and 1
GTransmittance [Required]
Transmittance for green. The value should be between 0 and 1
BTransmittance [Required]
Transmittance for blue. The value should be between 0 and 1
refractiveIndex [Optional]
RefractiveIndex is 1.52 for glass and 1.4 for ETFE
Outputs
avrgTrans
Average transmittance of this glass
RADMaterial
Radiance Material string
Check Hydra Example Files for Radiance Glass Material
Honeybee Primer
75Radiance_Glass_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 76/510
Radiance Opaque Material
Radiance Opaque Material Create a Standard Radiance Opaque Material. Many thanks to
Axel Jacobs for his help and all the great resources he provided at jaloxa.eu Check out the
color picker to see some great examples >
http://www.jaloxa.eu/resources/radiance/colour_picker/index.shtml -
Inputs
materialName [Required]
Script input materialName.
Honeybee Primer
76Radiance_Opaque_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 77/510
RReflectance [Required]
Diffuse reflectance for red
GReflectance [Required]
Diffuse reflectance for green
BReflectance [Required]
Diffuse reflectance for blue
roughness [Default]
Roughness values above 0.2 are uncommon
specularity [Default]
Specularity values above 0.1 are uncommon
Outputs
avrgRef
Average diffuse reflectance of the material
RADMaterial
Radiance Material string
Check Hydra Example Files for Radiance Opaque Material
Honeybee Primer
77Radiance_Opaque_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 78/510
Add to Radiance Library
Add Radiance Materials to Library -
Inputs
RADMaterial [Required]
Radiance material definition
addToProjectLib [Required]
Set to True to add the material to HB library for this project
Honeybee Primer
78 Add_to_Radiance_Library
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 79/510
overwrite [Optional]
Set to True if you want to overwrite the material with similar name
addToHoneybeeLib [Optional]
Set to True to Honeybee material libaray. Materials in addToHoneybeeLib library will be
loaded anytime that you let the 'bee fly. You can add the materials manually to
C:\ladybug\HoneybeeRadMaterials.mat
Outputs
readMe!
...
Check Hydra Example Files for Add to Radiance Library
Honeybee Primer
79 Add_to_Radiance_Library
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 80/510
Call from Radiance Library
Call Radiance Materials from Library -
Inputs
keywords [Optional]
List of keywords to filter the list of materials
materialTypes [Optional]
Material types to be shown (e.g. plastic, glass, trans, metal, mirror)
Honeybee Primer
80Call_from_Radiance_Library
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 81/510
Outputs
materials
Script output materials.
Check Hydra Example Files for Call from Radiance Library
Honeybee Primer
81Call_from_Radiance_Library
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 82/510
Radiance Materials Info
Radiance Materials Info -
Inputs
RADMaterial [Required]
Radiance material name
Outputs
Honeybee Primer
82Radiance_Materials_Info
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 83/510
RADMaterialStr
Radiance material definition
Check Hydra Example Files for Radiance Materials Info
Honeybee Primer
83Radiance_Materials_Info
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 84/510
Set Radiance Materials
Radiance Default Materials -
Inputs
HBObject [Required]
List of Honeybee zones or surfaces
wallRADMaterial [Optional]
Optional wall material to overwrite the default walls
Honeybee Primer
84Set_Radiance_Materials
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 85/510
windowRADMaterial [Optional]
Optional material for windows
roofRADMaterial [Optional]
Optional material for roofs
floorRADMaterial [Optional]
Optional material for floors
ceilingRADMaterial [Optional]
Optional material for ceilings
skylightRADMaterial [Optional]
Optional material for skylights
Outputs
modifiedHBObject
Honeybee object with updated materials
Check Hydra Example Files for Set Radiance Materials
Honeybee Primer
85Set_Radiance_Materials
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 86/510
Radiance BSDF Material
Radiance BSDF Material Create RADIANCE BSDF material -
Inputs
materialName [Required]
Name of material
XMLFilePath [Required]
File path to XML
Honeybee Primer
86Radiance_BSDF_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 87/510
upOrientation [Default]
Script variable radOpaqueMaterial
thickness [Optional]
Script variable radOpaqueMaterial
Outputs
RADMaterial
Radiance Material string
Check Hydra Example Files for Radiance BSDF Material
Honeybee Primer
87Radiance_BSDF_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 88/510
Radiance Glass Material By Color
Radiance Glass Material By Color Read more here to understand Radiance materials:
http://www.artifice.com/radiance/rad_materials.html -
Inputs
materialName [Required]
Unique name for this material
color [Required]
Honeybee Primer
88Radiance_Glass_Material_By_Color
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 89/510
color of the glass
refractiveIndex [Optional]
RefractiveIndex is 1.52 for glass and 1.4 for ETFE
Outputs
avrgTrans
Average transmittance of this glass
RADMaterial
Radiance Material string
Check Hydra Example Files for Radiance Glass Material By Color
Honeybee Primer
89Radiance_Glass_Material_By_Color
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 90/510
Radiance Metal Material
Radiance Opaque Material Create a Standard Radiance Opaque Material. Many thanks to
Axel Jacobs for his help and all the great resources he provided at jaloxa.eu Check out the
color picker to see some great examples >
http://www.jaloxa.eu/resources/radiance/colour_picker/index.shtml -
Inputs
materialName [Required]
A unique name for material
Honeybee Primer
90Radiance_Metal_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 91/510
RReflectance [Required]
Diffuse reflectance for red
GReflectance [Required]
Diffuse reflectance for green
BReflectance [Required]
Diffuse reflectance for blue
roughness [Default]
Roughness values above 0.2 are uncommon
specularity [Default]
Specularity values above 0.9 is typical for metal
Outputs
RADMaterial
Radiance Material string
Check Hydra Example Files for Radiance Metal Material
Honeybee Primer
91Radiance_Metal_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 92/510
Radiance Metal Material By Color
Radiance Metal Material By Color Create a Standard Radiance Metal Material. Many thanks
to Axel Jacobs for his help and all the great resources he provided at jaloxa.eu Check out
the color picker to see some great examples >
http://www.jaloxa.eu/resources/radiance/colour_picker/index.shtml -
Inputs
materialName [Required]
Material name
Honeybee Primer
92Radiance_Metal_Material_By_Color
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 93/510
color [Required]
Material color
roughness [Default]
Roughness values above 0.2 are uncommon
specularity [Default]
Specularity values above 0.9 is typical for metal
Outputs
RADMaterial
Radiance Material string
Check Hydra Example Files for Radiance Metal Material By Color
Honeybee Primer
93Radiance_Metal_Material_By_Color
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 94/510
Radiance Mirror Material
Radiance Mirror Material Read more here to understand Radiance materials:
http://www.artifice.com/radiance/rad_materials.html -
Inputs
materialName [Required]
Unique name for this material
RReflectance [Required]
Honeybee Primer
94Radiance_Mirror_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 95/510
Diffuse reflectance for red
GReflectance [Required]
Diffuse reflectance for green
BReflectance [Required]
Diffuse reflectance for blue
Outputs
RADMaterial
Radiance Material string
Check Hydra Example Files for Radiance Mirror Material
Honeybee Primer
95Radiance_Mirror_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 96/510
Radiance Mirror Material By Color
Radiance Mirror Material By Color Read more here to understand Radiance materials:
http://www.artifice.com/radiance/rad_materials.html -
Inputs
materialName [Required]
Unique name for this material
color [Required]
Honeybee Primer
96Radiance_Mirror_Material_By_Color
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 97/510
color of the glass
Outputs
RADMaterial
Radiance Material string
Check Hydra Example Files for Radiance Mirror Material By Color
Honeybee Primer
97Radiance_Mirror_Material_By_Color
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 98/510
Radiance Opaque Material By Color
Radiance Opaque Material By Color Create a Standard Radiance Opaque Material. Many
thanks to Axel Jacobs for his help and all the great resources he provided at jaloxa.eu
Check out the color picker to see some great examples >
http://www.jaloxa.eu/resources/radiance/colour_picker/index.shtml -
Inputs
materialName [Required]
Material name
Honeybee Primer
98Radiance_Opaque_Material_By_Color
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 99/510
color [Required]
Material color
roughness [Default]
Roughness values above 0.2 are uncommon
specularity [Default]
Specularity values above 0.1 are uncommon
Outputs
avrgRef
Average diffuse reflectance of the material
RADMaterial
Radiance Material string
Check Hydra Example Files for Radiance Opaque Material By Color
Honeybee Primer
99Radiance_Opaque_Material_By_Color
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 100/510
Radiance Trans Material
Radiance Trans Material This component is useful to create translucent materials. Many
thanks to David Mead for his slides at: http://radiance-
online.org/community/workshops/2010-freiburg/PDF/DavidMead.pdf -
Inputs
materialName [Required]
Unique name for this material
Honeybee Primer
100Radiance_Trans_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 101/510
RDiffReflectance [Required]
Script variable _RDiffReflectance
GDiffReflectance [Required]
Script variable _GDiffReflectance
BDiffReflectance [Required]
Script variable _BDiffReflectance
specularReflection [Required]
Reflected specularity; Matte = min 0, Uncoated Glass ~ .06, Satin = suggested max
0.07
diffuseTransmission [Required]
Diffuse Transmission; Opaque = 0, Transparent = 1
specularTransmission [Required]
Specular Transmission; Diffuse = 0, Clear = 1
roughness [Default]
Surface roughness; Polished = 0, Low gloss = suggested max 0.02
Outputs
transMaterial
Radiance Material Definition
Check Hydra Example Files for Radiance Trans Material
Honeybee Primer
101Radiance_Trans_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 102/510
Radiance Trans Material By Color
Radiance Trans Material This component is useful to create translucent materials. Many
thanks to David Mead for his slides at: http://radiance-
online.org/community/workshops/2010-freiburg/PDF/DavidMead.pdf -
Inputs
materialName [Required]
Unique name for this material
Honeybee Primer
102Radiance_Trans_Material_By_Color
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 103/510
color [Required]
Material color
specularReflection [Required]
Reflected specularity; Matte = min 0, Uncoated Glass ~ .06, Satin = suggested max
0.07
diffuseTransmission [Required]
Diffuse Transmission; Opaque = 0, Transparent = 1
specularTransmission [Required]
Specular Transmission; Diffuse = 0, Clear = 1
roughness [Default]
Specular Transmission; Diffuse = 0, Clear = 1
Outputs
transMaterial
Radiance Material Definition
Check Hydra Example Files for Radiance Trans Material By Color
Honeybee Primer
103Radiance_Trans_Material_By_Color
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 104/510
Component list:
Generate_Climate_Based_Sky
Generate_Cumulative_Sky Generate_Standard_CIE_Sky
Watch_The_Sky
Generate_Average_Sky
Generate_Custom_Sky
Generate_Dark_Sky
Generate_Sky_With_Certain_Illuminance_level
Honeybee Primer
10402 | Daylight | Sky
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 105/510
Generate Climate Based Sky
Genrate Climate Based Sky This component generate a climate based sky for any hour of
the year -
Inputs
north [Optional]
Input a vector to be used as a true North direction for the sun path or a number between
0 and 360 that represents the degrees off from the y-axis to make North. The default
North direction is set to the Y-axis (0 degrees).
Honeybee Primer
105Generate_Climate_Based_Sky
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 106/510
weatherFile [Required]
epw weather file address on your system
month [Required]
Month of the study [1-12]
day [Required]
Day of the study [1-31]
hour [Required]
Hour of the study [1-24]
Outputs
radiationValues
Direct and diffuse radiation of the sky
skyFilePath
Sky file location on the local drive
Check Hydra Example Files for Generate Climate Based Sky
Honeybee Primer
106Generate_Climate_Based_Sky
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 107/510
Generate Cumulative Sky
This component generate a cumulative sky using GenCumulativeSky.exe. Only and only use
it for radiation analysis (no daylighting!) GenCumulativeSky is developed by Darren
Robinson and Andrew Stone, and modified by Christoph Reinhart. For more information,
reference: "http://plea-
arch.net/PLEA/ConferenceResources/PLEA2004/Proceedings/p1153final.pdf " The first time
you use this component, you need to be connected to the internet so the component can
download GenCumulativeSky.exe to the working directory. -
Inputs
Honeybee Primer
107Generate_Cumulative_Sky
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 108/510
weatherFile [Required]
epw weather file address on your system
analysisPeriod [Default]
Indicates the analysis period. An annual study will be run if this input is not provided by
the user
generateSky [Required]
Set boolean to True to run the component
Outputs
skyFilePath
Sky file location on the local drive
Check Hydra Example Files for Generate Cumulative Sky
Honeybee Primer
108Generate_Cumulative_Sky
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 109/510
Generate Standard CIE Sky
Genrate Standard CIE Sky -
Inputs
north [Optional]
Input a vector to be used as a true North direction for the sun path or a number between
0 and 360 that represents the degrees off from the y-axis to make North. The default
North direction is set to the Y-axis (0 degrees).
Honeybee Primer
109Generate_Standard_CIE_Sky
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 110/510
weatherFile [Required]
epw file location on your system as a string
month [Required]
Input a number to indicate month
day [Required]
Input a number to indicate day
hour [Required]
Input a number to indicate hour
skyType [Required]
CIE Sky Type [0] Sunny with sun, [1] sunny without sun, [2] intermediate with sun, [3]
intermediate without sun, [4] cloudy sky, [5] uniform sky
Outputs
skyFilePath
Sky file location on the local drive
Check Hydra Example Files for Generate Standard CIE Sky
Honeybee Primer
110Generate_Standard_CIE_Sky
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 111/510
Watch The Sky
Watch The Sky -
Inputs
skyFilePath [Required]
Path to a radiance sky file
imageSize [Default]
Optional input for size of the imgae in pixles. Default value is 500 px
Honeybee Primer
111Watch_The_Sky
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 112/510
runIt [Required]
Set to true to run the analysis
Outputs
HDRImagePath
Path to the result HDR file
globalHorIrradiance
Global horizontal irradiance for an upstructed test point under this sky (wh/m2) - In case
you're watching the cumulative sky the number is in (KWh/m2).
Check Hydra Example Files for Watch The Sky
Honeybee Primer
112Watch_The_Sky
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 113/510
Generate Average Sky
Generate Average Climate Based Sky This component generate an average climate based
data for a single hour during a month -
Inputs
north [Optional]
Input a vector to be used as a true North direction for the sun path or a number between
0 and 360 that represents the degrees off from the y-axis to make North. The default
North direction is set to the Y-axis (0 degrees).
Honeybee Primer
113Generate_Average_Sky
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 114/510
weatherFile [Required]
epw weather file address on your system
month [Required]
Month of the study [1-12]
hour [Required]
Hour of the study [1-24]
Outputs
radiationValues
Average direct and diffuse radiation during the month for the input hour
skyFilePath
Sky file location on the local drive
Check Hydra Example Files for Generate Average Sky
Honeybee Primer
114Generate_Average_Sky
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 115/510
Generate Custom Sky
Genrate Custom Sky This component generate a custom sky based on user's input -
Inputs
north [Optional]
Input a vector to be used as a true North direction for the sun path or a number between
0 and 360 that represents the degrees off from the y-axis to make North. The default
North direction is set to the Y-axis (0 degrees).
Honeybee Primer
115Generate_Custom_Sky
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 116/510
locationData [Required]
The output from the importEPW or constructLocation component. This is essentially a
list of text summarizing a location on the earth.
directNrmRad [Required]
Direct Normal Radiation in Wh/m2
diffuseHorRad [Required]
Diffuse Horizontal Radiation in Wh/m2
month [Required]
Month of the study [1-12]
day [Required]
Day of the study [1-31]
hour [Required]
Hour of the study [1-24]
Outputs
skyFilePath
Sky file location on the local drive
Check Hydra Example Files for Generate Custom Sky
Honeybee Primer
116Generate_Custom_Sky
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 117/510
Generate Dark Sky
This component generates a dark sky with 0 illuminance. It's useful for lighting (and not
daylighting) simulation with honeybee. -
Inputs
Outputs
skyFilePath
Sky file location on the local drive
Honeybee Primer
117Generate_Dark_Sky
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 118/510
Check Hydra Example Files for Generate Dark Sky
Honeybee Primer
118Generate_Dark_Sky
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 119/510
Generate Sky With Certain Illuminance level
Genrate a Uniform CIE Sky Based on Illuminace Value -
Inputs
illuminanceValue [Required]
Desired value for horizontal sky illuminance in Lux
Outputs
Honeybee Primer
119Generate_Sky_With_Certain_Illuminance_level
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 120/510
skyFilePath
Sky file location on the local drive
Check Hydra Example Files for Generate Sky With Certain Illuminance level
Honeybee Primer
120Generate_Sky_With_Certain_Illuminance_level
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 121/510
Component list:
Annual_Daylight_Simulation
Daylight_Factor_Simulation Generate_Test_Points
Grid_Based_Simulation
Image_Based_Simulation
Vertical_Sky_Component
DSParameters
RADParameters
Advanced_Dynamic_Shading_Recipe
Conceptual_Dynamic_Shading_Recipe
Daysim_Glare_Control_Recipe
Daysim_Shading_State
Gener ate_Zone_Test_Points
Honeybee Primer
12103 | Daylight | Recipes
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 122/510
Annual Daylight Simulation
Analysis Recipe for Annual Daylighting Simulation -
Inputs
north [Optional]
Input a vector to be used as a true North direction for the sun path or a number between
0 and 360 that represents the degrees off from the y-axis to make North. The default
North direction is set to the Y-axis (0 degrees).
Honeybee Primer
122 Annual_Daylight_Simulation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 123/510
epwWeatherFile [Required]
epw weather file address on your system
testPoints [Required]
Test points
ptsVectors [Optional]
Point vectors
testMesh [Optional]
Script variable annualDaylightSimulation
radParameters [Default]
Radiance parameters
DSParameters [Default]
Daysim parameters
Outputs
analysisRecipe
Recipe for annual climate based daylighting simulation
Check Hydra Example Files for Annual Daylight Simulation
Honeybee Primer
123 Annual_Daylight_Simulation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 124/510
Daylight Factor Simulation
Analysis Recipie for Daylight Factor Analysis -
Inputs
testPoints [Required]
Test points
ptsVectors [Optional]
Point vectors
Honeybee Primer
124Daylight_Factor_Simulation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 125/510
testMesh [Optional]
Script variable daylighFactorSimulation
uniformSky [Optional]
Set to true to run the study under a CIE uniform sky. Default is set to cloudy sky
radParameters [Default]
Radiance parameters
Outputs
analysisRecipe
Recipe for daylight factor analysis
Check Hydra Example Files for Daylight Factor Simulation
Honeybee Primer
125Daylight_Factor_Simulation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 126/510
Generate Test Points
Genrate Test Points -
Inputs
testGeometry [Required]
Test surface as a Brep.
gridSize [Required]
Size of the test grid.
Honeybee Primer
126Generate_Test_Points
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 127/510
distBaseSrf [Required]
Distance from base surface.
moveTestMesh [Optional]
Set to 'False' if you want test mesh not to move. Default is 'True'.
Outputs
readMe!
...
testPoints
Test points
ptsVectors
Vectors
facesArea
Script output facesArea.
mesh
Analysis mesh
Check Hydra Example Files for Generate Test Points
Honeybee Primer
127Generate_Test_Points
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 128/510
Grid Based Simulation
Analysis Recipie for Grid-Based Analysis -
Inputs
skyFile [Required]
Path to a radiance sky file
testPoints [Required]
Test points
Honeybee Primer
128Grid_Based_Simulation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 129/510
ptsVectors [Optional]
Point vectors
testMesh [Optional]
Script variable gridBasedSimulation
simulationType [Default]
[0] illuminance(lux), [1] radiation (kwh), [2] luminance (Candela)
radParameters [Default]
Radiance parameters
Outputs
analysisRecipe
Recipe for grid-based analysis
Check Hydra Example Files for Grid Based Simulation
Honeybee Primer
129Grid_Based_Simulation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 130/510
Image Based Simulation
Analysis Recipie for Image-Based Analysis -
Inputs
skyFile [Required]
Path to a radiance sky file
rhinoViewsName [Default]
viewName to be rendered
Honeybee Primer
130Image_Based_Simulation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 131/510
cameraType [Default]
[0] Perspective, [1] FishEye, [2] Parallel
sectionPlane [Optional]
Optional view fore clipping plane. The Plane should be perpendicular to the view
simulationType [Default]
[0] illuminance(lux), [1] radiation (wh), [2] luminance (Candela). Default is 2 >
luminance.
imageWidth [Default]
Optional input for image width in pixels
imageHeight [Default]
Optional input for image height in pixels
radParameters [Default]
Radiance parameters
backupImages [Optional]
[0] No backup, [1] Backup in the same folder, [2] Backup in separate folders. Default is
0.
Outputs
analysisRecipe
Recipe for image-based simulation
Check Hydra Example Files for Image Based Simulation
Honeybee Primer
131Image_Based_Simulation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 132/510
Vertical Sky Component
Analysis Recipie for Vertical Sky Component The idea Based on this discussion on
RADIANCE: http://www.radiance-online.org/pipermail/radiance-general/2006-
September/004017.html -
Inputs
testPoints [Required]
Test points
Honeybee Primer
132Vertical_Sky_Component
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 133/510
ptsVectors [Optional]
Point vectors
testMesh [Optional]
Script variable verticalSkyComponent
ad [Default]
Number of ambient divisions. "The error in the Monte Carlo calculation of indirect
illuminance will be inversely proportional to the square root of this number. A value of
zero implies no indirect calculation."
uniformSky [Optional]
Set to true to run the study under a CIE uniform sky. Default is set to cloudy sky
Outputs
analysisRecipe
Recipe for vertical sky component
Check Hydra Example Files for Vertical Sky Component
Honeybee Primer
133Vertical_Sky_Component
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 134/510
DSParameters
Analyses Recipe for Annual Daylight Simulation with Daysim -
Inputs
outputUnits [Default]
A list of numbers to indicate output units for test points. Defualt is 2. [1] solar irradiance
(W/m2), [2] illumiance (lux) - Default is 2
dynamicSHDGroup_1 [Optional]
Honeybee Primer
134DSParameters
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 135/510
Script input dynamicSHDGroup_1.
dynamicSHDGroup_2 [Optional]
Script input dynamicSHDGroup_2.
RhinoViewsName [Required]
List of view names that you want to be considered for annual glare analysis. Be aware
that annual glare analysis with Daysim can take hours to days!
dgp_imageSize [Default]
The size of the image to be used for daylight glare probability in pixels. Defult value is
250 px.
onlyRunGlareAnalysis [Optional]
Set to False if you want the component run both annual glare analysis and calculate
annula illuminance levels. Default is True.
Outputs
DSParameters
Script output DSParameters.
Check Hydra Example Files for DSParameters
Honeybee Primer
135DSParameters
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 136/510
RADParameters
Radiance Parameters - Standard Check here for more details:
http://radsite.lbl.gov/radiance/refer/Notes/rpict_options.html Read more about the
parameters at: http://daysim.ning.com/ Here is my favorite presentation by John Mardaljevic:
http://radiance-online.org/community/workshops/2011-berkeley-
ca/presentations/day1/JM_AmbientCalculation.pdf -
Inputs
quality [Required]
Honeybee Primer
136RADParameters
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 137/510
0 > low, 1 > Medium, 2 > High
ab [Default]
Number of ambient bounces. "This is the maximum number of diffuse bounces
computed by the indirect calculation. A value of zero implies no indirect calculation. "
ad [Default]
Number of ambient divisions. "The error in the Monte Carlo calculation of indirect
illuminance will be inversely proportional to the square root of this number. A value of
zero implies no indirect calculation."
as [Default]
Number of ambient super-samples. "Super-samples are applied only to the ambientdivisions which show a significant change."
ar [Default]
Ambient resolution. "This number will determine the maximum density of ambient
values used in interpolation. Error will start to increase on surfaces spaced closer than
the scene size divided by the ambient resolution. The maximum ambient value density
is the scene size times the ambient accuracy."
aa [Default]
Ambient accuracy. "This value will approximately equal the error from indirect
illuminance interpolation. A value of zero implies no interpolation"
additionalP [Optional]
Use this input to set other Radiance parameters as needed. You need to follow
Radiance's standard syntax (e.g. -ps 1 -lw 0.01)
Outputs
readMe!
The execution information, as output and error streams
radParameters
Script output radParameters.
Check Hydra Example Files for RADParameters
Honeybee Primer
137RADParameters
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 138/510
Advanced Dynamic Shading Recipe
Advanced Shading Recipe for Annual Simulation with Daysim. This component prepares
one shading group You need to add sensor points later in the Daysim result reader. -
Inputs
SHDGorupName []
SHDGorupName
shading_state1 []
Honeybee Primer
138 Advanced_Dynamic_Shading_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 139/510
Shading State1 The states should start from the most open state to the most closed
state. Detailes description is available on Daysim website:
http://daysim.ning.com/page/daysim-header-file-keyword-advanced-dynamic-shading
shading_state2 []
Shading State2 The states should start from the most open state to the most closed
state. Detailes description is available on Daysim website:
http://daysim.ning.com/page/daysim-header-file-keyword-advanced-dynamic-shading
glareControlRecipe []
Additional control for glare. Use Daysim glare control recipe to geneate the input
coolingPeriod []
Optional input for cooling priod. The blinds will be always down during the cooling
period. Use Ladybug_Analysis Period component to create an input.
Outputs
dynamicShadingGroup
Dynamic shading group
Check Hydra Example Files for Advanced Dynamic Shading Recipe
Honeybee Primer
139 Advanced_Dynamic_Shading_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 140/510
Conceptual Dynamic Shading Recipe
Conceptual Shading Recipe for Annual Simulation with Daysim You need to add sensor
points later in the Daysim result reader. -
Inputs
Outputs
dynamicShadingGroup
Honeybee Primer
140Conceptual_Dynamic_Shading_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 141/510
This sensors will be triggered by the 50 W/m2 threshold. "When lowered the blinds
transmit 25% of diffuse daylight and block all direct solar radiation." Read more here >
http://daysim.ning.com/page/daysim-header-file-keyword-simple-dynamic-shading
Dynamic shading Group
Check Hydra Example Files for Conceptual Dynamic Shading Recipe
Honeybee Primer
141Conceptual_Dynamic_Shading_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 142/510
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. -
Inputs
thresholdIlluminance []
Threshold illuminance in lux to close the blind
Honeybee Primer
142Daysim_Glare_Control_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 143/510
altitudeRange []
Range of sun altitude that the blind should be closed as a Domain.
azimuthRange []
Range of sun azimuth that the blind should be closed as a Domain.
Outputs
glareControlRecipe
Recipe for glare control
Check Hydra Example Files for Daysim Glare Control Recipe
Honeybee Primer
143Daysim_Glare_Control_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 144/510
Daysim Shading State
Daysim Shading State for Advanced Dynamic Shading -
Inputs
shdHBObjects []
A list of HB Objects that define the shading geometry and materials
minIlluminance []
Optional minimum illuminance in lux to open the blind. If you want the blinds to be
Honeybee Primer
144Daysim_Shading_State
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 145/510
manually controlled leave this input empty.
maxIlluminance []
Optional maximum illuminance in lux to close the blind. If you want the blinds to be
manually controlled leave this input empty.
Outputs
shadingState
Shading state
Check Hydra Example Files for Daysim Shading State
Honeybee Primer
145Daysim_Shading_State
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 146/510
Generate Zone Test Points
Genrate Test Points for all Floor Surfaces in Honeybee Zone -
Inputs
HBZone [Required]
HBZone; Test points will be generated for every floor surface inside zone
gridSize [Required]
Size of the test grid
Honeybee Primer
146Generate_Zone_Test_Points
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 147/510
distBaseSrf [Required]
Distance from base surface
moveTestMesh [Optional]
Set to False if you want test mesh not to move. Default is True.
Outputs
readMe!
...
testPoints
Test points
ptsVectors
Vectors
facesArea
Script output facesArea.
mesh
Analysis mesh
Check Hydra Example Files for Generate Zone Test Points
Honeybee Primer
147Generate_Zone_Test_Points
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 148/510
Component list:
Glare_Analysis
Run_Daylight_Simulation Import _rad
Read_Annual_Result_I
Read_ Annual_Result_ II
Read_RAD_Result
Convert_HDR_to_GIF
FalseColor
Import_Pts_File
Import _dgp_File
Lookup_Daylighting_Folder
Daysim_Annual_Profiles
Daysim_Electrical _Lighting_Use
Daysim_Occupancy_Generator
Daysim_Occupancy _Generator_Based_On_List
Daysim_User_Profiles
Daysim_shading_group_sensors
Lighting_control_Recipe
Convert_HDR_to_TIF
Convert_TIF_to_HDR
MSH2RAD
Read_All_the_Hourly_Results_from_Annual_Daylight_Study Read_DS_Result_for_a_point
Read_Hourly_Results_from_Annual_Daylight_Study
Refine_Daylight_Simulation
Set_Exposure_for_HDR
Honeybee Primer
14804 | Daylight | Daylight
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 149/510
Glare Analysis
Glare Analysis This component is using evalglare for glare calculations. Evalgalare is
developed by J. Wienold at Fraunhofer ISE. http://www.ise.fraunhofer.de/en/ Check this link
for more information about glare analysis. Thanks to Christoph Reinhart, Shelby Doyle, J
Alstan Jakubiec and Rashida Mogri.
http://web.mit.edu/tito_/www/Projects/Glare/GlareRecommendationsForPractice.html -
Inputs
HDRImagePath [Required]
Honeybee Primer
149Glare_Analysis
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 150/510
Path to an HDR image file
taskPositionUV [Optional]
Task position in x and y coordinates
taskPositionAngle [Optional]
Task position opening angle in degrees
runIt [Required]
Set to True to run the analysis
Outputs
readMe
...
glareCheckImage
Path to HDR image of the glare study
DGP
Daylight glare probability. Imperceptible Glare [0.35 > DGP], Perceptible Glare [0.4 >
DGP >= 0.35], Disturbing Glare [0.45 > DGP >= 0.4], Intolerable Glare [DGP >= 0.45]
DGI
Daylight glare index
imageWithTaskArea
Path to HDR image with task area marked with blue circle
Check Hydra Example Files for Glare Analysis
Honeybee Primer
150Glare_Analysis
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 151/510
Run Daylight Simulation
export geometries to rad file, and run daylighting/energy simulation -
Inputs
HBObjects [Required]
List of Honeybee objects
analysisRecipe [Required]
An analysis recipe
Honeybee Primer
151Run_Daylight_Simulation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 152/510
writeRad [Required]
Write simulation files
runRad [Optional]
Run the analysis. _writeRad should be also set to true. Set to 2 if you want the analysis
to run in background. This option is useful for parametric runs when you don't want to
see command shells.
numOfCPUs [Default]
Number of CPUs to be used for the studies. This option doesn't work for image-based
analysis
workingDir [Default]
Working directory on your system. Default is set to C:\Ladybug
radFileName [Default]
Input the project name as a string
meshSettings [Optional]
Custom mesh setting. Use Grasshopper mesh setting components
exportAirWalls [Optional]
Set to True if you want to export air walls as surfaces and False if you don't want air
walls be exported. The default is set to False.
additionalRadFiles [Optional]
A list of fullpath to valid radiance files which will be added to the scene
overwriteResults [Optional]
Set to False if you want the component create a copy of all the results. Default is True
Outputs
readMe!
...
analysisType
Honeybee Primer
152Run_Daylight_Simulation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 153/510
Type of the analysis (e.g. illuminance, luminance,...)
resultsUnit
Unit of the results (e.g. lux, candela, wh/m2)
results
Path to the results of grid based analysis (includes all the recipes except image-based
and annual)
testPts
Test points
annual_analysis_files
Script variable runDaylightAnalysis
radGeoFile
Script variable runDaylightAnalysis
studyFolder
Script variable runDaylightAnalysis
done
True if the study is over
Check Hydra Example Files for Run Daylight Simulation
Honeybee Primer
153Run_Daylight_Simulation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 154/510
Import rad
Import a rad file to gh This component is just a proof of concept for now and needs major
modifications -
Inputs
radianceFile [Required]
File path to radiance file
Outputs
Honeybee Primer
154Import_rad
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 155/510
RADMaterials
List of materials
RADSurfaces
List of surfaces
Check Hydra Example Files for Import rad
Honeybee Primer
155Import_rad
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 156/510
Read Annual Result I
Read Annual Daylight Results I [Standard Daysim Results] -
Inputs
illFilesAddress [Required]
List of .ill files
testPoints [Required]
List of 3d Points
Honeybee Primer
156Read_Annual_Result_I
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 157/510
ptsVectors [Optional]
Script variable readDSResults
occupancyFiles [Optional]
Address to a Daysim occupancy file. You can find some example in \Daysim\occ. Use
Honeybee Occupancy Generator to generate a custom occupancy file. You can also
use EnergyPlus Schedules directly. If the schedule is using continuous values any value
larger than .2 will be considered as occupied.
DLAIllumThresholds [Default]
Illuminance threshold for Daylight Autonomy calculation in lux. Default is set to 300 lux.
lightingControlGroups [Optional]
Daysim lighting control groups. Daysim can model up to 10 lighting control groups
together. Default is > cntrlType = 4, lightingPower = 250, lightingSetpoint = 300,
ballastLossFactor = 20, standbyPower = 3, delayTime = 5
SHDGroupI_Sensors [Optional]
Senors for dhading group I. Use shadingGroupSensors component to prepare the
inputs
SHDGroupII_Sensors [Optional]
Senors for dhading group II. Use shadingGroupSensors component to prepare the
inputs
runIt [Required]
set to True to run the analysis
Outputs
DLA
Daylight Autonomy > Percentage of the time during the active occupancy hours that the
test point receives more daylight than the illuminance threshold.
UDLI_Less_100
Useful Daylight illuminance > Percentage of time during the active occupancy hours that
the test point receives less than 100 lux.
Honeybee Primer
157Read_Annual_Result_I
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 158/510
UDLI_100_2000
Useful Daylight illuminance > Percentage of time during the active occupancy hours that
the test point receives between 100 and 2000 lux.
UDLI_More_2000
Useful Daylight illuminance > Percentage of time during the active occupancy hours that
the test point receives more than 2000 lux.
CDA
Continuous Daylight Autonomy > Similar to Daylight Autonomy except that the point
receives illuminaceLevel/illuminace threshold for hours that illuminance level is less
than the threshold.
sDA
Spatial Daylight Autonomy > sDA is the percent of analysis points across the analysis
area that meet or exceed _DLAIllumThresholds value (set to 300 lux for LEED) for at
least 50% of the analysis period. Honeybee doesn't consider the effect of dynamic
blinds in calculating sDA.
annualProfiles
A .csv file generated by Daysim that can be used as lighting schedule for annual energy
simulation
htmReport
Script variable readDSResults
Check Hydra Example Files for Read Annual Result I
Honeybee Primer
158Read_Annual_Result_I
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 159/510
Read Annual Result II
Read Annual Daylight Results II [Daysim] -
Inputs
resultFilesAddress []
List of .ill files
testPts []
List of 3d Points
Honeybee Primer
159Read_Annual_Result_II
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 160/510
workingHours []
A domain that indicates start and the end hour of tha study. Default is from 8 to 17.
lunchHours []
A domain that indicates start and end of the hours off during the day
timeStep []
Timestep for the annual study. Default is 1.
minThreshold []
Minimum of desired value (default is illuminance and 300 lux)
maxThreshold []
Maximum of desired value (default is infinite)
runIt [Required]
Script variable readAnnualResultsII
Outputs
readMe!
...
lessThanRange
Percentage of the time that the value is less than desired value
inTheRange
Percentage of the time that the value is between minimum and maximum Thresholds
moreThanRange
Percentage of the time that the value is more than desired value
Check Hydra Example Files for Read Annual Result II
Honeybee Primer
160Read_Annual_Result_II
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 161/510
Read RAD Result
Read Radiance Results -
Inputs
analysisType [Required]
[0] illuminance, [1] radiation, [2] luminance, [3] daylight factor, [4] vertical sky component
resultFiles [Required]
A list of result files
Honeybee Primer
161Read_RAD_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 162/510
testPts [Required]
A list of 3d test points
writeToFile [Optional]
set to True if you want the final results be saves as a text file
Outputs
readMe!
...
unit
Unit of the results
values
Result of the analysis
Check Hydra Example Files for Read RAD Result
Honeybee Primer
162Read_RAD_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 163/510
Convert HDR to GIF
Convert HDR to GIF -
Inputs
HDRFilePath [Required]
Path to an HDR image file
adjustExposure [Optional]
"Mimic human visual response in the output. The goal of this process is to produce
Honeybee Primer
163Convert_HDR_to_GIF
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 164/510
output that correlates strongly with a person’s subjective impression of a scene."
Outputs
GIFFilePath
Path to the result GIF file
Check Hydra Example Files for Convert HDR to GIF
Honeybee Primer
164Convert_HDR_to_GIF
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 165/510
FalseColor
False Color -
Inputs
HDRFilePath [Required]
Path to an HDR image file
legendUnit [Optional]
Unit of the legend (e.g. lux, cd/m2,...)
Honeybee Primer
165FalseColor
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 166/510
conversionF [Optional]
Conversion factor for the results. Default is 179.
legendMax [Optional]
Maximum bound for the legend
contourLines [Optional]
Set to True ro render the image with colored lines
contourBands [Optional]
Script variable FalseColor
numOfSegments [Optional]
An interger representing the number of steps between the high and low boundary of the
legend. Default value is set to 10.
legendPosition [Optional]
A number between 0 to 11 to set legend position to the given direction
WS|W|WN|NW|N|NE|EN|E|ES|SE|S|SW
printExtrema [Optional]
Set to True to cause extrema points to be printed on the brightest and darkest pixels of
the input picture.
maskThreshold [Optional]
Optional number for masking threshold. Pixels with values less than this number will be
rendered in black.
useAlterColors [Optional]
Set to True to use the alternate colorset.
render [Required]
Set to True to render the new image
Outputs
outputFilePath
Honeybee Primer
166FalseColor
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 167/510
Path to the result HDR file
Check Hydra Example Files for FalseColor
Honeybee Primer
167FalseColor
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 168/510
Import Pts File
Import Radiance Test Grid -
Inputs
ptsFileAddress [Required]
Script input resultFileAddress.
Outputs
Honeybee Primer
168Import_Pts_File
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 169/510
points
Script output monthlyHeating.
vectors
Script variable readIdf
Check Hydra Example Files for Import Pts File
Honeybee Primer
169Import_Pts_File
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 170/510
Import dgp File
Import Annual Daylight Glare Probability -
Inputs
dgpFile [Required]
Annual Daylight glare probability file
Outputs
Honeybee Primer
170Import_dgp_File
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 171/510
viewPoints
Points that represents point of view of the person
viewDirections
Vectors that represents direction of the view. Use Ladybug
dgpValues
Daylight glare probability values. Imperceptible Glare [0.35 > DGP], Perceptible Glare
[0.4 > DGP >= 0.35], Disturbing Glare [0.45 > DGP >= 0.4], Intolerable Glare [DGP >=
0.45]
Check Hydra Example Files for Import dgp File
Honeybee Primer
171Import_dgp_File
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 172/510
Lookup Daylighting Folder
Search Simulation Folder -
Inputs
studyFolder [Required]
Path to base study folder. If _studyType is empty then it should be full path to study
folder
studyType [Default]
Honeybee Primer
172Lookup_Daylighting_Folder
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 173/510
Optional input for Honeybee study type 1 > imageBasedSimulation 2 >
gridBasedSimulation 3 > DF 4 > VSC 5 > annualSimulation
refresh [Optional]
Refresh
Outputs
analysisType
Type of the analysis (e.g. illuminance, luminance,...)
resultsUnit
Unit of the results (e.g. lux, candela, wh/m2)
illFiles
List of ill files from annual analysis
ptsFiles
List of point files
hdrFiles
List of hdr files
imageFiles
List of gif files
iesFiles
Script variable LookupFolder_Daylighting
epwFile
Script variable searchAnnualSimulationFolder
radianceFiles
Script variable LookupFolder_Daylighting
materialFiles
Script variable LookupFolder_Daylighting
Honeybee Primer
173Lookup_Daylighting_Folder
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 174/510
skyFiles
Script variable LookupFolder_Daylighting
octFiles
Script variable LookupFolder_Daylighting
dgpFiles
Script variable LookupFolder_Daylighting
annualProfiles
A .csv file generated by Daysim that can be used as an schedule for annual daylight
simulation
htmReport
Script variable LookupFolder_Daylighting
analysisMesh
Script variable LookupFolder_Daylighting
Check Hydra Example Files for Lookup Daylighting Folder
Honeybee Primer
174Lookup_Daylighting_Folder
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 175/510
Daysim Annual Profiles
Read Daysim Annual Profiles -
Inputs
annualProfiles [Required]
Address to a valid *_intgain.csv generated by daysim.
Outputs
Honeybee Primer
175Daysim_Annual_Profiles
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 176/510
occupancyProfile
Lists of annual occupancy profiles if any shadingProfiles Lists of annual shading profiles
if any
shadingProfiles
Script output shadingProfiles.
lightingControlProfiles
Lists of annual lighting switch profiles if any
dgpProfile
Lists of annual daylight glare probability profiles if any
Check Hydra Example Files for Daysim Annual Profiles
Honeybee Primer
176Daysim_Annual_Profiles
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 177/510
Daysim Electrical Lighting Use
Daysim's electrical lighting use -
Inputs
htmlReport [Required]
Address to a valid .htm file generated by daysim.
Outputs
Honeybee Primer
177Daysim_Electrical_Lighting_Use
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 178/510
electricLightingUse
Lists of annual occupancy profiles if any
Check Hydra Example Files for Daysim Electrical Lighting Use
Honeybee Primer
178Daysim_Electrical_Lighting_Use
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 179/510
Daysim Occupancy Generator
Daysim Occupancy Generator Daysim calculates the outputs for the hours that the space is
occupied. This componet generates a csv file that will be used as the occupancy-file. Read
more here: http://daysim.ning.com/page/keyword-occupancy-profile -
Inputs
occupancyPeriod [Default]
The period that the building is actively occupid. Use Ladybug Analysis Period
component to generate the input. Default is all year between 9 to 5.
Honeybee Primer
179Daysim_Occupancy_Generator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 180/510
dailyOffHours [Optional]
A list of hours that building is unoccupied during the occupancy period everyday (e.g.
lunch break). Default is an hour lunch break at 12. If you don't want any off hours input
-1.
weekendDays [Optional]
A list of numbers to indicate the weekend days. [0] None, [1-7] SAT to FRI. Default is
1,2 (SAT, SUN)
fileName [Default]
Optional fileName for this schedule. Files will be saved to C:\Honeybee\DaysimOcc
writeTheOcc [Required]
Set to True to write the file
Outputs
occupancyFile
Path to occupancy file
Check Hydra Example Files for Daysim Occupancy Generator
Honeybee Primer
180Daysim_Occupancy_Generator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 181/510
Daysim Occupancy Generator Based On List
Daysim Occupancy Generator Daysim calculates the outputs for the hours that the space is
occupied. This componet generates a csv file based on user input that will be used as the
occupancy-file. Read more here: http://daysim.ning.com/page/keyword-occupancy-profile
You can use this component to generate a Daysim schedule based of EnergyPlus schedule.
-
Inputs
occValues [Required]
Honeybee Primer
181Daysim_Occupancy_Generator_Based_On_List
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 182/510
A list of 0 and 1 that indicates the occupancy schedule. The length of the list should be
equal to 8760.
fileName [Default]
Optional fileName for this schedule. Files will be saved to C:\Honeybee\DaysimOcc
writeTheOcc [Required]
Set to True to write the file
Outputs
occupancyFile
Path to occupancy file
Check Hydra Example Files for Daysim Occupancy Generator Based On List
Honeybee Primer
182Daysim_Occupancy_Generator_Based_On_List
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 183/510
Daysim User Profiles
Daysim User Profiles Read here for details: http://daysim.ning.com/page/daysim-header-file-
keyword-user-profile -
Inputs
lightingControl [Default]
0 > Passive, 1 > active
blindControl [Default]
Honeybee Primer
183Daysim_User_Profiles
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 184/510
0 > Passive, 1 > active, 3 > based on daylight glare probability
frequency [Default]
Frequency of the year that this user type will use the space.
Outputs
userProfile
Daysim user profile
Check Hydra Example Files for Daysim User Profiles
Honeybee Primer
184Daysim_User_Profiles
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 185/510
Daysim shading group sensors
Daysim shading group sensors Read here for more information about Daysim sensors here:
http://daysim.ning.com/page/daysim-header-file-keyword-sensor-file-info-1 -
Inputs
interiorSensors [Optional]
Selected list of test points that indicates where occupants sit.
exteriorSensors [Optional]
Honeybee Primer
185Daysim_shading_group_sensors
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 186/510
Selected list of test points that indicates the location of the exterior sensor. Exterior
sensor will be only used if you are using the glare control.
Outputs
shadingGroupSensors
Shading group sensors to be used for read Daysim result
Check Hydra Example Files for Daysim shading group sensors
Honeybee Primer
186Daysim_shading_group_sensors
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 187/510
Lighting control Recipe
Daysim electrical lighting control. Check this link for more information about lighting control
types. http://daysim.ning.com/page/keyword-lighting-control -
Inputs
controlType [Default]
Lighting controlType: [0] Manual on/off switch, [1] Automate switch off occupancy
sensor, [2] Always on during active occupancy hours, [3] Manual On/off with auto
Dimming [4] Auto dimming with swith off occupancy sensor [5] Always on during active
Honeybee Primer
187Lighting_control_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 188/510
occupancy hours with auto dimming
sensorPoints [Optional]
Selected list of test points that indicates where lighting sensor points are located.
lightingPower [Default]
Lighting power in watts. Default is 250 w.
lightingSetpoint [Default]
Target illuminance for the space. Default is 300 lux.
ballastLossFactor [Default]
Minimum electric dimming level in percentages.
standbyPower [Default]
Standby power in watts. Default is 3 w.
delayTime [Default]
Switch-off delay time in minutes. Default is 5 minutes.
Outputs
lightingControlGroup
Lighting control Recipe
Check Hydra Example Files for Lighting control Recipe
Honeybee Primer
188Lighting_control_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 189/510
Convert HDR to TIF
Convert HDR to TIF -
Inputs
HDRFilePath [Required]
Path to an HDR image file
adjustExposure [Optional]
"Mimic human visual response in the output. The goal of this process is to produce
Honeybee Primer
189Convert_HDR_to_TIF
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 190/510
output that correlates strongly with a person’s subjective impression of a scene."
Outputs
TIFFFilePath
Script output TIFFFilePath.
Check Hydra Example Files for Convert HDR to TIF
Honeybee Primer
190Convert_HDR_to_TIF
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 191/510
Convert TIF to HDR
Convert HDR to TIF -
Inputs
TIFFFilePath [Required]
Path to an HDR image file
Outputs
Honeybee Primer
191Convert_TIF_to_HDR
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 192/510
HDRFilePath
Path to an HDR image file
Check Hydra Example Files for Convert TIF to HDR
Honeybee Primer
192Convert_TIF_to_HDR
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 193/510
MSH2RAD
Convert a mesh to RAD file -
Inputs
mesh [Required]
List of meshes
RADMaterial [Required]
Full string of rad material as the base material
Honeybee Primer
193MSH2RAD
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 194/510
workingDir [Default]
Working directory
radFileName [Default]
Radiance file name
writeRAD [Required]
Script input _writeRAD.
Outputs
materialFile
Path to material file
radianceFile
Path to radiance file
Check Hydra Example Files for MSH2RAD
Honeybee Primer
194MSH2RAD
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 195/510
Read All the Hourly Results from AnnualDaylight Study
Read the results of the annual study for a all the hours of the year for all the points -
Inputs
illFilesAddress [Required]
List of .ill files
testPoints [Required]
Honeybee Primer
195Read_All_the_Hourly_Results_from_Annual_Daylight_Study
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 196/510
List of 3d Points
annualProfiles [Optional]
Script variable readDSHourlyResults
Outputs
iIllumLevelsNoDynamicSHD
Illuminance values without dynamic shadings
iIllumLevelsDynamicSHDGroupI
Illuminance values when shading group I is closed
iIllumLevelsDynamicSHDGroupII
Illuminance values when shading group II is closed
iIlluminanceBasedOnOccupancy
Illuminance values based on Daysim user behavior
shadingGroupInEffect
0: no blind, 1: shading group I, 2: shading group II
Check Hydra Example Files for Read All the Hourly Results from Annual Daylight Study
Honeybee Primer
196Read_All_the_Hourly_Results_from_Annual_Daylight_Study
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 197/510
Read DS Result for a point
Read Daysim result for a test point -
Inputs
illFilesAddress [Required]
List of .ill files
testPoints [Required]
List of 3d Points
Honeybee Primer
197Read_DS_Result_for_a_point
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 198/510
targetPoint [Required]
One of the points from the test points
annualProfiles [Optional]
Script variable Python
Outputs
annualIllumNoDynamicSHD
Script variable Python
annualIllumDynamicSHDGroupI
Script variable Python
annualIllumDynamicSHDGroupII
Script variable Python
iIlluminanceBasedOnOccupancy
Illuminance values based on Daysim user behavior
Check Hydra Example Files for Read DS Result for a point
Honeybee Primer
198Read_DS_Result_for_a_point
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 199/510
Read Hourly Results from Annual DaylightStudy
Read the results of the annual study for a single hour of the year -
Inputs
illFilesAddress [Required]
List of .ill files
testPoints [Required]
Honeybee Primer
199Read_Hourly_Results_from_Annual_Daylight_Study
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 200/510
List of 3d Points
annualProfiles [Optional]
Script variable readDSHourlyResults
HOY [Required]
Hour of the year
Outputs
iIllumLevelsNoDynamicSHD
Illuminance values without dynamic shadings
iIllumLevelsDynamicSHDGroupI
Illuminance values when shading group I is closed
iIllumLevelsDynamicSHDGroupII
Illuminance values when shading group II is closed
iIlluminanceBasedOnOccupancy
Illuminance values based on Daysim user behavior
shadingGroupInEffect
0: no blind, 1: shading group I, 2: shading group II
Check Hydra Example Files for Read Hourly Results from Annual Daylight Study
Honeybee Primer
200Read_Hourly_Results_from_Annual_Daylight_Study
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 201/510
Refine Daylight Simulation
Refine simulation for an existing Radiance scene (.oct file) -
Inputs
octFile [Required]
Script variable Python
analysisRecipe [Required]
An analysis recipe
Honeybee Primer
201Refine_Daylight_Simulation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 202/510
thisRunName [Required]
Name of this run so you can recognize it later
numOfCPUs [Default]
Number of CPUs to be used for the studies. This option doesn't work for image-based
analysis
runIt [Required]
Script input _runIt.
Outputs
readMe!
The execution information, as output and error streams
results
Script variable runDaylightAnalysis
testPts
Test points if any
resultFiles
Result files. You need to need other components based on the type of the analysis to
calculate the results
done
True if the study is over
Check Hydra Example Files for Refine Daylight Simulation
Honeybee Primer
202Refine_Daylight_Simulation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 203/510
Set Exposure for HDR
Set Exposure for HDR -
Inputs
HDRFilePath [Required]
Path to an HDR image file
exposure [Default]
A number between 0 and 1
Honeybee Primer
203Set_Exposure_for_HDR
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 204/510
render [Required]
Set to True to render the new image
Outputs
outputFilePath
Path to the result HDR file
Check Hydra Example Files for Set Exposure for HDR
Honeybee Primer
204Set_Exposure_for_HDR
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 205/510
Component list:
ListZonePrograms
bldgPrograms Get_EnergyPlus_Loads
Get_EnergyPlus_Schedules
Honeybee Primer
20505 | Energy | Building Program
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 206/510
ListZonePrograms
Find list of spaces for each space based on program -
Inputs
bldgProgram [Required]
An index number for
Outputs
Honeybee Primer
206ListZonePrograms
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 207/510
zonePrograms
Honeybee zones in case of success
Check Hydra Example Files for ListZonePrograms
Honeybee Primer
207ListZonePrograms
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 208/510
bldgPrograms
Provides a list of available building programs from the template
Inputs
Check Hydra Example Files for bldgPrograms
Honeybee Primer
208bldgPrograms
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 209/510
Get EnergyPlus Loads
Look up loads for an specific bldgProgram and zoneProgram -
Inputs
zoneProgram [Required]
Script input _zoneProgram.
Outputs
Honeybee Primer
209Get_EnergyPlus_Loads
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 210/510
equipmentLoadPerArea
equipmentLoadPerArea
infiltrationRatePerArea
infiltrationRatePerArea
lightingDensityPerArea
lightingDensityPerArea
numOfPeoplePerArea
numOfPeoplePerArea
ventilationPerArea
ventilationPerArea
ventilationPerPerson
ventilationPerPerson
Check Hydra Example Files for Get EnergyPlus Loads
Honeybee Primer
210Get_EnergyPlus_Loads
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 211/510
Get EnergyPlus Schedules
Look up schedules for an specific bldgProgram and zoneProgram -
Inputs
zoneProgram [Required]
Script input _zoneProgram.
Outputs
Honeybee Primer
211Get_EnergyPlus_Schedules
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 212/510
occupancySchedule
occupancySchedule
occupancyActivitySch
Script variable LookupSchedules
heatingSetPtSchedule
heatingSetPtSchedule
coolingSetPtSchedule
coolingSetPtSchedule
lightingSchedule
lightingSchedule
equipmentSchedule
equipmentSchedule
infiltrationSchedule
infiltrationSchedule
Check Hydra Example Files for Get EnergyPlus Schedules
Honeybee Primer
212Get_EnergyPlus_Schedules
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 213/510
Component list:
EnergyPlus_Construction
EnergyPlus_NoMass_Opaque_Material EnergyPlus_Window_Material
Search_EP_Construction
Add_to_EnergyPlus_Library
Call_from_EP_Construction_Library
Decompose_EP_Construction
Decompose_EP_Material
EnergyPlus_Glass_Material
EnergyPlus_Opaque_Material
EnergyPlus_Shade_Material
EnergyPlus_Window_Air_Gap
R-Value_With_Air_Films
Honeybee Primer
21306 | Energy | Material | Construction
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 214/510
EnergyPlus Construction
Use this component to make your own EnergyPlus construction. Inputs can be either the
name of a matterial form the Openstudio construction library or a custom material made with
any of the EnergyPlus Material components. Note that the last layer in the component is
always the innermost layer and _layer_1 is always the outermost layer. To add more layers
in the construction, simply zoom into the component and hit the lowest "+" sign that shows
up on the input side. To remove layers from the construction, zoom into the component and
hit the lowest "-" sign that shows up on the input side. -
Inputs
Honeybee Primer
214EnergyPlus_Construction
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 215/510
name [Required]
A text name for your custom construction. This is what you will use as an input to other
components in order to reference your custom construction.
layer_1 [Required]
The first and outer-most layer of your construction.
layer_2 [Required]
The second outer-most layer of your construction.
layer_3 [Required]
The third outer-most layer of your construction.
Outputs
EPConstruction
An EnergyPlus construction that can be plugged into the "Honeybee_Add to EnergyPlus
Library" component in order to write the construction into the project library.
Check Hydra Example Files for EnergyPlus Construction
Honeybee Primer
215EnergyPlus_Construction
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 216/510
EnergyPlus NoMass Opaque Material
Use this component to create a custom opaque material that has no mass, which can be
plugged into the "HoneybeeEnergyPlus Construction" component. It is important to note that
this component creates a material with no mass and, because of this, the accuracy of the
component is not as great as a material that has mass. However, this component is very
useful if you only have an R-value for a material (or a construction) and you know that the
mass is relatively small. _ If you want to create a material that accounts for mass, you
should use the "Honeybee_EnergyPlus Window Material" component. -
Inputs
Honeybee Primer
216EnergyPlus_NoMass_Opaque_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 217/510
name [Required]
A text name for your NoMass Opaque Material.
roughness [Default]
A text value that indicated the roughness of your material. This can be either
"VeryRough", "Rough", "MediumRough", "MediumSmooth", "Smooth", and
"VerySmooth". The default is set to "Rough".
R_Value [Required]
Script variable Construction_NoMass
thermAbsp [Default]
An number between 0 and 1 that represents the thermal abstorptance of the material.
The default is set to 0.9, which is common for most non-metallic materials.
solAbsp [Default]
An number between 0 and 1 that represents the abstorptance of solar radiation by the
material. The default is set to 0.7, which is common for most non-metallic materials.
visAbsp [Default]
An number between 0 and 1 that represents the abstorptance of visible light by the
material. The default is set to 0.7, which is common for most non-metallic materials.
Outputs
EPMaterial
A no-mass opaque material that can be plugged into the "Honeybee_EnergyPlus
Construction" component.
Check Hydra Example Files for EnergyPlus NoMass Opaque Material
Honeybee Primer
217EnergyPlus_NoMass_Opaque_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 218/510
EnergyPlus Window Material
Use this component to create a custom window material that has no mass, which can be
plugged into the "HoneybeeEnergyPlus Construction" component. It is important to note that
this component creates a material with no mass and that is meant to represent an entire
window element (including all panes of glass and the frame). Because of this, when you plug
this material into the "HoneybeeEnergyPlys Construction" component, it is important that this
is the only material connected. Otherwise, E+ will crash when you try to run it. Also because
of this, the accuracy of this material is not as great as a material that has mass. However,
this component is very useful if you only have a U-value, SHGC, and VT for a window construction and no other information. If you want to create a material that accounts for
Honeybee Primer
218EnergyPlus_Window_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 219/510
mass, you should use the "Honeybee_EnergyPlus Glass Material" component and the
"Honeybee_EnergyPlus Window Air Gap" to create a window construction with one or
multiple panes. -
Inputs
name [Required]
A text name for your NoMass Window Material.
U_Value [Required]
A number representing the conductivity of the window in W/m-K.
SHGC [Required]
A number between 0 and 1 that represents the solar heat gain coefficient (SHGC) of the
window. The solar heat gain coeffieceint is essentially the fraction of solar radiation
falling on the window that makes it through the glass (at normal incidence). This number
is usually very close to the visible transmittance (VT) for glass without low-e coatings
but can be might lower for glass with low-e coatings.
VT [Required]
A number between 0 and 1 that represents the visible transmittance (VT) of the window.
The visible transmittance is essentially the fraction of visible light falling on the window
that makes it through the glass (at normal incidence). This number is usually very close
to the solar heat gain coefficent (SHGC) for glass without low-e coatings but can be
might higher for glass with low-e coatings.
Outputs
EPMaterial
A no-mass window material that can be plugged into the "Honeybee_EnergyPlus
Construction" component.
Check Hydra Example Files for EnergyPlus Window Material
Honeybee Primer
219EnergyPlus_Window_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 220/510
Search EP Construction
Search EnergyPlus construction based on Energy modeling standards, climate zone,
surface type and building program -
Inputs
EPConstrList [Required]
List of EPConstructions from Honeybee construction library
standard [Required]
Honeybee Primer
220Search_EP_Construction
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 221/510
Energy modeling standard [0:"ASHRAE 90.1-2004", 1:"ASHRAE 90.1-2007",
2:"ASHRAE 90.1-2010", 3:"ASHRAE 189.1", 4:"CBECS 1980-2004", 5:"CBECS Before-
1980"]
climateZone [Optional]
Optional input for climate zone
surfaceType [Optional]
Optional input for surface type > 0:'WALL', 1:'ROOF', 2:'FLOOR', 3:'CEILING',
4:'WINDOW'
keywords [Optional]
Optional keyword in the name of the construction (ie. METAL, MASS, WOODFRAME).
Outputs
EPSelectedConstr
List of selected EP constructions that matches the the inputs
Check Hydra Example Files for Search EP Construction
Honeybee Primer
221Search_EP_Construction
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 222/510
Add to EnergyPlus Library
Add EnergyPlus Material, Construction or Schedule to Library -
Inputs
EPObject [Required]
EnergyPlus material, construction or schedule definition
addToProjectLib [Required]
Set to True to add the material to HB library for this project
Honeybee Primer
222 Add_to_EnergyPlus_Library
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 223/510
overwrite [Optional]
Set to True if you want to overwrite the material with similar name
Outputs
readMe!
...
Check Hydra Example Files for Add to EnergyPlus Library
Honeybee Primer
223 Add_to_EnergyPlus_Library
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 224/510
Call from EP Construction Library
Call from EP Library -
Inputs
keywords [Optional]
List of keywords to filter the list of materials
Outputs
Honeybee Primer
224Call_from_EP_Construction_Library
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 225/510
ThermMaterials
List of THERM materials in Honeybee library. Note that Therm materials do not contain
enough information to be used for EnergyPlus. They can only be used for THERM
polygons with the "Honeybee_Create Therm Polygons" component.
EPMaterials
List of EP materials in Honeybee library
EPWindowMaterials
List of EP window materials in Honeybee library
EPConstructions
List of EP constructions in Honeybee library
Check Hydra Example Files for Call from EP Construction Library
Honeybee Primer
225Call_from_EP_Construction_Library
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 226/510
Decompose EP Construction
Decompose EnergyPlus Construction -
Inputs
cnstrName [Required]
EnergyPlus construction name
Outputs
Honeybee Primer
226Decompose_EP_Construction
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 227/510
materials
List of materials (from outside to inside)
comments
Comments for each layer of materials if any
UValue_SI
U value of the construction in W/m2.K
UValue_IP
U value of the construction in Btu/h·ft2·°F
RValue_SI
Script variable DecomposeEPConstruction
RValue_IP
Script variable DecomposeEPConstruction
Check Hydra Example Files for Decompose EP Construction
Honeybee Primer
227Decompose_EP_Construction
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 228/510
Decompose EP Material
Decompose EnergyPlus Material -
Inputs
materialName [Required]
EnergyPlus material name
Outputs
Honeybee Primer
228Decompose_EP_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 229/510
names
Script variable DecomposeEPMaterial
values
Script output values.
comments
Comments for each layer of materials if any
UValue_SI
U value of the construction in W/m2.K
UValue_IP
U value of the construction in Btu/h·ft2·°F
RValue_SI
Script variable DecomposeEPMaterial
RValue_IP
Script variable DecomposeEPMaterial
Check Hydra Example Files for Decompose EP Material
Honeybee Primer
229Decompose_EP_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 230/510
EnergyPlus Glass Material
Use this component to create a custom material for glass, which can be plugged into the
"HoneybeeEnergyPlus Construction" component. It is important to note that this component
creates a material that represents a single pane of glass, which can be combined with the
"Honeybee_EnergyPlus Window Air Gap" to make multi-pane windows. If you have
specifications for a whole window element and not individual panes of glass and gas, you
are better-off using the "Honeybee_EnergyPlus Window Material" component -
Inputs
name [Required]
Honeybee Primer
230EnergyPlus_Glass_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 231/510
A text name for your glass material.
thickness [Optional]
A number that represents the thickness of the pane of glass in meters. The default is set
to 0.003 meters (3 mm).
solarTransmittance [Optional]
A number between 0 and 1 that represents the transmittance of solar radiation through
the glass at normal incidence. The default is set to 0.837, which it typical for clear glass
without a low-e coating.
solarReflectance [Optional]
A number between 0 and 1 that represents the reflectance of solar radiation off theglass at normal incidence. The default is set to 0.075, which is typical for clear glass
without a low-e coating.
visibleTransmittance [Optional]
A number between 0 and 1 that represents the transmittance of only visible light through
the glass at normal incidence. This is usally very close to the solarTransmittance_ for
non-low-e-coated glass but can differ if the glass has a low-e coating. The default is set
to 0.898, which is typical for clear glass without a low-e coating.
visibleReflectance [Optional]
A number between 0 and 1 that represents the reflectance of only visible light off the
glass at normal incidence. This is usally very close to the solarReflectance_ for non-low-
e-coated glass but can differ if the glass has a low-e coating. The default is set to 0.081,
which is typical for clear glass without a low-e coating.
emissivity [Optional]
A number between 0 and 1 that represents the infrared hemispherical emissivity of the
glass. This number is usually pretty high for non-low-e-coated glass but can be
significantly lower for low-e coated glass. The default is set to 0.84, which is typical for
clear glass without a low-e coating.
conductivity [Optional]
A number representing the conductivity of the glass in W/m-K. The default is set to 0.9,
which is typical for clear glass without a low-e coating.
Honeybee Primer
231EnergyPlus_Glass_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 232/510
Outputs
EPMaterial
A glass material that can be plugged into the "Honeybee_EnergyPlus Construction"
component.
Check Hydra Example Files for EnergyPlus Glass Material
Honeybee Primer
232EnergyPlus_Glass_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 233/510
EnergyPlus Opaque Material
Use this component to create a custom opaque material, which can be plugged into the
"HoneybeeEnergyPlus Construction" component. This component requires you to know a lot
of the characteristics of the material and, you may want to borrow some characteristcs of a
similar material in the library. Use the "HoneybeeCall From EP Construction Library" and the
"Honeybee_Decompose EP Material" to help with this. If you are not able to find all of the
necessary material characteristcs and your desired material is relatively light, it might be
easier for you to use a "Honeybee_EnergyPlus NoMass Opaque Material." -
Inputs
Honeybee Primer
233EnergyPlus_Opaque_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 234/510
name [Required]
A text name for your Opaque Material.
roughness [Default]
A text value that indicated the roughness of your material. This can be either
"VeryRough", "Rough", "MediumRough", "MediumSmooth", "Smooth", and
"VerySmooth". The default is set to "Rough".
thickness [Required]
A number that represents the thickness of the material in meters (m).
conductivity [Required]
A number representing the conductivity of the material in W/m-K. This is essentially the
heat flow in Watts across one meter thick of the material when the temperature
difference on either side is 1 Kelvin.
density [Required]
A number representing the density of the material in kg/m3. This is essentially the mass
one cubic meter of the material.
specificHeat [Required]
A number representing the specific heat capacity of the material in J/kg-K. This is
essentially the number of joules needed to raise one kg of the material by 1 degree
Kelvin.
thermAbsp [Default]
An number between 0 and 1 that represents the thermal abstorptance of the material.
The default is set to 0.9, which is common for most non-metallic materials.
solAbsp [Default]
An number between 0 and 1 that represents the abstorptance of solar radiation by the
material. The default is set to 0.7, which is common for most non-metallic materials.
visAbsp [Default]
An number between 0 and 1 that represents the abstorptance of visible light by the
material. The default is set to 0.7, which is common for most non-metallic materials.
Honeybee Primer
234EnergyPlus_Opaque_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 235/510
Outputs
EPMaterial
An opaque material that can be plugged into the "Honeybee_EnergyPlus Construction"
component.
Check Hydra Example Files for EnergyPlus Opaque Material
Honeybee Primer
235EnergyPlus_Opaque_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 236/510
EnergyPlus Shade Material
Use this component to create a custom material for shades, which can be plugged into the
"HoneybeeEnergyPlus Window Shade Generator" component. In order to apply the material
to a window shade and adjust geometric characteristics of the shade, you should plug the
output of this component into a "HoneybeeEnergyPlus Window Shade Generator"
component. Note that the material characteristics here can refer to either blind slats, roller
shades, perforated exterior metal screens, or the properties of electrochromic glazing in an
"on" state. -
Inputs
Honeybee Primer
236EnergyPlus_Shade_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 237/510
materialName [Optional]
An optional name for the shade material.
reflectance [Optional]
A number between 0 and 1 that represents the front reflectance of the shade material.
The default value is set to 0.65.
transmittance [Optional]
A number between 0 and 1 that represents the transmittance of the shade material. The
default value is set to 0 for a perfectly opaque shade.
emissivity [Optional]
A number between 0 and 1 that represents the emissivity of the shade material. The
default value is set to 0.9 for a non-metalic shade.
thickness [Optional]
An optional number representing the thickness of the shade in meters. For blinds, this is
the thickness of each blind slat and, for roller shades and screens, this is the thickness
of the fabric or screen material. For electrochromic windows, this variable is discounted
since window materials with n mass are used. The default is set to 0.00025 m for a very
thin shade.
conductivity [Optional]
An optional number representing the conductivity of the shade material in W/m-K. The
default is set to 221 W/m-K.
Outputs
shadeMaterial
A shade material that can be plugged into the ZoneShades component.
Check Hydra Example Files for EnergyPlus Shade Material
Honeybee Primer
237EnergyPlus_Shade_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 238/510
EnergyPlus Window Air Gap
Use this component to create a custom material for a window air gap, which can be plugged
into the "HoneybeeEnergyPlus Construction" component. It is important to note that this
component only creates gaps of air and not other gasses. Also, the material out of this
component represents only a single layer of air, which can be combined with the
"Honeybee_EnergyPlus Glass Material" to make multi-pane windows. If you have
specifications for a whole window element and not individual panes of glass and gas, you
are better-off using the "Honeybee_EnergyPlus Window Material" component instead of this
one. -
Inputs
Honeybee Primer
238EnergyPlus_Window_Air_Gap
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 239/510
name [Default]
Script variable EPWinAirGap
thickness [Default]
A number that represents the thickness of the air gap in meters. The default is set to
0.0125 meters (1.25 cm).
Outputs
EPMaterial
A window air gap material that can be plugged into the "Honeybee_EnergyPlus
Construction" component.
Check Hydra Example Files for EnergyPlus Window Air Gap
Honeybee Primer
239EnergyPlus_Window_Air_Gap
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 240/510
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. Note that EnergyPlus has its own means of calculating
the effects of air films on either side of a construction but, here, we provide an apporximate
method based on an input surfaceType_. -
Inputs
uValue_SI [Required]
The U-Value_SI out of either the "Honeybee_Decompose EP Construction" or the
Honeybee Primer
240R-Value_With_Air_Films
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 241/510
"Honeybee_Decompose EP Material."
surfaceType [Optional]
An integer value from 0 to 3 that represents one of the following surface types: 0 -
Exterior Wall/Window 1 - Interior Wall/Window 2 - Exterior Roof 3 - Exposed Interior
Floor
Outputs
UValue_SI_wAir
Script variable Python
UValue_IP_wAir
Script variable Python
RValue_SI_wAir
Script variable Python
RValue_IP_wAir
Script variable Python
Check Hydra Example Files for R-Value With Air Films
Honeybee Primer
241R-Value_With_Air_Films
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 242/510
Component list:
Call_from_EP_Schedule_Library
Convert_EnergyPlus_Schedule_to_Values Decompose_EnergyPlus_Schedule
Search_EP_Schedule_Library
Create_CSV_Schedule
Get_Zone_EnergyPlus_Loads
Get_Zone_EnergyPlus_Schedules
Honeybee Primer
24207 | Energy | Schedule
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 243/510
Call from EP Schedule Library
Call from EP Schedule Library -
Inputs
keywords [Optional]
List of keywords to filter the list of schedules
Outputs
Honeybee Primer
243Call_from_EP_Schedule_Library
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 244/510
scheduleTypeLimits
List of EP schedules in Honeybee library
scheduleList
List of EP window schedules in Honeybee library
Check Hydra Example Files for Call from EP Schedule Library
Honeybee Primer
244Call_from_EP_Schedule_Library
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 245/510
Convert EnergyPlus Schedule to Values
Use this component to make a 3D chart in the Rhino scene of any climate data or hourly
simulation data. -
Inputs
schName [Required]
Name of the EP schedule
weekStDay [Default]
Honeybee Primer
245Convert_EnergyPlus_Schedule_to_Values
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 246/510
Day to be considered as the start of the week. Default is Sunday.[0]: Sunday, [1]:
Monday, [2]: Tuesday, [3]: Wednesday, [4]: Thursday, [5]: Friday, [6]: Saturday
Outputs
values
Hourly values
Check Hydra Example Files for Convert EnergyPlus Schedule to Values
Honeybee Primer
246Convert_EnergyPlus_Schedule_to_Values
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 247/510
Decompose EnergyPlus Schedule
Decompose Schedule -
Inputs
schName [Optional]
Schedule name
Outputs
Honeybee Primer
247Decompose_EnergyPlus_Schedule
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 248/510
name
name
schedule
schedule
comments
comments
Check Hydra Example Files for Decompose EnergyPlus Schedule
Honeybee Primer
248Decompose_EnergyPlus_Schedule
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 249/510
Search EP Schedule Library
Filter EP Schedule Library -
Inputs
scheduleList [Required]
Script input scheduleList.
zoneProgram [Optional]
Script input zoneProgram.
Honeybee Primer
249Search_EP_Schedule_Library
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 250/510
scheduleType [Optional]
Script input scheduleType.
Outputs
selSchedules
Script output selSchedule.
Check Hydra Example Files for Search EP Schedule Library
Honeybee Primer
250Search_EP_Schedule_Library
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 251/510
Create CSV Schedule
Use this component to write custom .csv schedules for EnergyPlus using a list of numbers
that you have in grasshopper. This can be used to make custom infiltration shcedules based
on indoor thermal comdort (to mimic opening of windows), shading transparency shedules
based on glare or thermal comfort, etc. -
Inputs
values [Required]
The values to be written into the .csv schedule.
Honeybee Primer
251Create_CSV_Schedule
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 252/510
units [Optional]
Text for the units of the input values above. The default is "Dimensionless" for a
fractional schedule. Possible inputs include "Dimensionless", "Temperature",
"DeltaTemperature", "PrecipitationRate", "Angle", "ConvectionCoefficient",
"ActivityLevel", "Velocity", "Capacity", "Power", "Availability", "Percent", "Control", and"Mode".
analysisPeriod [Optional]
If your input units do not represent a full year, use this input to specify the period of the
year that the schedule applies to.
timeStep [Optional]
If your connected _values do not represent a value for each hour (ie. one value for
every half-hour), input an interger here to specify the timestep. Inputting 2 means that
every 2 values indicate an hour (each value indicates a half-hour), etc.
scheduleName [Optional]
Input a name for your schedule here. The default is "unnamedSchedule".
writeFile [Required]
Set to "True" to generate the .csv schedule.
Outputs
readMe!
...
csvSchedule
The file path of the created .csv schedule. Plug this into the "Honeybee_Set EnergyPlus
Zone Schedules" to apply the schedule to a zone.
Check Hydra Example Files for Create CSV Schedule
Honeybee Primer
252Create_CSV_Schedule
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 253/510
Get Zone EnergyPlus Loads
Look up loads for a Honeybee Zone -
Inputs
HBZone [Required]
Script input _zoneProgram.
Outputs
Honeybee Primer
253Get_Zone_EnergyPlus_Loads
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 254/510
equipmentLoadPerArea
Per m^2
infiltrationRatePerArea
Per m^2
lightingDensityPerArea
Per m^2
numOfPeoplePerArea
Per m^2
ventilationPerArea
m3/s.m2
ventilationPerPerson
m3/s.person
Check Hydra Example Files for Get Zone EnergyPlus Loads
Honeybee Primer
254Get_Zone_EnergyPlus_Loads
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 255/510
Get Zone EnergyPlus Schedules
Look up schedules for a Honeybee Zone -
Inputs
HBZone [Required]
Honeybee zone
Outputs
Honeybee Primer
255Get_Zone_EnergyPlus_Schedules
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 256/510
occupancySchedule
occupancySchedule
occupancyActivitySch
Script variable LookupSchedules
heatingSetPtSchedule
heatingSetPtSchedule
coolingSetPtSchedule
coolingSetPtSchedule
lightingSchedule
lightingSchedule
equipmentSchedule
equipmentSchedule
infiltrationSchedule
infiltrationSchedule
Check Hydra Example Files for Get Zone EnergyPlus Schedules
Honeybee Primer
256Get_Zone_EnergyPlus_Schedules
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 257/510
Component list:
Set_EP_Zone_Construction
Set_EnergyPlus_Zone_Loads Set_EnergyPlus_Zone_Schedules
Set_Loads_And_Schedules
AddEarthtube
Create_EP_Ground
Create_EP_Plenum
Honeybee_Lighting_Density_Calculator
Honeybee_infORventPerArea_Calculator
Set_EP_Air_Flow
Set_EP_Surface_Construction
Set_EP_Zone_Interior_Construction
Set_EP_Zone_Underground_Constr uction
Set_EnergyPlus_Zone_Thresholds
Honeybee Primer
25708 | Energy | Set Zone Properties
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 258/510
Set EP Zone Construction
Update EP construction of zone based on type -
Inputs
HBZone [Required]
Honeybee zone
wallEPConstruction [Optional]
Optional new construction for walls
Honeybee Primer
258Set_EP_Zone_Construction
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 259/510
windowEPConstruction [Optional]
Optional new construction for windows
roofEPConstruction [Optional]
Optional new construction for roofs
floorEPConstruction [Optional]
Optional new construction for floors
expFloorEPConstruction [Optional]
Optional new construction for exposed floors
skylightEPConstruction [Optional]
Optional new construction for skylights
Outputs
modifiedHBZone
Honeybee zone with updated constructions
Check Hydra Example Files for Set EP Zone Construction
Honeybee Primer
259Set_EP_Zone_Construction
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 260/510
Set EnergyPlus Zone Loads
Use this component to change the occupancy, lighting, equipment, etc. loads for a given
Honeybee zone or list of Honeybee zones. -
Inputs
HBZones [Required]
Honeybee zones for which you want to change the loads.
equipmentLoadPerArea [Optional]
Honeybee Primer
260Set_EnergyPlus_Zone_Loads
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 261/510
The desired equipment load per square meter of floor. Values here should be in W/m2
(Watts per square meter). Typical values can range from 2 W/m2 (for just a laptop or
two in the zone) to 15 W/m2 for an office filled with computers and appliances.
infiltrationRatePerArea [Optional]
The desired rate of outside air infiltration into the zone per square meter of floor. Values
here should be in m3/s-m2 (Cubic meters per second per square meter of floor). Typical
values tend to be around 0.0002 m3/s-m2 for tightly sealed buildings but you can make
this much higher if you want to simulate a lot of air entering the zone for ventilation.
lightingDensityPerArea [Optional]
The desired lighting load per square meter of floor. Values here should be in W/m2
(Watts per square meter). Typical values can range from 3 W/m2 for efficeint LED bulbs
to 15 W/m2 for incandescent heat lamps.
numOfPeoplePerArea [Optional]
The desired number of per square meter of floor at peak occupancy. Values here should
be in ppl/m2 (People per square meter). Typical values can range from 0.02 ppl/m2 for
a lightly-occupied household to 0.5 ppl/m2 for a tightly packed auditorium.
ventilationPerArea [Optional]
The desired minimum rate of outdoor air ventilation through the mechanical system into
the zone in m3/s per m2 of floor. Values here should be in m3/s-m2 (Cubic meters per
second per square meter of floor). Often, this total value over the zone should be much
lower than the ventilation per person (below). Typical values can range from 0.0002
m3/s-m2 for lightly-occupied houses to 0.0025 m3/s-m2 for spaces like laboratories and
cleanrooms where dust contamination is a major concern.
ventilationPerPerson [Optional]
The desired minimum rate of outdoor air ventilation through the mechanical system into
the zone per person in the zone. Values here should be in m3/s-person (Liters per
second per person in the zone). In effect, an input here will mimic demand controlled
ventilation, where the ventilation through the mechanical system will change depending
upon the occupancy. Most standards suggest that you should have at least 0.001 m3/s
for each person in the zone but this may be increased sometimes to avoid odors or
exposure to indoor pollutants.
recirculatedAirPerArea [Optional]
Honeybee Primer
261Set_EnergyPlus_Zone_Loads
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 262/510
The desired minimum rate of recirculated air flow through the HVAC system in m3/s per
m2 of floor. Note that this input does not affect any models run with ideal air systems
and only has an effect on OpenStudio models where recirculated air is required in
addtion to outdoor ventilation (such as hostpital patient rooms that require additional
ventilation to limit the spread of diseases). The defult is always set to zero as most
spaces do not require recirculated air.
Outputs
loads
The current loads of the HBZones.
HBZones
Honeybee zones with modifided loads.
Check Hydra Example Files for Set EnergyPlus Zone Loads
Honeybee Primer
262Set_EnergyPlus_Zone_Loads
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 263/510
Set EnergyPlus Zone Schedules
Use this component to change the schedules of your HBZones. -
Inputs
HBZones [Required]
HBZones for which you want to change shcedules.
occupancySchedules [Optional]
...
Honeybee Primer
263Set_EnergyPlus_Zone_Schedules
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 264/510
occupancyActivitySchs [Optional]
A text string representing the shceudle for the metabolic rate of the occupants that you
want to use. This can be either a shcedule from the schedule libirary or a CSV file path
to a CSV schedule you created with the "HoneybeeCreate CSV Schedule" component.
If this is a CSV schedule, the values in it should be Watts and the "units" input shouldbe "ActivityLevel."
heatingSetPtSchedules [Optional]
...
coolingSetPtSchedules [Optional]
...
lightingSchedules [Optional]
...
equipmentSchedules [Optional]
...
infiltrationSchedules [Optional]
...
HVACAvailabilitySchs [Optional]
Script variable setEPZoneSchedules
Outputs
schedules
A report of what shcedules are assigned to each zone.
HBZones
HBZones that have had thier shcedules modified.
Check Hydra Example Files for Set EnergyPlus Zone Schedules
Honeybee Primer
264Set_EnergyPlus_Zone_Schedules
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 265/510
Set Loads And Schedules
Set schedules and loads for zones based on program -
Inputs
HBZones [Required]
...
zonePrograms [Optional]
...
Honeybee Primer
265Set_Loads_And_Schedules
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 266/510
Outputs
currentSchedules
...
currentLoads
...
HBZones
...
Check Hydra Example Files for Set Loads And Schedules
Honeybee Primer
266Set_Loads_And_Schedules
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 267/510
AddEarthtube
Use this component to add an Energy Plus earth tube to a Zone. An earth tube is a long,
underground metal or plastic pipe through which air is drawn. During cooling season, as air
travels through the pipe, it gives up some of its heat to the surrounding soil and enters the
room as cooler air. Similarly, during heating season, as air travels through the pipe, it
receives some of its heat from the soil and enters the room as warmer air. Simple earth
tubes in EnergyPlus can be controlled by a schedule and through the specification of
minimum, maximum, and delta temperatures as described below. As with infiltration and
ventilation, the actual flow rate of air through the earth tube can be modified by the
Honeybee Primer
267 AddEarthtube
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 268/510
temperature difference between the inside and outside environment and the wind speed.
The basic equation used to calculate air flow rate of earth tube in EnergyPlus is:
EarthTubeFlowRate = EF [A+B|Tzone-Todb|+C(Windspeed)+D(Windspeed^2)] - Where:
1. E is the maximum amount of air mass flow rate of the earth tube expected at design
conditions. -2. F is the schedule that modifies the maximum design volume flow fraction between 0 and
1. -
3. Tzone is the temperature of the zone which the Earthtube is attached to and Todb is the
outdoor dry blub temperature as odb stands for outdoor dry blub temperature. -
4. A,B,C and D are Constant term flow coefficients,Temperature Term flow coefficients,
Velocity Term flow coefficients and Velocity squared term flow coefficients respectively
they are set at the default values of 0.606,2.0199999E-02,5.9800001E-04 and
0.0000000E+00. In future versions the user will be able to specify these. - For more
information about the Energy Plus Earthtube please see:
http://bigladdersoftware.com/epx/docs/8-2/input-output-reference/group-
airflow.html#zoneearthtube-earth-tube -
Inputs
HBZones [Required]
The Honeybee zones to which Earthtubes will be added to. Only one earth tube will beadded to each zone.
epwFile [Required]
An .epw file path on your system as a text string. Used to find the ground temperature of
the site so Earthtube calculations can be undertaken.
schedules [Optional]
This field can be a schedule or a list of schedules which correspond sequentially to the
_HBZones. If no schedule is given for a zone the default schedule "ALWAYS ON" will be
used. - F is the name of the schedule that modifies the maximum design volume flow
rate parameter . This fraction between 0.0 and 1.0 is noted as Fschedule in the
EarthTubeFlowRate equation the .
designFlowrates [Required]
This field can be a float or a list of floats which correspond sequentially to the
_HBZones. Each float (noted as Edesign in the EarthTubeFlowRate equation) is the
maximum amount of air mass flow rate of the earth tube expected at design conditions
Honeybee Primer
268 AddEarthtube
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 269/510
the default is 0 m3/s. If no flow rate is given for a zone the default will be used. - The
flow rate is expressed in units of m3/s. The design value is modified by the schedule
fraction and user specified coefficients (Open this component to see the equation).
mincoolingTemps [Default]
This field can be a float or a list of floats which correspond sequentially to the
_HBZones. - Each float is the indoor temperature (in Celsius) below which the earth
tube is shut off the default is -100 degrees C. This lower temperature limit is intended to
avoid overcooling a space and thus result in a heating load. - For example, if the user
specifies a minimum temperature of 20 C, earth tube is assumed to be available if the
zone air temperature is above 20 C. If the zone air temperature drops below 20C, then
earth tube is automatically turned off. If no temperature is given for a zone the default
will be used.
maxheatingTemps [Default]
This field can be a float or a list of floats which correspond sequentially to the
_HBZones. Each float is the indoor temperature (in Celsius) above which the earth tube
is shut off the default is 100 degrees C. - This higher temperature limit is intended to
avoid overheating a space and thus result in a cooling load.For example, if the user
specifies a maximum temperature of 20 C, earth tube is assumed to be available if the
zone air temperature is below 20 C. - If the zone air temperature rises above 20C,
then earth tube is automatically turned off. If no temperature is given for a zone the
default will be used.
deltaTemps [Default]
This field can be a float or a list of floats which correspond sequentially to the
_HBZones. Each float is the temperature difference (in Celsius) between the indoor and
outdoor air dry-bulb temperatures below which the earth tube is shut off the default is 2
degrees C. - This is to allow the earth tube to be stopped either if the temperature
outside is too warm and could potentially heat the space or if the temperature outside is
too cold and could potentially cool the space. For example, if the user specifies a delta
temperature of 2C, earth tube is assumed to be available if the temperature difference
between indoor and outdoor temperature is at least 2 C - If the outside air dry-bulb
temperature is less than 2C cooler or warmer than the indoor dry-bulb temperature,
then the earth tube is automatically turned off. If no temperature is given for a zone the
default will be used.
earthTubeTypes [Default]
This field can be integer or a list of integers between 1 and 3 which correspond
Honeybee Primer
269 AddEarthtube
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 270/510
sequentially to the _HBZones. Each integer from 1 to 3 defines the type of earth tube as
one of the following options: Natural a value of 1, Exhaust a value of 2, or Intake a value
of 3. - A natural earth tube is assumed to be air movement/exchange that will not
consume any fan energy or is the result of natural air flow through the tube and into the
building. Values for fan pressure and efficiency for a natural flow earth tube are ignored.
For either Exhaust or Intake, values for fan pressure and efficiency define the fan
electric consumption. - For Natural and Exhaust earth tubes, the conditions of the air
entering the space are assumed to be equivalent to the air which is cooled or heated by
passing along the pipe. - For Intake earth tubes, an appropriate amount of fan heat is
added to the air stream. The default is a Natural Earthtube and this will be used if no
earth tube type is given for the zone.
fanPrises [Default]
This field can be a float or a list of floats which correspond sequentially to the
_HBZones. Each float is the pressure rise experienced across the fan in Pascals (N/m2)
the default is 150 Pascals which will be used if no value is given for a zone. - This is a
function of the fan and plays a role in determining the amount of energy consumed by
the fan.
fanEfficiencies [Default]
This field can be a float or a list of floats between 0 and 1 which correspond sequentially
to the _HBZones. Each float is the earth tube fan efficiency which is a decimal number
between 0.0 and 1.0 the default is 1 which will be used if no value is given for a zone. -
This is a function of the fan and plays a role in determining the amount of energy
consumed by the fan.
pipeRadii [Default]
This field can be a float or a list of floats which correspond sequentially to the
_HBZones. Each float is the radius of the earth tube(in meters) the default is 0.5 meter
which will be used if no value is given for a zone. This plays a role in determining the
amount of heat transferred from the surrounding soil to the air passing along the pipe. -
If the pipe has non-circular cross section, user can use the concept of hydraulic
diameter where Radius = 2*Area/Perimeter.
pipeThicknesses [Default]
This field can be a float or a list of floats which correspond sequentially to the
_HBZones. Each float is the thickness of the earth tube wall (in meters) the default is
0.2 meters which will be used if no value is given for a zone. - This plays a role in
determining the amountof heat transferred from the surrounding soil to the air passing
Honeybee Primer
270 AddEarthtube
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 271/510
along the earth tube.
pipeLengths [Default]
This field can be a float or a list of floats which correspond sequentially to the
_HBZones. Each float is the total length of the pipe (in meters) the default is 15 meters
which will be used if no value is given for a zone. - This plays a role in determining the
amount of heat transferred from the surrounding soil to the air passing along the pipe.
As the length of the pipe becomes longer, the amount of the heat transfer becomes
larger
pipeDepths [Default]
This field can be a float or a list of floats which correspond sequentially to the
_HBZones. Each float is the depth of the pipe under the ground surface (in meters) the
default is 3 meters which will be used if no value is given for a zone. - This plays a role
in determining the temperature of the soil surrounding the pipe.
soilCondition [Default]
An integer between 1 to 4 that defines the actual condition of the soil surrounding ALL
the earth tubes: HeavyAndSaturated a value of 1, HeavyAndDamp a value of 2,
HeavyAndDry a value of 3 or LightAndDry a value of 4. - This determines the thermal
diffusivity and thermal conductivity of the surrounding soil, which play a role indetermining the amount of heat transferred from the surrounding soil to the air passing
along ALL the pipes. - The default is 1 - HeavyAndSaturated.
conditionGroundSurface [Default]
An integer between 1 to 8 and defines the condition of the ground surface above ALL
the earth tubes. - Bare and wet is a value of 1, Bare and moist is a value of 2, Bare and
Arid is a value of 3, Bare and dry is a value of 4, Covered and wet is a value of 5, -
Covered and moist is a value of 6, Covered and arid is a value of 7, Covered and dry isa value of 8 the default is 1 - Bare and wet.
pipeThermalConductivity [Default]
This field can be a float or a list of floats which correspond sequentially to the
_HBZones. Each float is the thermal conductivity of the pipe (in W/m-K) the default is
200 W/m-K. - This plays a role in determining the amount of heat transferred from the
surrounding soil to the air passing along ALL the earth tubes.
Outputs
Honeybee Primer
271 AddEarthtube
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 272/510
Readme
Details of the earth tubes created.
earthTubeHBZones
The Honeybee zones that have been modified by this component - these zones now
contain an earth tube
Check Hydra Example Files for AddEarthtube
Honeybee Primer
272 AddEarthtube
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 273/510
Create EP Ground
Use this component to change the properties of a zone to refelct those of a ground. This is
particularly useful for setting up outdoor thermal comfort maps when you want the surface
temperature of the ground to be caclated with some spatial diversity, reflecting the shadows
that other objects cast upon it and the storage of heat in the ground surface. The turning of a
zone into a ground zone entails... 1) Setting all constructions to be indicative of a certain soil
type (see the _soilTypeOrMat description for more information). 2) Setting all surfaces
except the roof to have the boundary condition of 'ground', including no sun or wind
exposure for these surfaces. 3) Getting rid of all loads and schedules within the zone. Allvalues for soil type are taken from the Engineering Toolbox, specifically these pages below...
Honeybee Primer
273Create_EP_Ground
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 274/510
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
HBZones [Required]
HBZones to be turned into ground zones, representative of soil.
soilTypeOrMat [Required]
Either a material definition output from the 'Honeybee_EnergyPlus Opaque Material'
component, the name of a material already in the library, or an integer from 0 to 6
representing the following: 0 - Dry sand 1 - Semi-dry sand or dust 2 - Moits soil 3 - Mudor soil saturated with water 4 - Concrete 5 - Asphalt 6 - Solid rock or granite
Outputs
HBGrndZones
HBZones that have had their properties altered to be ground conditions.
Check Hydra Example Files for Create EP Ground
Honeybee Primer
274Create_EP_Ground
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 275/510
Create EP Plenum
Use this component to turn a HBZone into a 'Plenum Zone' with no internal loads. This is
useful to appropriately assign conditions for closets, underfloor spaces, and drop ceilings. -
Inputs
HBZones [Required]
HBZones that you want to turn into plenum zones.
Outputs
Honeybee Primer
275Create_EP_Plenum
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 276/510
HBPlenumZones
...
Check Hydra Example Files for Create EP Plenum
Honeybee Primer
276Create_EP_Plenum
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 277/510
Honeybee 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. Plug the result to the
Honeybee setEPZoneLoads component, lightingDensityPerArea_ input -
Inputs
lightLevel [Required]
A number representing the required light level in the room in lux. For instance, 500 lux
for a typical office area or 300 lux for a typical residential space. Note that a lux value
Honeybee Primer
277Honeybee_Lighting_Density_Calculator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 278/510
input here means that light level is reached everywhere on the room floor plan.
luminousEfficacy [Optional]
A value between 0 and 100 that represents how well a light source produces visible light
in lumens/Watt. More specifically, it is the ratio of luminous flux (in Lumens) coming from
a buld to electrical power (in Watts) going into the bulb. Here are some common
options: 92 = Fluorescent (T5 tube) 81 = 8.7 W LED screw base lamp (120 V) 80 =
Fluorescent (T8 tube) 52 = Compact Flourescent 13.8 = Incandescent 0.3 = Candle The
default is set to 80 lm/W for Fluorescent (T8), which is also close to LED lamps.
Sources - http://en.wikipedia.org/wiki/Luminous_efficacy,
http://sustainabilityworkshop.autodesk.com/buildings/electric-light-sources
maintenanceFactor [Optional]
A number between 0 and 1 that represents how often the lights are cleaned and
replaced (higher numbers mean more often). It takes into account such factors as
decreased efficiency with age, accumulation of dust within the fitting itself and the
depreciation of reflectance as walls and reflecting surfaces age. For convenience, it is
usually given as three options: 0.70 = Good 0.65 = Medium 0.55 = Poor The default is
set to 0.65 for Medium. Source -
http://sustainabilityworkshop.autodesk.com/buildings/light-fixtures-and-layout
coefficientOfUtilization [Optional]
A number between 0 and 1 that represents the fraction of the lumens from the bulb that
finally find their way to the work plane (higher values indicate a more efficient fixture).
This number depends on the particular fixture type, the number of lamps in it, the lens
used, its beam pattern, the shape of the room (Room Cavity Ratio, RCR) and the
reflectances of the ceiling (Rc), walls (Rw) and floor (Rf). Here are some common
Examples: 0.84 = Basic Fluorescent Strip 0.72 = Deep-Cell Parabolic Louver 0.55 =
Small-Cell Parabolic Louver The default is set to 0.84 for a Basic Fluorescent Strip
Source - http://www.gelighting.com/LightingWeb/na/resources/tools/epact-
estimator/popup-cu-ratings.jsp
Outputs
out
The execution information, as output and error streams
lightingDensityPerArea
(W/m2)The lighting load per square meter of floor, which can be plugged into the "Set
Honeybee Primer
278Honeybee_Lighting_Density_Calculator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 279/510
EnergyPlus Loads" component.
Check Hydra Example Files for Honeybee Lighting Density Calculator
Honeybee Primer
279Honeybee_Lighting_Density_Calculator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 280/510
Honeybee infORventPerArea Calculator
Use this component to transform ACH to m3/s-m2. Plug the result to the Honeybee
setEPZoneLoads component, infiltrationRatePerArea or infiltrationRatePerArea inputs -
Inputs
HBZones [Required]
Honeybee zones for which you want to calculate the infiltration or ventilation rates.
airChangeHour [Required]
Honeybee Primer
280Honeybee_infORventPerArea_Calculator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 281/510
Air Changes per Hour.
Outputs
out
The execution information, as output and error streams
infORventPerArea
infiltrationRatePerArea or ventilationPerArea in m3/s-m2 (Cubic meters per second per
square meter of floor)
allFloors
Script variable Python
Check Hydra Example Files for Honeybee infORventPerArea Calculator
Honeybee Primer
281Honeybee_infORventPerArea_Calculator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 282/510
Set EP Air Flow
Use this component to edit the airlfow between your zones and set up natural ventilation, if
desired. The natural ventilation that this component performs can address three main types
of natural ventilation strategies: 1 - Single-sided Ventilation - ventilation driven by the height
difference across a window on a single building side. 2 - Cross Ventilation - ventilation driven
by the pressure difference across two sides of a building. 3 - Chimney Ventilation -
ventilation driven by a stack that is attached to a zone or group of zones. The component
can model "multi-zone" natural ventilation so long as there are no major vertical differences
in height over multiple zones and the user understands that "mixing objects" of constant air flow are used to dsitribute cool incoming air between zones that are connected by an air
wall. As such, this method is not meant to model atriums or any method relying on inter-zone
Honeybee Primer
282Set_EP_Air_Flow
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 283/510
bouyancy-driven flow. The ventilation can be either fan-driven (using a constant flow rate) or
natural by using an area of operable window to compute an esimated airflow for the zone. _
The latter uses the following equation to compute airflow to the zone. Ventilation Wind = Cw
Opening Area Schedule WindSpd Ventilation Stack = Cd Opening Area Schedule
SQRT(2g DH*(|(Tzone-Todb)|/Tzone)) Total Ventilation = SQRT((Ventilation Wind)^2 +
(Ventilation Stack)^2) -
Inputs
HBZones [Required]
The HBZones out of any of the HB components that generate or alter zones.
interZoneAirFlowRate [Optional]
An optional number that represents airflow in m3/s per square meter of air wall contatct
surface area between zones. By default, this value is set to 0.0963 m3/s for each
square meter of air wall contact surface area, which is a decent assumption for
conditions of relatively low indoor air velocity. In cases of higher indoor air velocity, such
as those that might occur with consistent wind-driven ventilation or ventilation with fans,
you will likely want to increase this number. This can be either a single number to be
applied to all connected zones or a list of numbers for each different zone.
interZoneAirFlowSched [Optional]
An optional schedule of fractional values to set when the air flows in between zones.
naturalVentilationType [Required]
Choose from the following options. -1 - REMOVE NATURAL VENTILATION - Choose
this option if want to remove previously-set natural ventilation objects with this
component. 0 - NO NATURAL VENTILATION - Choose this option if you do not want to
add any natrual ventilation objects to your zones with this component. 1 - WINDOWNATURAL VENTILATION - Choose this to have the component automatically calculate
natural ventilation potential based on ALL of your zone's windows and a specified
fraction of operable glazing. Note that your zone must have windows for this ventilation
to occur. It will be assumed that each window is divided into two equally-sized openings
(one placed at the top and another at the bottom). 2 - CUSTOM STACK / WIND
VENTILATION - Choose this option either if you have window ventilation and it does not
fit the description above or if you are trying to model a custom ventilation object like a
chimney. You will have to specify an effective window area for the object and the height
between inlet and outlet. You will also have to specify the angle2North for wind-driven
calculations. Note that you can eliminate either the wind or the stack part of the
Honeybee Primer
283Set_EP_Air_Flow
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 284/510
equation by setting the respective discharge coefficent to 0. 3 - FAN-DRIVEN
VENTILATION - Choose this option to have your zones ventilated at a constant rate,
representing fan-driven ventilation. You will have to specify the design flow rate that the
fan gives to the zone in m3/s. You can also change the default fan efficiency, which will
affect the electic consumption of the fan in the output.
minIndoorTempForNatVent [Optional]
A number or list of numbers between -100 and 100 that represents the minimum indoor
temperature at which to naturally ventilate. This can be either a single number to be
applied to all connected zones or a list of numbers for each different zone.
maxIndoorTempForNatVent [Optional]
A number or list of numbers between -100 and 100 that represents the maximum indoor
temperature at which to naturally ventilate. Use this to design mixed-mode buildings
where you would like occupants to shut the windows and turn on a cooling system if it
gets too hot inside. This can be either a single number to be applied to all connected
zones or a list of numbers for each different zone.
minOutdoorTempForNatVent [Optional]
A number or list of numbers between -100 and 100 that represents the minimum
outdoor temperature at which to naturally ventilate. This can be either a single number to be applied to all connected zones or a list of numbers for each different zone.
maxOutdoorTempForNatVent [Optional]
A number or list of numbers between -100 and 100 that represents the minimum
outdoor temperature at which to naturally ventilate. Use this to design night flushed
buildings where windows are closed for daytime temperatures and opened at night or a
mixed-mode buildings where you would like occupants to shut the windows and turn on
a cooling system if it gets too hot outside. This can be either a single number to beapplied to all connected zones or a list of numbers for each different zone.
openingAreaFractionalSched [Optional]
An optional schedule to set the fraction of the window that is open at each hour.
operableEffectiveArea [Required]
A number representing the effective area of operable ventilation in square meters. Note
that effective area references both inlet and outlet area through the following formula:EffectiveArea = 1 / sqrt( (1/InletArea^2) + 1/OutletArea^2) ). This value will be
Honeybee Primer
284Set_EP_Air_Flow
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 285/510
decreased if there is further friction introduced by objects in between the inlet and outlet.
inletOutletHeight [Required]
A number representing the height between the inlet and outlet of the custom ventilation
object in meters. This is needed for the bouyancy calculation. Note that this heght
should be from the midpoint of the height of the inlet to the midpoint of the height of the
outlet.
windDischargeCoeff [Optional]
A number between 0.0 and 1.0 that will be multipled by the area of the window to
account for the angle at which the wind hits the window. This is the 'Cw' variable in the
equation given in this component's description. If no value is input here, it is
autocalculated based on the angle of the cardinal direction from North and the hourly
wind direction. More often than not, you want to use this autocalculate feature. Set to 0
to completely discount wind from the natural ventilation calculation.
stackDischargeCoeff [Optional]
A number between 0.0 and 1.0 that will be multipled by the area of the window to
account for additional friction from window geometry, insect screens, etc. This is the 'Cd'
variable in the equation of this component's description. If left blank, this variable will be
autocalculated by the following equation - Cd = 0.4 + 0.0045*|(Tzone-Toutdoor). Somecommon values for this coefficient include the following: 0.65 - For bouyancy with TWO
windows of different heights, each of wehich have NO insect screens. 0.45 - For
bouyancy with TWO windows of different heights, each of wehich HAVE insect screens.
0.25 - For bouyancy with ONE window with NO insect screen. 0.17 - For bouyancy with
ONE window WITH an insect screen. 0.0 - Completely discounts stack ventilation from
the natural ventilation calculation and only accounts for wind.
windowAngle2North [Required]
A number between 0 and 360 that sets the angle in degrees from North counting
clockwise to the direction the window faces. An angle of 0 denotes that the opening
faces North, 90 denotes East, 180 denotes South, and 270 denotes West.
Outputs
readMe
...
HBZones
Honeybee Primer
285Set_EP_Air_Flow
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 286/510
HBZones with their airflow modified.
Check Hydra Example Files for Set EP Air Flow
Honeybee Primer
286Set_EP_Air_Flow
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 287/510
Set EP Surface Construction
Add Glazing -
Inputs
HBSurface [Required]
A HBSurface
EPConstruction [Optional]
Optional EnergyPlus construction
Honeybee Primer
287Set_EP_Surface_Construction
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 288/510
childEPConstruction [Optional]
Optional EnergyPlus construction for child surface
Outputs
readMe!
...
HBSurface
Modified Honeybee surface
Check Hydra Example Files for Set EP Surface Construction
Honeybee Primer
288Set_EP_Surface_Construction
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 289/510
Set EP Zone Interior Construction
Set EP Zone Interior Construction -
Inputs
HBZone [Required]
Honeybee zone
intWallEPConstruction [Optional]
Optional new construction for interior walls
Honeybee Primer
289Set_EP_Zone_Interior_Construction
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 290/510
intWindowEPConstruction [Optional]
Optional new construction for interior windows
intFloorEPConstruction [Optional]
Optional new construction for interior floors
intCeilingEPConstruction [Optional]
Optional new construction for interior ceilings. If no value is connected here but a value
is connected for interior floors, the intCeiling construction will be assumed to be the
same as the intFloor construction above.
Outputs
modifiedHBZone
Honeybee zone with updated constructions
Check Hydra Example Files for Set EP Zone Interior Construction
Honeybee Primer
290Set_EP_Zone_Interior_Construction
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 291/510
Set EP Zone Underground Construction
Update EP construction of zone based on type -
Inputs
HBZone [Required]
Honeybee zone
undergroundWallEPConstruction [Optional]
Optional new construction for underground walls
Honeybee Primer
291Set_EP_Zone_Underground_Construction
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 292/510
groundFloorEPConstruction [Optional]
Optional new construction for ground floors
undergroundSlabEPConstruction [Optional]
Optional new construction for underground slabs
undergroundCeilingEPConstruction [Optional]
Optional new construction for underground ceilings
Outputs
modifiedHBZone
Honeybee zone with updated constructions
Check Hydra Example Files for Set EP Zone Underground Construction
Honeybee Primer
292Set_EP_Zone_Underground_Construction
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 293/510
Set EnergyPlus Zone Thresholds
Use this component to set Zone Thresholds like daylighting thresholds and setpoints. -
Inputs
HBZones [Required]
HBZones for which zone thresholds will be set.
coolingSetPt [Optional]
A number or list of numbers that represent the thermostat cooling setpoint in degrees
Honeybee Primer
293Set_EnergyPlus_Zone_Thresholds
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 294/510
Celcius. The cooling setpoint is effectively the indoor temperature above which the
cooling system is turned on. This can be either a single number to be applied to all
connected zones or a list of numbers for each different zone.
coolingSetback [Optional]
A number or list of numbers that represent the thermostat cooling setback in degrees
Celcius. The cooling setback is the indoor temperature that the space will be kept at
when it is unoccipied. Note that not all building types have a setback. This can be either
a single number to be applied to all connected zones or a list of numbers for each
different zone.
heatingSetPt [Optional]
A number or list of numbers that represent the thermostat heating setpoint in degrees
Celcius. The heating setpoint is effectively the indoor temperature below which the
heating system is turned on. This can be either a single number to be applied to all
connected zones or a list of numbers for each different zone.
heatingSetback [Optional]
A number or list of numbers that represent the thermostat heating setback in degrees
Celcius. The heating setback is the indoor temperature that the space will be kept at
when it is unoccipied. Note that not all building types have a setback. This can be either a single number to be applied to all connected zones or a list of numbers for each
different zone.
Outputs
readMe!
The execution information, as output and error streams
HBZones
HBZones with thresolds set.
Check Hydra Example Files for Set EnergyPlus Zone Thresholds
Honeybee Primer
294Set_EnergyPlus_Zone_Thresholds
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 295/510
Component list:
Export_To_OpenStudio
_Run_ Energy_Simulation Add_Internal_Mass_to_Zone
EnergyPlus_Window_Shade_Generator
Honeybee_EP_con.._Surfaces
Make_Adiabatic_By_Type
Gener ate_EP_Output
OpenStudioHVACSystemsList
OpenStudio_Systems
Set_Ideal_Air_Loads_Par ameters
Import_idf
Read_ EP_Result
Read_ EP_Surface_Result
Surface_Data_Based_On_Type_Detailed
Color_ Surfaces_by_EP_ Result
Color_Zones_by_EP_Result
Energy_Shade_Benefit_Evaluator
Optimal_Shade_Creator
Adaptive_Comfort_Analysis_Recipe
Indoor_View_Factor_Calculator
Microclimate_Map_Analysis
Outdoor_Comfort_Analysis_Recipe PMV_Comfort_Analysis_Recipe
Read_Microclimate_Matrix
Thermal_Autonomy_Analysis
Visualize_Microclimate_Map
Balance_Temperature_Calculator
Construct_Energy_Balance
Energy_Simulation_Par
Make_Adiabatic
Honeybee Primer
29509 | Energy | Energy
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 296/510
Re-run_IDF
Read_EP_HVAC_Result
ShadowPar
Simulation_Control
Surface_Data_Based_On_Type
Honeybee Primer
29609 | Energy | Energy
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 297/510
Export To OpenStudio
Use this component to export HBZones into an OpenStudio file, and run them through
EnergyPlus. _ The component outputs the report from the simulation, the file path of the IDF
file, and the CSV result file from the EnergyPlus run, and two other result files that record
outputs in different formats. -
Inputs
north [Optional]
Input a vector to be used as a true North direction for the energy simulation or a number
Honeybee Primer
297Export_To_OpenStudio
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 298/510
between 0 and 360 that represents the degrees off from the y-axis to make North. The
default North direction is set to the Y-axis (0 degrees).
epwWeatherFile [Required]
An .epw file path on your system as a text string.
analysisPeriod [Default]
An optional analysis period from the Ladybug_Analysis Period component. If no
Analysis period is given, the energy simulation will be run for the enitre year.
energySimPar [Default]
Optional Energy Simulation Parameters from the "Honeybee_Energy Simulation Par"
component. If no value is connected here, the simulation will run with the followingparameters: 1 - 6 timeSteps per hour 2 - A shadow calculation that averages over
multiple days (as opposed to running it for each timeStep) 3 - A shadow calculation
frequency of 30 (meaning that the shadow calulation is averaged over every 30 days) 4
- A maximum of 3000 points used in the shadow calculation. (This may need to be
higher if you have a lot of detailed context geometry) 5 - An colar energy calculation that
includes both interior and exterior light reflections. 6 - A simulation including a zone
sizing calculation, a system sizing calculation, a plat sizing calculation, and a full run of
the energy use ofver the analysis period. The simulation is not run for the sizing periodby default. 7 - A system sizing period that runs from the extreme periods of the weather
file and not a ddy file. 8 - City terrian.
HBZones [Required]
The HBZones that you wish to write into an OSM file and/or run through EnergyPlus.
These can be from any of the components that output HBZones.
HBContext [Optional]
Optional HBContext geometry from the "Honeybee_EP Context Surfaces." component.
simulationOutputs [Optional]
A list of the outputs that you would like EnergyPlus to write into the result CSV file. This
can be any set of any outputs that you would like from EnergyPlus, writen as a list of
text that will be written into the IDF. It is recommended that, if you are not expereinced
with writing EnergyPlus outputs, you should use the "Honeybee_Write EP Result
Parameters" component to request certain types of common outputs.
writeOSM [Required]
Honeybee Primer
298Export_To_OpenStudio
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 299/510
Set to "True" to have the component take your HBZones and other inputs and write
them into an OSM file. The file path of the resulting OSM file will appear in the
osmFileAddress output of this component. Note that only setting this to "True" and not
setting the output below to "Tru"e will not automatically run the file through EnergyPlus
for you.
runSimulation [Optional]
Set to "True" to have the component run your OSM file through EnergyPlus once it has
finished writing it. This will ensure that a CSV result file appears in the resultFileAddress
output.
fileName [Optional]
Optional text which will be used to name your OSM, IDF and result files. Change this to
aviod over-writing results of previous energy simulations.
workingDir [Optional]
An optional working directory to a folder on your system, into which your OSM, IDF and
result files will be written. NOTE THAT DIRECTORIES INPUT HERE SHOULD NOT
HAVE ANY SPACES OR UNDERSCORES IN THE FILE PATH.
Outputs
ReadMe!
The execution information, as output and error streams
osmFileAddress
The file path of the OSM file that has been generated on your machine.
idfFileAddress
The file path of the IDF file that has been generated on your machine. This only
happens when you set "runSimulation_" to "True."
resultsFileAddress
Script variable exportToOpenStudio
sqlFileAddress
The file path of the SQL result file that has been generated on your machine. This only
happens when you set "runSimulation_" to "True."
Honeybee Primer
299Export_To_OpenStudio
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 300/510
meterFileAddress
The file path of the building's meter result file that has been generated on your machine.
This only happens when you set "runSimulation_" to "True."
Check Hydra Example Files for Export To OpenStudio
Honeybee Primer
300Export_To_OpenStudio
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 301/510
Run Energy Simulation
Use this component to export HBZones into an IDF file, and run them through EnergyPlus. _
The component outputs the report from the simulation, the file path of the IDF file, and the
CSV result file from the EnergyPlus run. -
Inputs
north [Optional]
Input a vector to be used as a true North direction for the energy simulation or a number
between 0 and 360 that represents the degrees off from the y-axis to make North. The
Honeybee Primer
301 _Run_Energy_Simulation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 302/510
default North direction is set to the Y-axis (0 degrees).
epwFile [Required]
An .epw file path on your system as a text string.
analysisPeriod [Default]
An optional analysis period from the Ladybug_Analysis Period component. If no
Analysis period is given, the energy simulation will be run for the enitre year.
energySimPar [Default]
Optional Energy Simulation Parameters from the "Honeybee_Energy Simulation Par"
component. If no value is connected here, the simulation will run with the following
parameters: 1 - 6 timeSteps per hour 2 - A shadow calculation that averages over multiple days (as opposed to running it for each timeStep) 3 - A shadow calculation
frequency of 30 (meaning that the shadow calulation is averaged over every 30 days) 4
- A maximum of 3000 points used in the shadow calculation. (This may need to be
higher if you have a lot of detailed context geometry) 5 - An colar energy calculation that
includes both interior and exterior light reflections. 6 - A simulation including a zone
sizing calculation, a system sizing calculation, a plat sizing calculation, and a full run of
the energy use ofver the analysis period. The simulation is not run for the sizing period
by default. 7 - A system sizing period that runs from the extreme periods of the weather file and not a ddy file. 8 - City terrian.
HBZones [Required]
The HBZones that you wish to write into an IDF and/or run through EnergyPlus. These
can be from any of the components that output HBZones.
HBContext [Optional]
Optional HBContext geometry from the "Honeybee_EP Context Surfaces." componentor Honeybee PV gen component.
HBGenerators [Optional]
Connect the output HBGeneratorSystem from the Honeybee_generationsystem
component here to model EnergyPlus Photovoltaic and Wind generator systems in this
simulation.
simulationOutputs [Optional]
A list of the outputs that you would like EnergyPlus to write into the result CSV file. This
Honeybee Primer
302 _Run_Energy_Simulation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 303/510
can be any set of any outputs that you would like from EnergyPlus, writen as a list of
text that will be written into the IDF. It is recommended that, if you are not expereinced
with writing EnergyPlus outputs, you should use the "Honeybee_Write EP Result
Parameters" component to request certain types of common outputs. If no value is input
here, this component will automatically request outputs of heating, cooling, lighting, and
equipment energy use.
writeIdf [Required]
Set to "True" to have the component take your HBZones and other inputs and write
them into an IDF file. The file path of the resulting file will appear in the idfFileAddress
output of this component. Note that only setting this to "True" and not setting the output
below to "True" will not automatically run the IDF through EnergyPlus for you.
runEnergyPlus [Optional]
Set to "True" to have the component run your IDF through EnergyPlus once it has
finished writing it. This will ensure that a CSV result file appears in the resultFileAddress
output. Set to 2 if you want the analysis to run in background. This option is useful for
parametric runs when you don't want to see command shells.
workingDir [Default]
An optional working directory to a folder on your system, into which your IDF and resultfiles will be written. NOTE THAT DIRECTORIES INPUT HERE SHOULD NOT HAVE
ANY SPACES OR UNDERSCORES IN THE FILE PATH.
idfFileName [Default]
Optional text which will be used to name your IDF and result files. Change this to aviod
over-writing results of previous energy simulations.
meshSettings [Optional]
Optional mesh settings for your geometry from any one of the native Grasshopper mesh
setting components. These will be used to change the meshing of curved surfaces
before they are run through EnergyPlus (note that meshing of curved surfaces is done
since Energyplus is not able to calculate heat flow through non-planar surfaces). Default
Grasshopper meshing is used if nothing is input here but you may want to decrease
your calculation time by changing it to Coarse or increase your curvature definition (and
calculation time) by making it finer.
additionalStrings [Optional]
Honeybee Primer
303 _Run_Energy_Simulation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 304/510
THIS OPTION IS JUST FOR ADVANCED USERS OF ENERGYPLUS. You can input
additional text strings here that you would like written into the IDF. The strings input here
should be complete EnergyPlus objects that are correctly formatted. You can input as
many objects as you like in a list. This input can be used to write objects into the IDF
that are not currently supported by Honeybee.
Outputs
report
Check here to see a report of the EnergyPlus run, including errors.
idfFileAddress
The file path of the IDF file that has been generated on your machine.
resultFileAddress
The file path of the CSV result file that has been generated on your machine. This only
happens when you set "runEnergyPlus_" to "True."
Check Hydra Example Files for Run Energy Simulation
Honeybee Primer
304 _Run_Energy_Simulation
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 305/510
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. The component accepts either surfaces of Rhino geometry (representing
furniture or building elements) or a numerical value of the mass's surface area. Several of
these components can be used in a series to descibe internal masses (or furniture) 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 onlyfactored into the the thermal calculations of the zone by undergoing heat transfer with the
indoor air. -
Honeybee Primer
305 Add_Internal_Mass_to_Zone
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 306/510
Inputs
HBZones [Required]
HBZones for which internal masses are to be assigned.
internalMassName [Optional]
An optional text name for the internal mass. This can be useful for keeping track of
different internal mass types if you use several of this component in series.
srfsOrSrfArea [Required]
A list of Rhino breps representing the surfaces of internal masses (or furniture) that are
exposed to the air of the zone. Alternatively, this can be a number or list of numbers
representing the surface area of the internal masses (or furniture) that are exposed tothe zone air. In the case of breps representing the surfaces of internal masses, this
component is smart enough to know which zone the surfaces are in. However, all
surfaces must lie COMPLETELY inside a single zone and cannot span between zones
or span outside the building. If you have an object that lies between two zones, please
split it in two along the boundary between the zones. 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 zones using the specified
surface area), or it can be a list of numbers that matches the input zones, which can beused to assign different levels of mass surface area to different zones.
EPConstruction [Required]
An EnergyPlus Construction that represents the type of material that the thermal mass
is composed of. This can be either a construction from the "Call from EP Construction
Library" component or a custom construction from the "EnergyPlus Construction"
component.
Outputs
readMe!
The execution information, as output and error streams
HBZones
HBZones with internal masses assigned.
Check Hydra Example Files for Add Internal Mass to Zone
Honeybee Primer
306 Add_Internal_Mass_to_Zone
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 307/510
EnergyPlus Window Shade Generator
Use this component to generate shades for Honeybee zone windows. The component has
two main uses: The first is that it can be used to assign shade objects to HBZones prior to
simulation. These shades can be dynamically controlled via a schedule. Note that shades
created this way will automatically be assigned to the zone and the windowBreps and
shadeBreps outputs are just for visualization. The second way to use the component is to
create test shade areas for shade benefit evaluation after an energy simulation has already
been run. In this case, the component helps keep the data tree paths of heating, cooling and
beam gain synced with that of the zones and windows. For this, you would take importedEnergyPlus results and hook them up to the "zoneData" inputs and use the output
"zoneDataTree" in the shade benefit evaluation. -
Honeybee Primer
307EnergyPlus_Window_Shade_Generator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 308/510
Inputs
HBObjects [Required]
The HBZones or HBSurfaces out of any of the HB components that generate or alter
zones.
shadeType [Optional]
An integer to specify the type of shade that you wish to assign to the windows. The
default is set to 0 = blinds. Choose from the following options: 0 = Blinds - typical
venetian blinds that can be either on the interior or exterior of the glass. 1 = Shades -
either a fabric roller shade or a perforated metal screen that diffuses the light evenly. 2 =
Electrochromic Glazing - represents electrochromic glazing that can be switched on to
reflect the material state of the shadeMaterial_.
shadeMaterial [Optional]
An optional shade material from the 'Honeybee_EnergyPlus Shade Material'
component. If no material is connected here, the component will automatically assign a
material depending on the shade type above. The default blinds material has 0.65 solar
reflectance, 0 transmittance, 0.9 emittance, 0.25 mm thickness, 221 W/mK conductivity.
shadeSchedule [Optional]
An optional schedule to raise and lower the shades. If no value is connected here, the
shades will assume the 'ALWAYS ON' shcedule.
shadeCntrlType [Optional]
An integer represeting the parameter that controls whether the shades are on (down) or
off (up). The default is set to 0 = OnIfScheduleAllows. Choose from the following
options: 0 = OnIfScheduleAllows - Shading is on if the schedule value is non-zero and is
AlwaysOn if no schedule is connected. 1 = OnIfHighSolarOnWindow - Shading is on if
beam plus diffuse solar radiation incident on the window exceeds SetPoint (W/m2)
below and schedule, if specified, allows shading. 2 = OnIfHighHorizontalSolar - Shading
is on if total (beam plus diffuse) horizontal solar irradiance exceeds SetPoint (W/m2)
below and schedule, if specified, allows shading. 3 = OnIfHighOutdoorAirTemperature -
Shading is on if outside air temperature exceeds SetPoint (C) below and schedule, if
specified, allows shading. 4 = OnIfHighZoneAirTemperature - Shading is on if zone air
temperature in the previous timestep exceeds SetPoint (C) below and schedule, if
specified, allows shading. 5 = OnIfHighZoneCooling - Shading is on if zone cooling ratein the previous timestep exceeds SetPoint (W) below and schedule, if specified, allows
shading. 6 = OnNightIfLowOutdoorTempAndOffDay - Shading is on at night if the
Honeybee Primer
308EnergyPlus_Window_Shade_Generator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 309/510
outside air temperature is less than SetPoint (C) below and schedule, if specified,
allows shading. Shading is off during the day. 7 = OnNightIfLowInsideTempAndOffDay -
Shading is on at night if the zone air temperature in the previous timestep is less than
SetPoint (C) below and schedule, if specified, allows shading. Shading is off during the
day. 8 = OnNightIfHeatingAndOffDay - Shading is on at night if the zone heating rate in
the previous timestep exceeds SetPoint (W) below and schedule, if specified, allows
shading. Shading is off during the day. 9 =
OnNightIfLowOutdoorTempAndOnDayIfCooling - Shading is on at night if the outside air
temperature is less than SetPoint (C) below. Shading is on during the day if the zone
cooling rate in the previous timestep is non-zero. Night and day shading is subject to
schedule, if specified. 10 = OnNightIfHeatingAndOnDayIfCooling: Shading is on at night
if the zone heating rate in the previous timestep exceeds SetPoint (W) below. Shading
is on during the day if the zone cooling rate in the previous timestep is non-zero. Night
and day shading is subject to schedule, if specified. 11 =
OffNightAndOnDayIfCoolingAndHighSolarOnWindow: Shading is off at night. Shading is
on during the day if the solar radiation incident on the window exceeds SetPoint (W/m2)
below and if the zone cooling rate in the previous timestep is non-zero. Daytime shading
is subject to schedule, if specified. 12 =
OnNightAndOnDayIfCoolingAndHighSolarOnWindow: Shading is on at night. Shading is
on during the day if the solar radiation incident on the window exceeds SetPoint (W/m2)
below and if the zone cooling rate in the previous timestep is non-zero. Day and night
shading is subject to schedule, if specified. (This Shading Control Type is the same asthe previous one, except the shading is on at night rather than off.) 13 =
OnIfHighOutdoorAirTempAndHighSolarOnWindow: Shading is on if the outside air
temperature exceeds the Setpoint (C) and if if the solar radiation incident on the window
exceeds SetPoint 2 (W/m2). Note that this option requires you to connect two values to
the shadeSetpoint input below. 14 = OnIfHighOutdoorAirTempAndHighHorizontalSolar:
Shading is on if the outside air temperature exceeds the Setpoint (C) and if if the
horizontal solar radiation exceeds SetPoint 2 (W/m2). Note that this option requires you
to connect two values to the shadeSetpoint input below.
shadeSetpoint [Optional]
A number that corresponds to the shadeCntrlType_ specified above. This can be a
value in (W/m2), (C) or (W) depending upon the control type.
interiorOrExter [Optional]
Set to 'True' to generate Shades on the interior and set to 'False' to generate shades on
the exterior. The default is set to 'False' to generate exterior shades.
distToGlass [Optional]
Honeybee Primer
309EnergyPlus_Window_Shade_Generator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 310/510
A number between 0 and 1 that represents the distance between the glass and the
shades in meters. The default is set to 0 to generate the shades immediately next to the
glass.
airPermeability [Optional]
An optional number between 0 and 1 to set the air permeability of the shade. For
example, use this to account for perforations in outdoor metal screens where air can
circulate through. The default is set to have 0 permeability.
north [Optional]
Input a vector to be used as a true North direction or a number between 0 and 360 that
represents the degrees off from the y-axis to make North. The default North direction is
set to the Y-axis (0 degrees).
runIt [Required]
Set boolean to 'True' to run the component and generate shades.
zoneData1 [Optional]
Optional EnergyPlus simulation data for connected HBZones_ that will be aligned with
the generated windows. Use this to align data like heating load, cooling load or beam
gain for a shade benefit simulation with the generated shades.
Outputs
readMe!
...
HBObjWShades
The conected HBObjects with shades assigned to them. With these HBObjects, there is
no need to use the two geometric outputs below. If you have produced a shade
geometry that you will not be able to run through EnergyPlus, no objects will be output
from here.
windowBreps
Breps representing each window surfaces that are being shaded. These can be plugged
into a shade benefit evaulation as each window is its own branch of a grasshopper data
tree.
Honeybee Primer
310EnergyPlus_Window_Shade_Generator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 311/510
shadeBreps
Breps representing each shade geometry. These can be plugged into a shade benefit
evaulation as each window is its own branch of a grasshopper data tree. If you use the
HBObjects above, there is no need to use this output (it is purely visual). However, if no
HBObjects are produced, these can be plugged into an EnergyPlus simulation with the'Honeybee_EP Context Surfaces' component.
zoneData1Tree
Data trees of zoneData1Tree, which align with the branches for each window above.
Check Hydra Example Files for EnergyPlus Window Shade Generator
Honeybee Primer
311EnergyPlus_Window_Shade_Generator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 312/510
Honeybee EP context Surfaces
prepare shading/context geometries
Inputs
shdSurfaces [Required]
Script variable Python
EPTransSchedule [Optional]
Script variable HB_EPContextSrf
Honeybee Primer
312Honeybee_EP_context_Surfaces
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 313/510
RADMaterial []
Script variable HB_EPContextSrf
meshingSettings [Optional]
Script variable HB_ShdSrf
justBoundingBox [Optional]
Script variable HB_ShdSrf
Outputs
HBContext
Script variable Python
Check Hydra Example Files for Honeybee EP context Surfaces
Honeybee Primer
313Honeybee_EP_context_Surfaces
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 314/510
Make Adiabatic By Type
Use this component to make certain surface types of a zone adiabatic. -
Inputs
HBZones [Required]
HBZones for which some surface types will be turned to adiabatic.
walls [Optional]
Set to 'True' to have this surface type turned adiabatic. This input can also accept lists
Honeybee Primer
314Make_Adiabatic_By_Type
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 315/510
of boolean values and will assign different adiabatic values based on cardinal direction,
starting with north and moving counter-clockwise.
interiorWalls [Optional]
Set to 'True' to have this surface type turned adiabatic.
airWalls [Optional]
Set to 'True' to have this surface type turned adiabatic.
windows [Optional]
Set to 'True' to have this surface type turned adiabatic.
interiorWindows [Optional]
Set to 'True' to have this surface type turned adiabatic.
roofs [Optional]
Set to 'True' to have this surface type turned adiabatic.
ceilings [Optional]
Set to 'True' to have this surface type turned adiabatic.
floors [Optional]
Set to 'True' to have this surface type turned adiabatic.
exposedFloors [Optional]
Set to 'True' to have this surface type turned adiabatic.
groundFloors [Optional]
Set to 'True' to have this surface type turned adiabatic.
undergroundWalls [Optional]
Set to 'True' to have this surface type turned adiabatic.
undergroundSlabs [Optional]
Set to 'True' to have this surface type turned adiabatic.
undergroundCeilings [Optional]
Honeybee Primer
315Make_Adiabatic_By_Type
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 316/510
Set to 'True' to have this surface type turned adiabatic.
Outputs
HBZones
Modified HBZones with their surfaces made adiabatic that have a 'True' boolean
connected to this component.
Check Hydra Example Files for Make Adiabatic By Type
Honeybee Primer
316Make_Adiabatic_By_Type
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 317/510
Generate EP Output
This component helps select simulation outputs that can be hooked into the WriteIDF
component. Outputs are taken from here:
http://apps1.eere.energy.gov/buildings/energyplus/pdfs/inputoutputreference.pdf -
Inputs
zoneEnergyUse [Optional]
Set to "True" to have EnergyPlus solve for basic building energy use such as heating,
cooling, electricity for lights and electricity for plug loads for each zone.
Honeybee Primer
317Generate_EP_Output
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 318/510
zoneGainsAndLosses [Optional]
Set to "True" to have EnergyPlus solve for building gains and losses such as people
gains, solar gains and infiltration losses/gains.
zoneComfortMetrics [Optional]
Set to "True" to have EnergyPlus solve for the mean air temperature, mean radiant
temperature, operative temperature, and relative humidity of each zone.
comfortMapVariables [Optional]
Set to "True" to have EnergyPlus solve for the air flow and air heat gain of each zone,
which is needed for the comfort map air stratification calculation.
zoneHVACParams [Optional]
Set to "True" to have EnergyPlus solve for the fractions of heating/cooling loads that are
latent vs. sensible as well as the the flow rate and temperature of supply air into each
zone.
surfaceTempAnalysis [Optional]
Set to "True" to have EnergyPlus solve for the interior and exterior surface temperatures
of the individual surfaces of each zone.
surfaceEnergyAnalysis [Optional]
Set to "True" to have EnergyPlus solve for the gains and losses through the individual
surfaces of each zone.
glazingSolarAnalysis [Optional]
Set to "True" to have EnergyPlus solve for the transmitted beam, diffuse, and total solar
gain through the individual window surfaces of each zone. These outputs are neededfor Energy Shade Benefit Analysis.
HBgeneration [Optional]
Set to "True" to have EnergyPlus solve for variables related to HB generation objects
like solar panels, wind turbines, batteries, etc.
timestep [Optional]
Specify a timestep by inputing the words 'hourly', 'daily', 'monthly' or 'annual'. The
default is set to hourly.
Honeybee Primer
318Generate_EP_Output
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 319/510
Outputs
report
Report!
simulationOutputs
EnergyPlus code that should be plugged into the "simulationOutputs" parameter of the
"writeIDF" component.
Check Hydra Example Files for Generate EP Output
Honeybee Primer
319Generate_EP_Output
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 320/510
OpenStudioHVACSystemsList
List ofavailable HVAC templates for OpenStudio
Inputs
Check Hydra Example Files for OpenStudioHVACSystemsList
Honeybee Primer
320OpenStudioHVACSystemsList
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 321/510
OpenStudio Systems
OpenStudio Systems, without the inputs in airSideDetails and plantDetails default Open
Studio systems will be created. -
Inputs
HBZones [Required]
...
HVACSystems [Required]
Honeybee Primer
321OpenStudio_Systems
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 322/510
...
airSideDetails [Default]
Use Honeybee_OpenStudio detail component to define the details
plantDetails [Default]
plug in plant side details component here to include them in results
seeHVACDesc [Default]
Set to True to see the HVAC system description
Outputs
readMe!
Script variable OSHVACSystems
HBZones
...
airsideDetails
Script variable OSHVACSystems
Check Hydra Example Files for OpenStudio Systems
Honeybee Primer
322OpenStudio_Systems
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 323/510
Set Ideal Air Loads Parameters
Use this component to change aspects of the ideal air system used in the "Honeybee_Run
Energy Simulation" component. The includes the temperature of the heating/cooling supply
air, the maximum capacity of the system, demand controlled ventilation, air-side
economizers, and heat recovery. -
Inputs
HBZones [Required]
HBZones for which parameters of the ideal air system should be changed.
Honeybee Primer
323Set_Ideal_Air_Loads_Parameters
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 324/510
outdoorAirReq [Optional]
An integer or text string value that changes the outdoor air requirement of the zone (the
default is set to "0 - Sum"). Choose from the following options: 0 - Sum - The outdoor air
coming through the mechnical system will be the sum of the specified flow/m2 of zone
floor area and the flow/person. This is the default and is the usual recommendation of ASHRAE 1 - Maximum - The outdoor air coming through the mechnical system will be
either the specified flow/m2 of zone floor area or the flow/person (depending on which is
larger at a given hour). Choosing this option effectively implies that there is a demand-
controlled ventilation system set up in the zone. 2 - None - No outdoor air will come
through the mechanical system and the heating/cooling will be applied only through re-
circulation of indoor air. Be careful as this option might not bring enough fresh air to
occupants if the zone's infiltration is very low.
coolSupplyAirTemp [Optional]
A number or list of numbers that represent the temperature of the air used to cool the
zone in degrees Celcius. If no value is input here, the system will use air at 13 C. This
input can be either a single number to be applied to all connected zones or a list of
numbers for each different zone.
heatSupplyAirTemp [Optional]
A number or list of numbers that represent the temperature of the air used to heat thezone in degrees Celcius. If no value is input here, the system will use air at 50 C. This
input can be either a single number to be applied to all connected zones or a list of
numbers for each different zone.
maxCoolingCapacity [Optional]
A number or list of numbers that represent the maximum cooling power that the system
can deliver in kiloWatts. If no value is input here, the system will have no limit to its
cooling capacity. This input can be either a single number to be applied to all connectedzones or a list of numbers for each different zone.
maxHeatingCapacity [Optional]
A number or list of numbers that represent the maximum heating power that the system
can deliver in kiloWatts. If no value is input here, the system will have no limit to its
heating capacity. This input can be either a single number to be applied to all connected
zones or a list of numbers for each different zone.
airSideEconomizer [Optional]
Honeybee Primer
324Set_Ideal_Air_Loads_Parameters
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 325/510
Set to "True" to have the ideal air system include an air side economizer. This
essentially means that the HVAC system will increase the outdoor air flow rate when
there is a cooling load and the outdoor air temperature is below the temperature of the
exhaust air. If this input is set to "False", the HVAC system will constantly provide the
same amount of outdoor air and will run the compressor to remove heat. This may
result in cases where there is a lot of cooling energy in winter or unexpected parts of the
year. This input can be either a single boolean value to be applied to all connected
zones or a list of boolean values for each different zone. The defailt is set to "True" to
include an air side economizer.
heatRecovery [Optional]
Set to "True" to have the ideal air system include a heat recovery system. This
essentially means that the HVAC system will pass the outlet air through a heat
exchanger with the inlet air before exhausting it, helping recover heat that would
normally be lost through the exhaust. If this input is set to "False" or left untouched, the
HVAC system will simply exhaust air without having it interact with incoming air. This
input can be either a single boolean value to be applied to all connected zones or a list
of boolean values for each different zone.
recoveryEffectiveness [Optional]
If the above input has been set to "True", input a number between 0 and 1 here to set
the fraction of heat that is recovered by the heat recovery system. By default, this value
is 0.7.
Outputs
readMe!
The execution information, as output and error streams
HBZones
HBZones with altered ideal air loads systems.
Check Hydra Example Files for Set Ideal Air Loads Parameters
Honeybee Primer
325Set_Ideal_Air_Loads_Parameters
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 326/510
Import idf
import an idf file to gh This version only imports the geometries Constructions, schedules
and systems will be neglected
Inputs
idfFile [Required]
File path to an idf file
importEPObjects [Optional]
Honeybee Primer
326Import_idf
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 327/510
Set to True if you want Honeybee import constructions, materials and schedules from
this file. You need to do it only once. In case there is an object with similar name already
in Honeybee library object will not be imported and you need to rename it in the idf file.
Outputs
readMe!
...
HBZones
List of Honeybee zones imported from .idf file
shadings
Shading objects if any
Check Hydra Example Files for Import idf
Honeybee Primer
327Import_idf
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 328/510
Read EP Result
This component reads the results of an EnergyPlus simulation from the WriteIDF
Component or any EnergyPlus result .csv file address. Note that, if you use this component
without the WriteIDF component, you should make sure that a corresponding .eio file is next
to your .csv file at the input address that you specify. _ This component reads only the
results related to zones. For results related to surfaces, you should use the
"Honeybee_Read EP Surface Result" component. -
Inputs
resultFileAddress [Required]
Honeybee Primer
328Read_EP_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 329/510
The result file address that comes out of the WriteIDF component.
normByFloorArea [Optional]
Set to 'True' to normalize all zone energy data by floor area (note that the resulting units
will be kWh/m2 as EnergyPlus runs in the metric system). The default is set to "False."
Outputs
totalThermalEnergy
The total thermal energy used by each zone in kWh. This includes cooling and heating.
thermalEnergyBalance
The thermal energy used by each zone in kWh. Heating values are positive while
cooling values are negative.
cooling
The cooling energy needed in kWh. For Ideal Air loads, this is the sum of sensible and
latent heat that must be removed from each zone. For distributed OpenStudio systems
like Packaged Terminal Heat Pumps (PTHP), this will be electric energy for each zone.
For central OpenStudio systems, this ouput will be a single list of chiller electric energy
for the whole building.
heating
The heating energy needed in kWh. For Ideal Air loads, this is the sum of sensible and
latent heat that must be removed from each zone. For distributed OpenStudio systems
like Packaged Terminal Heat Pumps (PTHP), this will be electric energy for each zone.
For central OpenStudio systems, this ouput will be a single list of boiler heat energy for
the whole building.
electricLight
The electric lighting energy needed for each zone in kWh.
electricEquip
The electric equipment energy needed for each zone in kWh.
peopleGains
The internal heat gains in each zone resulting from people (kWh).
Honeybee Primer
329Read_EP_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 330/510
totalSolarGain
The total solar gain in each zone(kWh).
infiltrationEnergy
The heat loss (negative) or heat gain (positive) in each zone resulting from infiltration
(kWh).
outdoorAirEnergy
The heat loss (negative) or heat gain (positive) in each zone resulting from the outdoor
air coming through the HVAC System (kWh).
Check Hydra Example Files for Read EP Result
Honeybee Primer
330Read_EP_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 331/510
Read EP Surface Result
This component reads the results of an EnergyPlus simulation from the WriteIDF
Component or any EnergyPlus result .csv file address. Note that, if you use this component
without the WriteIDF component, you should make sure that a corresponding .eio file is next
to your .csv file at the input address that you specify. _ This component reads only the
results related to surfaces. For results related to zones, you should use the
"Honeybee_Read EP Result" component. -
Inputs
resultFileAddress [Required]
Honeybee Primer
331Read_EP_Surface_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 332/510
The result file address that comes out of the WriteIDF component.
normBySrfArea [Optional]
Set to 'True' to normalize all surface energy data by the area of the suraces (note that
the resulting units will be kWh/m2 as EnergyPlus runs in the metric system). The default
is set to "False."
Outputs
surfaceIndoorTemp
The indoor surface temperature of each surface (degrees Celcius).
surfaceOutdoorTemp
The outdoor surface temperature of each surface (degrees Celcius).
surfaceEnergyFlow
The heat loss (negative) or heat gain (positive) through each building surfaces (kWh).
opaqueEnergyFlow
The heat loss (negative) or heat gain (positive) through each building opaque surface
(kWh).
glazEnergyFlow
The heat loss (negative) or heat gain (positive) through each building glazing surface
(kWh). Note that the value here includes both solar gains and conduction losses/gains.
windowTotalSolarEnergy
The total solar energy transmitted through each of the glazing surfaces to the zone(kWh).
windowBeamEnergy
The total direct solar beam energy transmitted through each of the glazing surfaces to
the zone (kWh).
windowDiffEnergy
The total diffuse solar energy transmitted through each of the glazing surfaces to thezone (kWh).
Honeybee Primer
332Read_EP_Surface_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 333/510
windowTransmissivity
The hourly transmissivity of the exterior windows of the model. This data is needed to
align a comfort map with an energy model possessing shades.
otherSurfaceData
Other surface data that is in the result file (in no particular order). Note that this data
cannot be normalized by floor area as the component does not know if it can be
normalized.
Check Hydra Example Files for Read EP Surface Result
Honeybee Primer
333Read_EP_Surface_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 334/510
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. This
component separates all surface types but takes sevaral seconds to load and requires
HBZones. For a quicker splitting of data, use the "Honeybee_Surface Data Based On Type"
component. -
Inputs
HBZones [Required]
Honeybee Primer
334Surface_Data_Based_On_Type_Detailed
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 335/510
Honeybee Zone
srfData [Required]
Script variable decomposeByType
Outputs
walls
A grafted list of surface data for walls.
interiorWalls
A grafted list of surface data for interior walls.
airWalls
A grafted list of surface data for air walls.
windows
A grafted list of surface data for exterior windows.
interiorWindows
A grafted list of surface data for interior windows.
skylights
A grafted list of surface data for skylights.
roofs
A grafted list of surface data for roofs.
ceilings
A grafted list of surface data for ceilings.
floors
A grafted list of surface data for floors.
exposedFloors
A grafted list of surface data for exposed floors.
Honeybee Primer
335Surface_Data_Based_On_Type_Detailed
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 336/510
groundFloors
A grafted list of surface data for ground floors.
undergroundWalls
A grafted list of surface data for underground walls.
undergroundSlabs
Script variable decomposeByType
undergroundCeilings
A grafted list of surface data for underground ceilings.
Check Hydra Example Files for Surface Data Based On Type Detailed
Honeybee Primer
336Surface_Data_Based_On_Type_Detailed
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 337/510
Color Surfaces by EP Result
Use this component to color zone surfaces based on EnergyPlus data out of the
"HoneybeeRead EP Surface Result" component. By default, zone surfaces will be colored
based on total energy per unit surface area in the case of energy input data or colored
based on average value of each surface in the case of temperature or data that is already
normalized. If total annual simulation data has been connected, the analysisPeriod input can
be used to select out a specific period fo the year for coloration. In order to color surfaces by
individual hours/months, connecting interger values to the "stepOfSimulation" will allow you
to scroll though each step of the input data. -
Inputs
Honeybee Primer
337Color_Surfaces_by_EP_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 338/510
srfData [Required]
A list surface data out of the 'Honeybee_Read EP Surface Result' component.
HBZones [Required]
The HBZones out of any of the HB components that generate or alter zones. Note that
these should ideally be the zones that are fed into the Run Energy Simulation
component as surfaces may not align otherwise. Zones read back into Grasshopper
from the Import idf component will not align correctly with the EP Result data.
analysisPeriod [Optional]
Optional analysisPeriod to take a slice out of an annual data stream. Note that this will
only work if the connected data is for a full year and the data is hourly. Otherwise, this
input will be ignored. Also note that connecting a value to 'stepOfSimulation' will
override this input.
stepOfSimulation [Optional]
Optional interger for the hour of simulation to color the surfaces with. Connecting a
value here will override the analysisPeriod_ input.
legendPar [Optional]
Optional legend parameters from the Ladybug Legend Parameters component.
recallHBHive [Optional]
Set to 'True' to recall the zones from the hive each time the input changes and 'False' to
simply copy the zones to memory. Calling the zones from the hive can take some more
time but this is necessary if you are making changes to the zones and you want to
check them. Otherwise, if you are just scrolling through attributes, it is nice to set this to
'False' for speed. The default is set to 'False' for speed.
runIt [Required]
Set boolean to 'True' to run the component and color the zone surfaces.
Outputs
readMe!
...
srfColoredMesh
Honeybee Primer
338Color_Surfaces_by_EP_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 339/510
A list of meshes for each surface, each of which is colored based on the input _srfData.
zoneWireFrame
A list of curves representing the outlines of the zones. This is particularly helpful if one
wants to scroll through individual meshes but still see the outline of the building.
legend
A legend of the surface colors. Connect this output to a grasshopper 'Geo' component in
order to preview the legend spearately in the Rhino scene.
legendBasePt
The legend base point, which can be used to move the legend in relation to the building
with the grasshopper 'move' component.
analysisTitle
The title of the analysis stating what the surfaces are being colored with.
srfBreps
A list of breps for each zone surface. Connecting this output and the following
zoneColors to a Grasshopper 'Preview' component will thus allow you to see the
surfaces colored transparently.
srfColors
A list of colors that correspond to the colors of each zone surface. These colors include
alpha values to make them slightly transparent. Connecting the previous output and this
output to a Grasshopper 'Preview' component will thus allow you to see the surfaces
colored transparently.
srfValues
The values of the input data that are being used to color the surfaces.
Check Hydra Example Files for Color Surfaces by EP Result
Honeybee Primer
339Color_Surfaces_by_EP_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 340/510
Color Zones by EP Result
Use this component to color zones based on EnergyPlus data out of the "HoneybeeRead EP
Result" component or zone comfort analyses out of the comfort calculator components. By
default, zones will be colored based on total energy per unit floor area of the zone in the
case of energy input data or colored based on total average value of each zone in the case
of temperature, humidity or comfort input data. If total annual simulation data has been
connected, the analysisPeriod input can be used to select out a specific period fo the year
for coloration. In order to color zones by individual hours/months, connecting interger values
to the "stepOfSimulation" will allow you to scroll though each step of the input data. -
Inputs
Honeybee Primer
340Color_Zones_by_EP_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 341/510
zoneData [Required]
A list zone data out of the Read EP Result component or the comfort calculator
components that have zone data hooked up to them.
HBZones [Required]
The HBZones out of any of the HB components that generate or alter zones. Note that
these should ideally be the zones that are fed into the Run Energy Simulation
component or zones read back into Grasshopper from the Import idf component in order
to ensure alignment with the EP Result data.
normalizeByFloorArea [Optional]
Set boolean to 'True' in order to normalize results by the floor area of the zone and set
to 'False' to color zones based on total zone values. The default is set to 'True' such that
colored zones communicate energy intensity rather than total energy. Note that this
input will be ignored if connected data is Temperature, Humidity, a Comfort Metric, or
EUI (which is already normalized by floor area).
analysisPeriod [Optional]
Optional analysisPeriod to take a slice out of an annual data stream. Note that this will
only work if the connected data is for a full year and the data is hourly. Otherwise, this
input will be ignored. Also note that connecting a value to 'stepOfSimulation' will
override this input.
stepOfSimulation [Optional]
Optional interger for the hour of simulation to color the zones with. Connecting a value
here will override the analysisPeriod_ input.
legendPar [Optional]
Optional legend parameters from the Ladybug Legend Parameters component.
recallHBHive [Optional]
Set to 'True' to recall the zones from the hive each time the input changes and 'False' to
simply copy the zones to memory. Calling the zones from the hive can take some more
time but this is necessary if you are making changes to the zones and you want to
check them. Otherwise, if you are just scrolling through attributes, it is nice to set this to
'False' for speed. The default is set to 'False' for speed.
runIt [Required]
Honeybee Primer
341Color_Zones_by_EP_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 342/510
Set boolean to 'True' to run the component and color the zones.
Outputs
readMe!
...
zoneColoredMesh
A list of meshes for each zone, each of which is colored based on the input _zoneData.
zoneWireFrame
A list of curves representing the outlines of the zones. This is particularly helpful if one
wants to scroll through individual zone meshes but still see the outline of the building.
legend
A legend of the zone colors. Connect this output to a grasshopper 'Geo' component in
order to preview the legend spearately in the Rhino scene.
legendBasePt
The legend base point, which can be used to move the legend in relation to the building
with the grasshopper 'move' component.
analysisTitle
The title of the analysis stating what the zones are being colored with.
zoneBreps
A list of breps for each zone. This is essentially the same as the _HBZones input.
Connecting this output and the following zoneColors to a Grasshopper 'Preview'component will thus allow you to see the zones colored transparently.
zoneColors
A list of colors that correspond to the colors of each zone. These colors include alpha
values to make them slightly transparent. Connecting the previous output and this
output to a Grasshopper 'Preview' component will thus allow you to see the zones
colored transparently.
zoneValues
Honeybee Primer
342Color_Zones_by_EP_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 343/510
The values of the input data that are being used to color the zones.
floorNormZoneData
The input data normalized by the floor area of it corresponding zone.
Check Hydra Example Files for Color Zones by EP Result
Honeybee Primer
343Color_Zones_by_EP_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 344/510
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. Solar vectors for hours when the building is heating contribute
positively to shade desirability while solar vectors for hours when the building is cooling
contribute negatively. This conrtibution is weighted by how much the building is cooling or
heating in realtion to the solar beam gain through the window in question. The component
outputs a colored mesh of the shade illustrating the net effect of shading each mesh face. A
higher saturation of blue indicates that shading the cell is very desirable. A higher saturationof red indicates that shading the cell is harmful (blocking more winter sun than summer sun).
Desaturated cells indicate that shading the cell will have relatively little effect on outdoor
Honeybee Primer
344Energy_Shade_Benefit_Evaluator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 345/510
comfort or building performance. The units for shade desirability are net kWh saved per unit
area of shade if the test cell is blue. If the test cell is red, the units are net heating kWh
harmed per unit area of shade. The method used by this component is based off of the
Shaderade method developed by Christoph Reinhart, Jon Sargent, Jeffrey Niemasz. This
component uses Shaderade's method for evaluating shade and window geometry in terms
of solar vectors. _ A special thanks goes to them and their research. A paper detailing the
Shaderade method is available at:
http://www.gsd.harvard.edu/research/gsdsquare/Publications/Shaderade_BS2011.pdf -
Inputs
location [Required]
The output from the importEPW or constructLocation component. This is essentially a
list of text summarizing a location on the earth.
coolingLoad [Required]
The hourly cooling load of the window's corresponding zone (including ladybug header).
heatingLoad [Required]
The hourly heating load of the window's corresponding zone (including ladybug header).
beamGain [Required]
The hourly beam gain through the window (including ladybug header).
testShades [Required]
A Brep representing the shade to be evaluated for its benefit.
testWindow [Required]
A brep representing a window for which shading is being considered. Note that only
breps with a single surface are supported now and volumetric breps will be included at a
later point.
gridSize [Optional]
The length of each of the shade's test cells in model units. Please note that, as this
value gets lower, simulation times will increase exponentially even though this will give a
higher resolution of shade benefit.
context [Optional]
Honeybee Primer
345Energy_Shade_Benefit_Evaluator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 346/510
If there is static external context that could block sun vectors at certain hours, connect
context breps here to account for them in the shade benefit evaluation.
north [Optional]
Input a vector to be used as a true North direction for the sun path or a number between
0 and 360 that represents the degrees off from the y-axis to make North. The default
North direction is set to the Y-axis (0 degrees).
skyResolution [Optional]
An interger equal to 0 or above to set the number of times that the tergenza sky patches
are split. A higher number will ensure a greater accuracy but will take longer. At a sky
resolution of 4, each hour's temperature is essentially matched with an individual sun
vector for that hour. At a resolution of 5, a sun vector is produced for every half-hour, at
6, every quarter hour, and so on. The default is set to 4, which should be high enough of
a resolution to produce a meaningful reault in all cases.
delNonIntersect [Optional]
Set to "True" to delete mesh cells with no intersection with sun vectors. Mesh cells
where shading will have little effect because an equal amount of warm and cool
temperature vectors will still be left in white.
legendPar [Optional]
Legend parameters that can be used to re-color the shade, change the high and low
boundary, or sync multiple evaluated shades with the same colors and legend
parameters.
parallel [Optional]
Set to "True" to run the simulation with multiple cores. This can increase the speed of
the calculation substantially and is recommended if you are not running other big or important processes.
runIt [Required]
Set to 'True' to run the simulation.
Outputs
readMe!
...
Honeybee Primer
346Energy_Shade_Benefit_Evaluator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 347/510
sunVectors
The sun vectors that were used to evaluate the shade (note that these will increase as
the sky desnity increases).
windowTestPts
Points across the window surface from which sun vectors will be projected
shadeMesh
A colored mesh of the _testShades showing where shading is helpful (in satuated blue),
harmful (in saturated red), or does not make much of a difference (white or desaturated
colors).
legend
Legend showing the numeric values of degree-days that correspond to the colors in the
shade mesh.
legendBasePoint
Script variable Shade Benefit
shadeHelpfulness
The cumulative kWh/m2 of building operational energy helped by shading the given cell.
shadeHarmfulness
The cumulative kWh/m2 of building operational energy harmed by shading the given
cell. Note that these values are all negative due to the fact that the shade is harmful.
shadeNetEffect
The sum of the helpfulness and harmfulness for each cell. This will be negative if
shading the cell has a net harmful effect and positive if the shade has a net helpful
effect. Values are in kWh/m2 of building operational energy helped/harmed by shading
the given cell.
Check Hydra Example Files for Energy Shade Benefit Evaluator
Honeybee Primer
347Energy_Shade_Benefit_Evaluator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 348/510
Optimal Shade Creator
Use this component to delete out unwanted areas of a shade after a shade benefit
evaluation has been run. This will help turn your shade evaluation results into an actual
shade brep based on a percentage of beneficial shade cells that you decide. -
Inputs
shadeMesh [Required]
The shade mesh out of either of the shade benefit evaluators.
Honeybee Primer
348Optimal_Shade_Creator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 349/510
shadeNetEffect [Required]
The shade net effect out of either of the shade benefit evaluators.
percentToKeep [Optional]
A number between 0 and 100 that represents the percentage of the beneficial shade
cells that you would like to keep. By default, this is set to 25% but you may want to
move it down if the area of your resulting shade is very large or move it up if you want to
save more energy and do not care about the area of your shade.
levelOfPerform [Optional]
An optional number that represents the mimimum acceptable energy savings per
square area unit to be included in the created shade. An input here will override the
percent input above.
Outputs
readMe!
...
energySavedByShade
The anticipated energy savings (or degree-days helped) for the shade output below.
Values should be in kWh for energy shade benefit or degrees C for comfort shade
benefit.
areaOfShade
The area of the shade brep below in model units.
newColoredMesh
A new colored mesh with the unhelpful cells deleted out of it.
newShadeBrep
A new shade brep that represents the most effective shade possible.
Check Hydra Example Files for Optimal Shade Creator
Honeybee Primer
349Optimal_Shade_Creator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 350/510
Adaptive Comfort Analysis Recipe
Use this component to assemble an adaptive comfort recipe for the "Honeybee_Annual
Indoor Comfort Analysis" component. -
Inputs
viewFactorMesh [Required]
The data tree of view factor meshes that comes out of the "Honeybee_Indoor View
Factor Calculator".
Honeybee Primer
350 Adaptive_Comfort_Analysis_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 351/510
viewFactorInfo [Required]
The python list that comes out of the "Honeybee_Indoor View Factor Calculator".
epwFile [Required]
The epw file that was used to run the EnergyPlus model. This will be used to generate
sun vectors and get radiation data for estimating the temperature delta for sun falling on
occupants.
north [Optional]
Input a vector to be used as a true North direction for the comfort analysis or a number
between 0 and 360 that represents the degrees off from the y-axis to make North. The
default North direction is set to the Y-axis (0 degrees).
srfIndoorTemp [Required]
A list surfaceIndoorTemp data out of the "Honeybee_Read EP Surface Result"
component.
srfOutdoorTemp [Optional]
A list surfaceOutdoorTemp data out of the "Honeybee_Read EP Surface Result"
component.
zoneAirTemp [Required]
The airTemperature output of the "Honeybee_Read EP Result" component.
zoneAirFlowVol [Required]
The airFlowVolume output of the "Honeybee_Read EP Result" component.
zoneAirHeatGain [Required]
The airHeatGainRate output of the "Honeybee_Read EP Result" component.
comfortPar [Optional]
Set to "True" to have the comfort standard be 80 percent of occupants comfortable and
set to "False" to have the comfort standard be 90 percent of all occupants comfortable.
The default is set to "False" for 90 percent, which is what most members of the building
industry aim for. However some projects will occasionally use 90%.
wellMixedAirOverride [Optional]
Honeybee Primer
351 Adaptive_Comfort_Analysis_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 352/510
Set to "True" if you know that your building will have a forced air system with diffusers
meant to mix the air as well as possilbe. This will prevent the calculation from running
the air stratification function and instead assume well mixed conditions. This input can
also be a list of 8760 boolean values that represent the hours of the year when a forced
air system or ceiling fans are run to mix the air. The default is set to 'False' to run the
stratification calculation for every hour of the year, assuming no forced air
heating/cooling system.
inletHeightOverride [Optional]
An optional list of float values that match the data tree of view factor meshes and
represent the height, in meters, from the bottom of the view factor mesh to the window
inlet height. This will override the default value used in the air stratification calculation,
which sets the inlet height in the bottom half of the average glazing height.
windowShadeTransmiss [Optional]
A decimal value between 0 and 1 that represents the transmissivity of the shades on the
windows of a zone (1 is no shade and 0 is fully shaded). This input can also be a list of
8760 values between 0 and 1 that represents a list of hourly window shade
transmissivities to be applied to all windows of the model. Finally and most importantly,
this can be the 'windowTransmissivity' output of the 'Read EP Surface Result'
component for an energy model that has been run with window shades. This final option
ensures that the energy model and the confort map results are always aligned although
it is the most computationally expensive of the options. The default is set to 0, which
assumes no additional shading to windows.
cloAbsorptivity [Optional]
An optional decimal value between 0 and 1 that represents the fraction of solar radiation
reflected off of the ground. By default, this is set to 0.25, which is characteristic of most
indoor floors. You may want to increase this value for concrete or decrease it for dark
carpets.
additionalWindSpeed [Optional]
An additional value of indoor wind speed in m/s to be added to the base speed
computed from the zone volume and hourly flow volume. Use this input to account for
objects like ceiling fans that might increase the interior wind speed felt by the occupants
while not affecting the total flow volume into the zone much. This input can also be a list
of 8760 additional wind speed values that represent the hours of the year when wind
speed is increased. Lastly, this input can be a data tree of values with branches that are
each 8760 values long and correspond to the branches of the input viewFactorMesh_.
Honeybee Primer
352 Adaptive_Comfort_Analysis_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 353/510
This last option enables you to specify different wind speeds for different continuous air
volumes.
outdoorTerrain [Optional]
An interger from 0 to 3 that sets the terrain class associated with the wind speed used in
outdoor wind calculations. Interger values represent the following terrain classes: 0 =
Urban: large city centres, 50% of buildings above 21m over a distance of at least 2000m
upwind. 1 = Suburban: suburbs, wooded areas. 2 = Country: open, with scattered
objects generally less than 10m high. 3 = Water: Flat, unobstructed areas exposed to
wind flowing over a large water body (no more than 500m inland).
Outputs
comfRecipe
An analysis recipe for the "Honeybee_Annual Indoor Comfort Analysis" component.
Check Hydra Example Files for Adaptive Comfort Analysis Recipe
Honeybee Primer
353 Adaptive_Comfort_Analysis_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 354/510
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. _ This component is
a necessary step before creating an thermal map of an energy model. -
Inputs
HBZones [Required]
The HBZones out of any of the HB components that generate or alter zones. Note that
these should ideally be the zones that are fed into the Run Energy Simulation
Honeybee Primer
354Indoor_View_Factor_Calculator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 355/510
component as surfaces may not align otherwise. Zones read back into Grasshopper
from the Import idf component will not align correctly with the EP Result data.
gridSize [Optional]
A number in Rhino model units to make each cell of the view factor mesh.
distFromFloorOrSrf [Optional]
A number in Rhino model units to set the distance of the view factor mesh from the
ground.
additionalShading [Optional]
Add in additional shading breps here for geometry that is not a part of the zone but can
still block direct sunlight to occupants. Examples include outdoor context shading andindoor furniture.
addShdTransmiss [Optional]
An optional transmissivity that will be used for all of the objects connected to the
additionalShading input. This can also be a list of transmissivities whose length matches
the number of breps connected to additionalShading input, which will assign a different
transmissivity to each object. Lastly, this input can also accept a data tree with a
number of branches equal to the number of objects connected to the additionalShadinginput with a number of values in each branch that march the number of hours in the
simulated analysisPeriod (so, for an annual simulation, each branch would have 8760
values). The default is set to assume that all additionalShading objects are completely
opaque. As one adds in transmissivities with this input, the calculation time will increase
accordingly.
includeOutdoor [Optional]
Set to 'True' to have the final visualization take the parts of the input Srf that areoutdoors and color them with temperatures representative of outdoor conditions. Note
that these colors of conditions will only approximate those of the outdoors, showing the
assumptions of the Energy model rather than being a perfectly accurate representation
of outdoor conditions. The default is set to 'False' as the inclusion of outdoor conditions
can often increase the calculation time.
viewResolution [Optional]
An interger between 0 and 4 to set the number of times that the tergenza skyviewpatches are split. A higher number will ensure a greater accuracy but will take longer.
Honeybee Primer
355Indoor_View_Factor_Calculator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 356/510
The default is set to 0 for a quick calculation.
removeAirWalls [Optional]
Set to "True" to remove air walls from the view factor calculation. The default is set to
"True" sinc you usually want to remove air walls from your view factor calculations.
recallHBHive [Optional]
Set to "True" to recall the zones from the hive each time the input changes and "False"
to simply copy the zones to memory. Calling the zones from the hive can take some
more time but this is necessary if you are making changes to the zones and you want to
check them. Otherwise, if you are performing a parametric run that does not change the
geometry, it is nice to set this to "False" for speed. The default is set to "True" as it's
often better to be safe and just recalle the zones.
parallel [Optional]
Set to "True" to run the calculation with multiple cores and "False" to run it with a single
core. Multiple cores can increase the speed of the calculation substantially and is
recommended if you are not running other big or important processes. The default is set
to "True."
buildMesh [Required]
Set boolean to "True" to generate a mesh based on your zones and the input
distFromFloorOrSrf and gridSize. This is a necessary step before calculating view
factors from each test point to the surrounding zone surfaces.
runIt [Required]
Set boolean to "True" to run the component and calculate viewFactors from each test
point to surrounding surfaces.
Outputs
readMe!
...
viewFactorMesh
A data tree of breps representing the split mesh faces of the view factor mesh.
viewFactorInfo
Honeybee Primer
356Indoor_View_Factor_Calculator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 357/510
A list of python data that carries essential numerical information for the Comfort Analysis
Workflow, including the view factors from each test point to a zone's surfaces, the sky
view factors of the test points, and information related to window plaement, used to
estimate stratification in the zone. This should be plugged into a "Comfort Analysis
Recipe" component.
testPts
The test points, which lie in the center of the mesh faces at which comfort parameters
are being evaluated.
viewMeshFaces
Script variable IndoorViewFactor
zoneWireFrame
A list of curves representing the outlines of the zones. This is particularly helpful if you
want to see the outline of the building in relation to the temperature and comfort maps
that you might produce off of these results.
viewVectors
The vectors that were used to caclulate the view factor (note that these will increase as
the viewResolution increases).
shadingContext
A list of meshes representing the opaque surfaces of the zone. These are what were
used to determine the sky view factor and the direct sun falling on occupants.
closedAirVolumes
The closed Breps representing the zones of continuous air volume (when air walls are
excluded). Zones within the same breps will have the stratification calculation done
together.
Check Hydra Example Files for Indoor View Factor Calculator
Honeybee Primer
357Indoor_View_Factor_Calculator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 358/510
Microclimate Map Analysis
Use this component runs an annual comfort assessment off of EnergyPlus results and write
all values into csv files. The results in these files can be used for creating indoor comfort
maps. -
Inputs
comfAnalysisRecipe [Required]
A comfort analysis recipe out of one of the comfort recipe component.
Honeybee Primer
358Microclimate_Map_Analysis
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 359/510
fileName [Optional]
An optional file name for the result files as a string.
workingDir [Optional]
An optional working directory on your system. Default is set to C:\Ladybug
analysisPeriodOrHOY [Optional]
An analysis period from the 'Ladybug Analysis Period' component or an hour of the
analysis between 1 and 8760 for which you want to conduct the analysis. If no value is
connected here, the component will run for only noon on the winter solstice. A single
HOY is used by default as longer analysis periods can take a very long time.
writeResultFile [Optional]
Set to 1 or 'True' to have the component write all results into CSV result files and set to
0 or 'False' to not have the component write these files. The default is set to 'True' as
these simulations can be long and you usually want a copy of your results. You may
want to set it to 'False' if you are just scrolling through key hours and want the fastest
run possible. Set to 2 if you want the component to only write the results of the last two
matrices (comfort results and degFromTarget).
parallel [Optional]
Set to "True" to run the component using multiple CPUs. This can dramatically decrease
calculation time but can interfere with other intense computational processes that might
be running on your machine. For this reason, the default is set to 'False.'
runIt [Required]
Set boolean to "True" to run the component and generate files for an annual indoor
comfort assessment.
Outputs
readMe!
...
radTempMtx
A python matrix containing MRT data for every hour of the analysis to be plugged intothe 'Honeybee_Visualize Annual Comfort Results' component.
Honeybee Primer
359Microclimate_Map_Analysis
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 360/510
airTempMtx
A python matrix containing air temperature data for every hour of the analysis to be
plugged into the 'Honeybee_Visualize Annual Comfort Results' component.
operativeTempMtx
A python matrix containing operative temperature data for every hour of the analysis to
be plugged into the 'Honeybee_Visualize Annual Comfort Results' component.
adaptComfMtx
A python matrix containing adaptive comfort data for every hour of the analysis to be
plugged into the 'Honeybee_Visualize Annual Comfort Results' component.
degFromTargetMtx
A python matrix containing degrees from tartget temperature data for every hour of the
analysis to be plugged into the 'Honeybee_Visualize Annual Comfort Results'
component.
radTempResult
A csv file address containing the radiant temperature resultsfor each point for every
hour of the analysis.
airTempResult
A csv file address containing the air temperature results for each point for every hour of
the analysis.
operativeTempResult
A csv file address containing the operative temperature results for each point for every
hour of the analysis.
adaptComfResult
A csv file address containing the a series of 0's and 1's indicating whether a certain
point is comfortable for every hour of the analysis.
degFromTargetResult
A csv file address containing the a series of numbers indicating the degrees that a
certain point is from the neutral temperature for every hour of the analysis.
Check Hydra Example Files for Microclimate Map Analysis
Honeybee Primer
360Microclimate_Map_Analysis
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 361/510
Honeybee Primer
361Microclimate_Map_Analysis
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 362/510
Outdoor Comfort Analysis Recipe
Use this component to assemble an adaptive comfort recipe for the "Honeybee_Annual
Indoor Comfort Analysis" component. -
Inputs
viewFactorMesh [Required]
The data tree of view factor meshes that comes out of the "Honeybee_Indoor View
Factor Calculator".
Honeybee Primer
362Outdoor_Comfort_Analysis_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 363/510
viewFactorInfo [Required]
The python list that comes out of the "Honeybee_Indoor View Factor Calculator".
epwFile [Required]
The epw file that was used to run the EnergyPlus model. This will be used to generate
sun vectors and get radiation data for estimating the temperature delta for sun falling on
occupants.
srfIndoorTemp [Optional]
A list surfaceIndoorTemp data out of the "Honeybee_Read EP Surface Result"
component.
srfOutdoorTemp [Required]
A list surfaceOutdoorTemp data out of the "Honeybee_Read EP Surface Result"
component.
zoneAirTemp [Optional]
The airTemperature output of the "Honeybee_Read EP Result" component.
zoneRelHumid [Optional]
The relativeHumidity output of the "Honeybee_Read EP Result" component.
zoneAirFlowVol [Optional]
The airFlowVolume output of the "Honeybee_Read EP Result" component.
zoneAirHeatGain [Optional]
The airHeatGainRate output of the "Honeybee_Read EP Result" component.
wellMixedAirOverride [Optional]
Set to "True" if you know that your building will have a forced air system with diffusers
meant to mix the air as well as possilbe. This will prevent the calculation from running
the air stratification function and instead assume well mixed conditions. This input can
also be a list of 8760 boolean values that represent the hours of the year when a forced
air system or ceiling fans are run to mix the air. The default is set to 'False' to run the
stratification calculation for every hour of the year, assuming no forced air
heating/cooling system.
inletHeightOverride [Optional]
Honeybee Primer
363Outdoor_Comfort_Analysis_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 364/510
An optional list of float values that match the data tree of view factor meshes and
represent the height, in meters, from the bottom of the view factor mesh to the window
inlet height. This will override the default value used in the air stratification calculation,
which sets the inlet height in the bottom half of the average glazing height.
windowShadeTransmiss [Optional]
A decimal value between 0 and 1 that represents the transmissivity of the shades on the
windows of a zone (1 is no shade and 0 is fully shaded). This input can also be a list of
8760 values between 0 and 1 that represents a list of hourly window shade
transmissivities to be applied to all windows of the model. Finally and most importantly,
this can be the 'windowTransmissivity' output of the 'Read EP Surface Result'
component for an energy model that has been run with window shades. This final option
ensures that the energy model and the confort map results are always aligned although
it is the most computationally expensive of the options. The default is set to 0, which
assumes no additional shading to windows.
cloAbsorptivity [Optional]
An optional decimal value between 0 and 1 that represents the fraction of solar radiation
reflected off of the ground. By default, this is set to 0.25, which is characteristic of most
indoor floors. You may want to increase this value for concrete or decrease it for dark
carpets.
additionalWindSpeed [Optional]
An additional value of indoor wind speed in m/s to be added to the base speed
computed from the zone volume and hourly flow volume. Use this input to account for
objects like ceiling fans that might increase the interior wind speed felt by the occupants
while not affecting the total flow volume into the zone much. This input can also be a list
of 8760 additional wind speed values that represent the hours of the year when wind
speed is increased. Lastly, this input can be a data tree of values with branches that are
each 8760 values long and correspond to the branches of the input viewFactorMesh_.
This last option enables you to specify different wind speeds for different continuous air
volumes.
outdoorTerrain [Optional]
An interger from 0 to 3 that sets the terrain class associated with the wind speed used in
outdoor wind calculations. Interger values represent the following terrain classes: 0 =
Urban: large city centres, 50% of buildings above 21m over a distance of at least 2000m
upwind. 1 = Suburban: suburbs, wooded areas. 2 = Country: open, with scattered
objects generally less than 10m high. 3 = Water: Flat, unobstructed areas exposed to
Honeybee Primer
364Outdoor_Comfort_Analysis_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 365/510
wind flowing over a large water body (no more than 500m inland).
Outputs
comfRecipe
An analysis recipe for the "Honeybee_Annual Indoor Comfort Analysis" component.
Check Hydra Example Files for Outdoor Comfort Analysis Recipe
Honeybee Primer
365Outdoor_Comfort_Analysis_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 366/510
PMV Comfort Analysis Recipe
Use this component to assemble an adaptive comfort recipe for the "Honeybee_Annual
Indoor Comfort Analysis" component. -
Inputs
viewFactorMesh [Required]
The data tree of view factor meshes that comes out of the "Honeybee_Indoor View
Factor Calculator".
Honeybee Primer
366PMV_Comfort_Analysis_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 367/510
viewFactorInfo [Required]
The python list that comes out of the "Honeybee_Indoor View Factor Calculator".
epwFile [Required]
The epw file that was used to run the EnergyPlus model. This will be used to generate
sun vectors and get radiation data for estimating the temperature delta for sun falling on
occupants.
srfIndoorTemp [Required]
A list surfaceIndoorTemp data out of the "Honeybee_Read EP Surface Result"
component.
srfOutdoorTemp [Optional]
A list surfaceOutdoorTemp data out of the "Honeybee_Read EP Surface Result"
component.
zoneAirTemp [Required]
The airTemperature output of the "Honeybee_Read EP Result" component.
zoneRelHumid [Required]
The relativeHumidity output of the "Honeybee_Read EP Result" component.
zoneAirFlowVol [Required]
The airFlowVolume output of the "Honeybee_Read EP Result" component.
zoneAirHeatGain [Required]
The airHeatGainRate output of the "Honeybee_Read EP Result" component.
metabolicRate [Optional]
A number representing the metabolic rate of the human subject in met. If no value is
input here, the component will assume a metabolic rate of 1 met, which is the metabolic
rate of a seated human being. This input can also accept a list of 8760 metabolic rates
to represent how an occuant's metabolic rate might change from hour to hour.
clothingLevel [Optional]
A number representing the clothing level of the human subject in clo. If no value is input
here, the component will assume a clothing level of 1 clo, which is roughly the insulation
Honeybee Primer
367PMV_Comfort_Analysis_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 368/510
provided by a 3-piece suit. A person dressed in shorts and a T-shirt has a clothing level
of roughly 0.5 clo and a person in a thick winter jacket can have a clothing level as high
as 2 to 4 clo. This input can also accept a list of 8760 clothing levels to represent how
an occuant's clothing might change from hour to hour.
comfortPar [Optional]
Optional comfort parameters from the "Ladybug_PMV Comfort Parameters" component.
Use this to adjust maximum and minimum acceptable humidity ratios. These comfortPar
can also change whether comfort is defined by eighty or ninety percent of people
comfortable. By default, comfort is defined as 90% of the occupants comfortable and
there are no limits on humidity when there is no thermal stress.
wellMixedAirOverride [Optional]
Set to "True" if you know that your building will have a forced air system with diffusers
meant to mix the air as well as possilbe. This will prevent the calculation from running
the air stratification function and instead assume well mixed conditions. This input can
also be a list of 8760 boolean values that represent the hours of the year when a forced
air system or ceiling fans are run to mix the air. The default is set to 'False' to run the
stratification calculation for every hour of the year, assuming no forced air
heating/cooling system.
inletHeightOverride [Optional]
An optional list of float values that match the data tree of view factor meshes and
represent the height, in meters, from the bottom of the view factor mesh to the window
inlet height. This will override the default value used in the air stratification calculation,
which sets the inlet height in the bottom half of the average glazing height.
windowShadeTransmiss [Optional]
A decimal value between 0 and 1 that represents the transmissivity of the shades on thewindows of a zone (1 is no shade and 0 is fully shaded). This input can also be a list of
8760 values between 0 and 1 that represents a list of hourly window shade
transmissivities to be applied to all windows of the model. Finally and most importantly,
this can be the 'windowTransmissivity' output of the 'Read EP Surface Result'
component for an energy model that has been run with window shades. This final option
ensures that the energy model and the confort map results are always aligned although
it is the most computationally expensive of the options. The default is set to 0, which
assumes no additional shading to windows.
cloAbsorptivity [Optional]
Honeybee Primer
368PMV_Comfort_Analysis_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 369/510
An optional decimal value between 0 and 1 that represents the fraction of solar radiation
reflected off of the ground. By default, this is set to 0.25, which is characteristic of most
indoor floors. You may want to increase this value for concrete or decrease it for dark
carpets.
additionalWindSpeed [Optional]
An additional value of indoor wind speed in m/s to be added to the base speed
computed from the zone volume and hourly flow volume. Use this input to account for
objects like ceiling fans that might increase the interior wind speed felt by the occupants
while not affecting the total flow volume into the zone much. This input can also be a list
of 8760 additional wind speed values that represent the hours of the year when wind
speed is increased. Lastly, this input can be a data tree of values with branches that are
each 8760 values long and correspond to the branches of the input viewFactorMesh_.
This last option enables you to specify different wind speeds for different continuous air
volumes.
outdoorTerrain [Optional]
An interger from 0 to 3 that sets the terrain class associated with the wind speed used in
outdoor wind calculations. Interger values represent the following terrain classes: 0 =
Urban: large city centres, 50% of buildings above 21m over a distance of at least 2000m
upwind. 1 = Suburban: suburbs, wooded areas. 2 = Country: open, with scattered
objects generally less than 10m high. 3 = Water: Flat, unobstructed areas exposed to
wind flowing over a large water body (no more than 500m inland).
Outputs
comfRecipe
An analysis recipe for the "Honeybee_Annual Indoor Comfort Analysis" component.
Check Hydra Example Files for PMV Comfort Analysis Recipe
Honeybee Primer
369PMV_Comfort_Analysis_Recipe
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 370/510
Read Microclimate Matrix
This component reads the results of an Adaptive Indoor Comfort Analysis. Note that this
usually takes about a minute -
Inputs
comfResultFileAddress [Required]
Any one of the result file addresses that comes out of the 'Honeybee_Microclimate Map
Analysis' component or the 'Honeybee_Thermal Comfort Autonomy Analysis'
component.
Honeybee Primer
370Read_Microclimate_Matrix
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 371/510
Outputs
comfResultsMtx
A matrix of comfort data that can be plugged into the "Visualize Comfort Results"
component.
Check Hydra Example Files for Read Microclimate Matrix
Honeybee Primer
371Read_Microclimate_Matrix
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 372/510
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. 'Occupied
Thermal Comfort Percent' (occTCP) is defined here as the the percent of occupied time
where a point of space meets or exceeds a given set of thermal comfort acceptability
criteria. Precedents for Thermal Comfort Percent (TCP) as a metric to spatially evaluate the
desirability of a given space can be found in the PhD thesis of Tarek Rakha
( http://www.tarekrakha.com/#/research/ ). 'Thermal Autonomy' (TA) is defined here as the the
percent of occupied time where a point of space meets or exceeds a given set of thermalcomfort acceptability criteria through passive means only. Precedents for Thermal Autonomy
(TA) as a metric to evaluate the passive operation of a given space can be found in the work
Honeybee Primer
372Thermal_Autonomy_Analysis
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 373/510
of Brendon Levitt. Levitt, B.; Ubbelohde, M.; Loisos, G.; Brown, N. Thermal Autonomy as
Metric and Design Process. Loisos + Ubbelohde, Alameda, California, California College of
the Arts, San Francisco. 2013.
(http://www.coolshadow.com/research/Levitt_Thermal%20Autonomy%20as%20Metric%20a
nd%20Design%20Process.pdf ) -
Inputs
comfResultsMtx [Required]
A comfort matrix (adaptive, PMV or Outdoor) output from either the
'Honeybee_Microclimate Map Analysis' component or the 'Honeybee_Read
Microclimate Matrix' component.
degOrPMVMtx [Required]
The degreeFromTargetMtx, PMV_Mtx, or DegFromNeutralMtx from either the
'Honeybee_Microclimate Map Analysis' component or the 'Honeybee_Read
Microclimate Matrix' component.
viewFactorMesh [Required]
The list of view factor meshes that comes out of the "Honeybee_Indoor View Factor
Calculator".
HBZones [Required]
The HBZones out of any of the HB components that generate or alter zones. Note that
these should ideally be the zones that are fed into the Run Energy Simulation
component as surfaces may not align otherwise. Zones read back into Grasshopper
from the Import idf component will not align correctly with the EP Result data.
totalThermalEnergy [Default]
The totalThermalEnergy output from the "Honeybee_Read EP Result" component. If no
data tree is connected here, it will be assumed that all zones are completely passive
and only occupancy will be taken into accout for the Thermal Autonomy calculation.
occupancyFiles [Optional]
Optional occupancy CSV files that will be used to set the occupied period of the
Thermal Autonomy calculation. These can be either EnergyPlus CSV schedules made
with the 'Honeybee_Create CSV Schedule' component or Daysim occupancy files made
with the 'Honyebee_Daysim Occupancy Generator' component (the two produce files of
Honeybee Primer
373Thermal_Autonomy_Analysis
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 374/510
the same format). This can be either a list of files that match the connected HBZones or
a single occupancy file to be used for all connected zones. By default, this component
will create the occupancy peirod from the occupancy schedule assigned to the
connected _HBzones so you should usually not have need for this input and should
instead change the HBZone occupancy schedule before running the simulation.
occupancyThreshold [Optional]
An optional number between 0 and 1 that sets the minimum occupancy at which a zone
is considered occupied. This is done as the default occupancy is taken from the
HBZone's occupancy schedules and, in some cases this value is low enough to ignore
for the sake of calculating thermal autonomy. The default is set to 0 such that any time
when the zones are occpied count towards the values calculated by this component.
fileName [Optional]
An optional file name for the result files as a string.
workingDir [Optional]
An optional working directory on your system. Default is set to C:\Ladybug
writeResultFile [Optional]
Set to 1 or 'True' to have the component write all results into CSV result files and set to0 or 'False' to not have the component write these files. The default is set to 'True' as
these simulations can be long and you usually want a copy of your results. You may
want to set it to 'False' if you are just scrolling through key hours and want the fastest
run possible. Set to 2 if you want the component to only write the results for the TCPocc
and TCA matrices.
parallel [Optional]
Set to 'True' to have the operation run with multiple cores and 'False' to run it with asingle core. Note that, because the calculation performed by this component is fairly
simple, setting parallel to 'True' can sometimes increase the calculation time so it should
only be used in cases where there are a large number of test points. Because of the
possibility of increaseing calculation time, the default is set to 'False' to run the
operation as single-core.
runIt [Required]
Set boolean to "True" to run the component and calculate comfort autonomy.
Honeybee Primer
374Thermal_Autonomy_Analysis
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 375/510
Outputs
readMe!
...
occTCP_Mtx
A python matrix containing the 'Themal Comfort Percent' (TCP) values for only the
occupied period of the model. Connect this to the 'Honeybee_Visualize Microclimate
Map' component in order to display the data. 'Occupied Thermal Comfort Percent'
(occTCP) is defined here as the the percent of occupied time where a point of space
meets or exceeds a given set of thermal comfort acceptability criteria. This is essentially
the same thing as the adaptComfMtx, PMVComfMtx, or outdoorComfMtx but with the
unoccupied hours discounted.
TA_Mtx
A python matrix containing the 'Thermal Autonomy' (TA) values for each of the faces of
the connected _viewFactorMesh. Connect this to the 'Honeybee_Visualize Microclimate
Map' component in order to display the data. 'Thermal Autonomy' (TA) is defined here
as the the percent of occupied time where a point of space meets or exceeds a given
set of thermal comfort acceptability criteria through passive means only.
OverHeatedMtx
A python matrix containing the overheated hours for each of the faces of the connected
_viewFactorMesh. Connect this to the 'Honeybee_Visualize Microclimate Map'
component in order to display the data. Overheated hours are essentially the number of
occupied hours that a point is warmer than that specified by a given set of thermal
comfort acceptability criteria.
UnderHeatedMtx
A python matrix containing the underheated hours for each of the faces of the
connected _viewFactorMesh. Connect this to the 'Honeybee_Visualize Microclimate
Map' component in order to display the data. Underheated hours are essentially the
number of occupied hours that a point is colder than that specified by a given set of
thermal comfort acceptability criteria.
occTCP_Result
A csv file address containing the 'Themal Comfort Percent' (TCP) values for only the
occupied period of the model.
Honeybee Primer
375Thermal_Autonomy_Analysis
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 376/510
TA_Result
A csv file address containing the 'Thermal Autonomy' (TA) values for each of the faces
of the connected _viewFactorMesh.
OverHeatedResult
A csv file address containing the overheated hours for each of the faces of the
connected _viewFactorMesh.
UnderHeatedResult
A csv file address containing the underheated hours for each of the faces of the
connected _viewFactorMesh.
Check Hydra Example Files for Thermal Autonomy Analysis
Honeybee Primer
376Thermal_Autonomy_Analysis
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 377/510
Visualize Microclimate Map
Use this component to produce a colored mesh from a comfResultsMtx. -
Inputs
comfResultsMtx [Required]
Any matrix output from the 'Honeybee_Microclimate Map Analysis' component, the
'Honeybee_Thermal Comfort Autonomy Analysis' component, or the 'Honeybee_Read
Microclimate Matrix' component.
Honeybee Primer
377Visualize_Microclimate_Map
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 378/510
viewFactorMesh [Required]
The list of view factor meshes that comes out of the 'Honeybee_Indoor View Factor
Calculator'. These will be colored with result data.
legendPar [Optional]
Optional legend parameters from the Ladybug Legend Parameters component.
runIt [Optional]
Set boolean to 'True' to run the component and visualize indoor comfort.
Outputs
readMe!
...
resultMesh
A list of colored meshes showing the results form the comfResultsMtx.
legend
A legend for the colored mesh. Connect this output to a grasshopper "Geo" componentin order to preview the legend spearately in the Rhino scene.
legendBasePt
The legend base point, which can be used to move the legend with the grasshopper
"move" component.
resultValues
The values of results that are being used to color the results.
resultColors
The colors used for each mesh face.
Check Hydra Example Files for Visualize Microclimate Map
Honeybee Primer
378Visualize_Microclimate_Map
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 379/510
Balance Temperature Calculator
Use this component to calculate a rough building (or zone) balance temperatrue from a
Honeybee energy simulation. The balance point is the outdoor temperature at which your
building is usually neither heating or cooling itself. If the outdoor temperture drops below the
balance temperature, your building will usually be heating itself and, if the outdoor
temperture is above the balance temperature, the building will usually be cooling itself.
The balance temperture concept is useful for setting things such as automated blinds
and airflow shcedules since having these things controlled by hourly cooling or heating
can often introduce odd behavior resulting from idiosyncrasies in the building's
schedule. This component works by taking the average combined heating/cooling
Honeybee Primer
379Balance_Temperature_Calculator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 380/510
values for each day and the average outdoor air temperature for each day. The days
with the smallest combined heating + cooling will have their daily mean outdoor air
tempertures averaged to produce the balance temperture. -
Inputs
zoneThermalEnergyBal [Required]
The output "thermalEnergyBalance" from the "Honeybee_Read EP Result" component.
This can be for a single zone if you select out one branch of this thermalEnergyBalance
output or it can be for the whole simulated building if you connect the whole output.
Note that, in order to use this component correclty, you must run either a simulation with
either an hourly or daily timestep.
outdoorAirTemp [Required]
The "dryBulbTemperature" output from the "Ladybug_Import epw" component.
numDaysToAverage [Optional]
An optional number of days with a low thermal energy load that will be averaged
together to yield the balance point. This is done to help avoid anomalies introduced by
variations between weekday and weekend shcedules. The default is set to 10 but you
may want to drop this down if there is little variation between weekday and weekendschedule or you might increase this number is there is a high variation.
Outputs
energyUsedOnBalDay
The amount of energy used on the balbnce day. This number should be close to 0 and
is mostly meant to give a sense of the accuracy of the temperature value below
balanceTemperature
The outdoor balance temperature of the connected zone or building data.
Check Hydra Example Files for Balance Temperature Calculator
Honeybee Primer
380Balance_Temperature_Calculator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 381/510
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. This can then be plugged into the "Ladybug_3D Chart" or "Ladybug_Monthly Bar
Chart" to give a visualization of the energy balance of the whole model. -
Inputs
HBZones [Required]
The HBZones out of any of the HB components that generate or alter zones. Note that
Honeybee Primer
381Construct_Energy_Balance
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 382/510
these should ideally be the zones that are fed into the Run Energy Simulation
component. Zones read back into Grasshopper from the Import idf component will not
align correctly with the EP Result data.
cooling [Optional]
The cooling load from the "Honeybee_Read EP Result" component.
heating [Optional]
The heating load from the "Honeybee_Read EP Result" component.
electricLight [Optional]
The electric lighting load from the "Honeybee_Read EP Result" component.
electricEquip [Optional]
The electric equipment load from the "Honeybee_Read EP Result" component.
peopleGains [Optional]
The people gains from the "Honeybee_Read EP Result" component.
totalSolarGain [Optional]
The total solar gain from the "Honeybee_Read EP Result" component.
infiltrationEnergy [Optional]
The infiltration heat loss (negative) or heat gain (positive) from the "Honeybee_Read EP
Result" component.
outdoorAirEnergy [Optional]
The outdoor air heat loss (negative) or heat gain (positive) from the "Honeybee_ReadEP Result" component.
natVentEnergy [Optional]
The natural ventilation heat loss (negative) or heat gain (positive) from the
"Honeybee_Read EP Result" component.
surfaceEnergyFlow [Optional]
The surface heat loss (negative) or heat gain (positive) from the "Honeybee_Read EP
Surface Result" component.
Honeybee Primer
382Construct_Energy_Balance
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 383/510
Outputs
readMe!
...
flrNormEnergyBal
A data tree with the important building-wide energy balance terms normalized by floor
area. This can then be plugged into the "Ladybug_3D Chart" or "Ladybug_Monthly Bar
Chart" to give a visualization of the energy balance of the whole model.
flrNormBalWStorage
A data tree with the important building-wide energy balance terms normalized by floor
area plus an additional term to represent the energy being stored in the building's mass.If you have input all of the terms of your energy balance to this component, you storage
term should be very small in relation to the other energy balance terms. Thus, this
storage term can be a good way to check whether all of your energy balance terms are
accounted for. This output can then be plugged into the "Ladybug_3D Chart" or
"Ladybug_Monthly Bar Chart" to give a visualization of the energy balance of the whole
model.
modelEnergyBalance
A data tree with the important building-wide energy balance terms. This can then be
plugged into the "Ladybug_3D Chart" or "Ladybug_Monthly Bar Chart" to give a
visualization of the energy balance of the whole model.
energyBalWithStorage
A data tree with the important building-wide energy balance terms plus an additional
term to represent the energy being stored in the building's mass. If you have input all of
the terms of your energy balance to this component, you storage term should be very
small in relation to the other energy balance terms. Thus, this storage term can be a
good way to check whether all of your energy balance terms are accounted for. This
output can then be plugged into the "Ladybug_3D Chart" or "Ladybug_Monthly Bar
Chart" to give a visualization of the energy balance of the whole model.
Check Hydra Example Files for Construct Energy Balance
Honeybee Primer
383Construct_Energy_Balance
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 384/510
Energy Simulation Par
EnergyPlus Shadow Parameters -
Inputs
timestep [Optional]
A number between 1 and 60 that represents the number of timesteps per hour at which
the simulation will be run. The default is set to 6 timesteps per hour, which means that
the energy balance calculation is run every 10 minutes of the year.
Honeybee Primer
384Energy_Simulation_Par
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 385/510
shadowCalcPar [Optional]
An optional set of shadow calculation parameters from the "Honeybee_ShadowPar"
component.
solarDistribution [Optional]
An optional text string or integer that sets the solar distribution calculation. Choose from
the following options: 0 = "MinimalShadowing" - In this case, exterior shadowing is only
computed for windows and not for other opaque surfaces that might have their surface
temperature affected by the sun. All beam solar radiation entering the zone is assumed
to fall on the floor. A simple window view factor calculation will be used to distribute
incoming diffuse solar energy between interior surfaces. 1 = "FullExterior" - The
simulation will perform the solar calculation in a manner that only accounts for direct sun
and whether it is blocked by surrounding context geometry. For the inside of thebuilding, all beam solar radiation entering the zone is assumed to fall on the floor. A
simple window view factor calculation will be used to distribute incoming diffuse solar
energy between interior surfaces. 2 = "FullInteriorAndExterior" - The simulation will
perform the solar calculation in a manner that models the direct sun (and wheter it is
blocked by outdoor context goemetry. It will also ray trace the direct sun on the interior
of zones to distribute it correctly between interior surfaces. Any indirect sun or sun
bouncing off of objects will not be modled. 3 = "FullExteriorWithReflections" - The
simulation will perform the solar calculation in a manner that accounts for both direct
sun and the light bouncing off outdoor surrounding context. For the inside of the
building, all beam solar radiation entering the zone is assumed to fall on the floor. A
simple window view factor calculation will be used to distribute incoming diffuse solar
energy between interior surfaces. 4 = "FullInteriorAndExteriorWithReflections" - The
simulation will perform the solar calculation in a manner that accounts for light bounces
that happen both outside and inside the zones. This is the most accurate method and is
the one assigned by default. Note that, if you use this method, EnergyPlus will give
Severe warnings if your zones have concave geometry (or are "L"-shaped). Such
geometries mess up this solar distribution calculation and it is recommeded that you
either break up your zones in this case or not use this solar distribution method.
simulationControls [Optional]
An optional set of simulation controls from the "Honeybee_Simulation Control"
component.
ddyFile [Optional]
An optional file path to a .ddy file on your system. This ddy file will be used to size the
HVAC system before running the simulation.
Honeybee Primer
385Energy_Simulation_Par
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 386/510
terrain [Optional]
An optional integer or text string to set the surrouning terrain of the building, which will
be used to determine how wind speed around the building changes with height. If no
value is input here, the default is set to "City." Choose from the following options: 0 =
City: large city centres, 50% of buildings above 21m over a distance of at least 2000mupwind. 1 = Suburbs: suburbs, wooded areas. 2 = Country: open, with scattered objects
generally less than 10m high. 3 = Ocean: Flat, unobstructed areas exposed to wind
flowing over a large water body (no more than 500m inland).
monthlyGrndTemps [Optional]
An optional list of 12 monthly ground temperatures to be used by those surfaces in
contact with the ground in the simulation. Please note that the EPW values out of the
Import Ground Temp component are usually too extreme for a conditioned building. If novalues are input here, the model will attempt to estimate a reasonable starting base
temperature from these results by using a value of 18C in cases of monthly ground
temperatures below 18C, 24C in cases of monthly ground temperatures above 24C,
and the actual ground temperature if the monthly average falls in between 18C and
24C. Usually, ground temperatures will be about 2C lower than the overage indoor air
temperature for a given month.
Outputs
energySimPar
Energy simulation parameters that can be plugged into the "Honeybee_ Run Energy
Simulation" component.
Check Hydra Example Files for Energy Simulation Par
Honeybee Primer
386Energy_Simulation_Par
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 387/510
Make Adiabatic
Make Adiabatic -
Inputs
HBSrfs [Optional]
A list of valid Honeybee surfaces
Outputs
Honeybee Primer
387Make_Adiabatic
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 388/510
HBSrfs
Modified list of Honeybee surfaces with
Check Hydra Example Files for Make Adiabatic
Honeybee Primer
388Make_Adiabatic
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 389/510
Re-run IDF
This is a component for running a previoulsy-generated .idf file through EnergyPlus with a
different weather file. -
Inputs
workingDir [Required]
The working directory of the energyPlus idf.
idfFileName [Required]
Honeybee Primer
389Re-run_IDF
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 390/510
Name of the idf file (e.g. sample1.idf).
epwFileAddress [Required]
Address to epw weather file.
EPDirectory [Required]
[Optional] where EnergyPlus is installed on your system
writeIt [Required]
Set to true to create the new folder with batch file
runIt [Optional]
Set to 'True' to run the simulation.
Outputs
report
Report!
batchFileAddress
Script variable Re-Run IDF
resultFileAddress
The address of the EnergyPlus result file.
Check Hydra Example Files for Re-run IDF
Honeybee Primer
390Re-run_IDF
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 391/510
Read EP HVAC Result
This component reads the results of an EnergyPlus simulation from the WriteIDF
Component or any EnergyPlus result .csv file address. Note that, if you use this component
without the WriteIDF component, you should make sure that a corresponding .eio file is next
to your .csv file at the input address that you specify. _ This component reads only the
results related to zone ideal air and earth tube HVAC systems. For other results related to
zones, you should use the "Honeybee_Read EP Result" component and, for results related
to surfaces, you should use the "Honeybee_Read EP Surface Result" component. -
Inputs
Honeybee Primer
391Read_EP_HVAC_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 392/510
resultFileAddress [Required]
The result file address that comes out of the WriteIDF component.
normByFloorArea [Optional]
Set to 'True' to normalize all zone energy data by floor area (note that the resulting units
will be kWh/m2 as EnergyPlus runs in the metric system). The default is set to "False."
Outputs
sensibleCooling
The sensible energy removed by the ideal air cooling load for each zone in kWh.
latentCooling
The latent energy removed by the ideal air cooling load for each zone in kWh.
sensibleHeating
The sensible energy added by the ideal air heating load for each zone in kWh.
latentHeating
The latent energy added by the ideal air heating load for each zone in kWh.
supplyVolFlow
The mass of supply air flowing into each zone in kg/s.
supplyAirTemp
The mean air temperature of the supply air for each zone (degrees Celcius).
supplyAirHumidity
The relative humidity of the supply air for each zone (%).
earthTubeCooling
The sensible energy removed by an earth tube system for each zone in kWh.
earthTubeHeating
The sensible energy added by an earth tube system for each zone in kWh.
Check Hydra Example Files for Read EP HVAC Result
Honeybee Primer
392Read_EP_HVAC_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 393/510
ShadowPar
EnergyPlus Shadow Parameters -
Inputs
calculationMethod [Optional]
An optional text string to set the means by which the shadow calculation is run. Choose
from the following two options: 1 - AverageOverDaysInFrequency - A shadow
calculation that averages over multiple days (as opposed to running it for each
timeStep). This is the default setting. 2 - TimestepFrequency - A shadow calculation that
Honeybee Primer
393ShadowPar
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 394/510
computes the incoming solar energy at every single timestep of the simulation. Note
that this option is only needed for certain cases and can increase execution time
significantly.
frequency [Optional]
An optional number that represents the frequency in days with which shadows are re-
computed in the AverageOverDaysInFrequency calculation method. The default is set
to 30 days (meaning that the shadow calulation is performed every 30 days and this
average over this period is used to represent all 30 days in the energy simulation).
maximumFigure [Optional]
An optional number that is greater than 200, which represents the maximum number of
points to be used in the shadow calculation. The default is set to 3000 points but this
may need to be increased significantly if you have a lot of small context geometry in
your model.
Outputs
shadowPar
Shadow calculation parameters that can be plugged into the "Honeybee_Energy
Simulation Par" component.
Check Hydra Example Files for ShadowPar
Honeybee Primer
394ShadowPar
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 395/510
Simulation Control
Use this component to set EnergyPlus Simulation Controls such as whether to run certain
types of HVAC sizing calculations, etc. -
Inputs
doZoneSizingCalculation [Optional]
Set to "True" to have EnergyPlus do a sizing calculation for the zones. The default is set
to "True."
Honeybee Primer
395Simulation_Control
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 396/510
doSystemSizingCalculation [Optional]
Set to "True" to have EnergyPlus do a sizing calculation for the HVAC system. The
default is set to "True."
doPlantSizingCalculation [Optional]
Set to "True" to have EnergyPlus do a sizing calculation for the HVAC plant (boiler and
chiller). The default is set to "True", although with ideal air loads, there is no plant as
each zone has its own ideal air system and there is no central plant between zones.
runSimForSizingPeriods [Optional]
Set to "True" to have EnergyPlus run a simulation for the Sizing periods specified in the
IDF. The default is set to "False." By default, the sizing periods are set to the extreme
hot and extreme cold weeks of the weather file but a custom ddy file can also be
specified with the "Honeybee_Energy Simulation Par" component.
runSimForRunPeriods [Optional]
Set to "True" to have EnergyPlus run the simulation for energy use over the entire year
of the EPW. The default is set to "True."
maxWarmupDays [Optional]
The minimum number of warmup days that you want the energyplus simulation to run
before recording result values. The default is set to 6.
minWarmupDays [Optional]
Script variable simControl
Outputs
simControls
A set of simulation controls tha can be plugged into the "Honeybee_Energy Simulation
Par" component.
Check Hydra Example Files for Simulation Control
Honeybee Primer
396Simulation_Control
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 397/510
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. -
Inputs
srfData [Required]
Any surface data out of the "Honeybee_Read EP Surface Result" component.
Outputs
Honeybee Primer
397Surface_Data_Based_On_Type
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 398/510
walls
A list of walls as breps.
windows
A list of windows as breps.
roofs
A list of roofs as breps.
floors
A list of floors as breps.
Check Hydra Example Files for Surface Data Based On Type
Honeybee Primer
398Surface_Data_Based_On_Type
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 399/510
Component list:
OpenStudio_Air_Handler_Detail
OpenStudio_Airside_Economizer_Detail OpenStudio_DX_Cooling_Coil
OpenStudio_DX_Heating_Coil
OpenStudio_Evaporative_Condenser
OpenStudio_Fan_Detail
OpenStudio_Mechanical_Controller
OpenStudio_Availability_Manager_List
Honeybee Primer
39910 | Energy | AirsideSystems
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 400/510
OpenStudio Air Handler Detail
OpenStudio Systems -
Inputs
HVACSystemID [Required]
... use of the integers representing a system, as found in openStudioHVACSystemsList
availabilitySch [Default]
... a Honeybee or OpenStudio schedule reference.
Honeybee Primer
400OpenStudio_Air_Handler_Detail
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 401/510
fanPlacement [Default]
... BlowThrough or DrawThrough.
coolingCoil [Default]
... Provide a definition fo a cooling coil (from the Honeybee component for cooling coils).
This component currently accepts one and two speed DX coil
heatingCoil [Default]
... Provide a definition fo a heating coil (from the Honeybee component for heating
coils). This component currently does not accept heating coils
fanDetail [Default]
... Provide a definition for a fan serving your air handler(s) . This component current
accepts constant volume fans that ride the fan curve, or a VFD fan
airsideEconomizer [Default]
... Provide a definition of 5an airside economizer (from the Honeybee component with
the same name.
availabilityManagerList [Default]
...Provide the output of an availability manager list component to override OpenStudio
default behavior. Do nothing and the fan system never shuts off, which is not really
desired behavior.
Outputs
readMe!
The execution information, as output and error streams
airHandlerDetail
Script variable Python
Check Hydra Example Files for OpenStudio Air Handler Detail
Honeybee Primer
401OpenStudio_Air_Handler_Detail
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 402/510
OpenStudio Airside Economizer Detail
Airside Economizer -
Inputs
uniqueName [Required]
a required field to uniquely name the economizer
economizerControlType [Default]
... requires an integer specifying the type of economizer
Honeybee Primer
402OpenStudio_Airside_Economizer_Detail
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 403/510
0:FixedDryBulb(default),1:DifferentialDryBulb,2:FixedEnthalpy,3:DifferentialEnthalpy,4:E
lectronicEnthalpy,5:FixedDewPointAndDryBulb,6:DifferentialDryBulbAndEnthalpy,7:NoE
conomizer
controlAction [Default]
... Requires an integer. See ecdict for different values to supply. Supply nothing and it
defaults to "ModulateFlow"
maximumAirFlowRate [Default]
... supply nothing and it will Autosize (recommended)
minimumAirFlowRate [Default]
... do nothing and it will Autosize (recommended)
minimumLimitType [Default]
... do nothing and it defaults to Proportional Minimum (min depends on the supply air
flow rate as opposed to an absolute number)
minimumOutdoorAirSchedule [Default]
... This is a schedule with values between 0 and 1, and it is multiplied by the
minimumAirFlowRate. It is usually left blank, but can be used to fine tune the
economizer during warm-up time or after hours.
minimumOutdoorAirFracSchedule [Default]
... this overrides minOutdoorAirSchedule and minAirflowRate. It is a schedule between
0 and 1. It is often used to create a 100% outside air system.
maximumOutdoorAirFracSchedule [Default]
... this is a schedule between 0 and 1. It is often used to create a recirculating outside
air system such as that in patient rooms.
maximumLimitDewpoint [Default]
... needed for when the ControlType is Fixed Dewpoint and Dry Bulb. Otherwise leave
blank
sensedMinimum [Default]
... is the minimum of whatever the control type, at this point the system goes to
minimum flow
Honeybee Primer
403OpenStudio_Airside_Economizer_Detail
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 404/510
sensedMaximum [Default]
... is the maximum of whatever the control type, at this point the system goes to
minimum flow
economizerLockoutMethod [Default]
... should only used when the HVAC system is packaged DX
timeOfDaySchedule [Default]
this field is only used when the outdoor flow rate is based on a schedule. It is rare for a
normal economizer to have this value set. If so, apply the name of a schedule.
mechVentController [Default]
an optional field, though highly recommended. Open Studio provides default behavoir
for this controller.
availabilityManagerList [Default]
allows you to toggle between different AvailabilityManagers. Right now, we simply allow
you to create a list that has only one AvailabilityManager, and the type of manager can
be ScheduledOrNightCycle
Outputs
readMe!
The execution information, as output and error streams
airsideEconomizer
An airside economizer detail that can be plugged into the "Honeybee_Air Handling Unit
Detail" component.
Check Hydra Example Files for OpenStudio Airside Economizer Detail
Honeybee Primer
404OpenStudio_Airside_Economizer_Detail
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 405/510
OpenStudio DX Cooling Coil
EPlus DX Coil -
Inputs
dxCoilSpeed [Required]
...0 = 1 speed, 1 = 2 speed
name [Required]
...provide a unique coil for each one that you use
Honeybee Primer
405OpenStudio_DX_Cooling_Coil
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 406/510
availabilitySchedule [Default]
... an OpenStudio or Honeybee can be plugged in here to limit the availability of the
cooling coil.
ratedHighSpeedAirflowRate [Default]
Script variable 2SpeedDXCoil
ratedHighSpeedTotalCooling [Default]
...This value is typically blank, it can be autosized (the Units are in Watts)/
ratedHighSpeedSensibleHeatRatio [Default]
... This value is typically blank. Its value must be between 0 and 1.
ratedHighSpeedCOP [Default]
... the efficiency at design conditions for the DX coil ratedLowSpeedTotalCooling ... This
value is typically blank, it can be autosized (the Units are in Watts)/
ratedLowSpeedSensibleHeatRatio ...This value is typically blank. Its value must be
between 0 and 1. ratedLowSpeedCOP ... the efficiency at design conditions for the DX
coil _condenserType ... 0 = air cooled (default), 1 is evaporatively cooled
_evaporativeCondenserDescription ... if the condenserType is evaporative cooled,
provide a description of the evap unit. This can be imported from the Honeybee
component for evaporative condensers. Curves ... Not yet implemented. Allows you to
specify custom part load curves for DX coils. unitInternalStaticPressure ... (units are
Pascals). This item is rarely used, but helps to calculate EER and IEER for variable
speed DX systems. Refers to the total internal pressure of the air handler.
ratedLowSpeedAirflowRate [Default]
Script variable 2SpeedDXCoil
ratedLowSpeedTotalCooling [Default]
Script variable Python
ratedLowSpeedSensibleHeatRatio [Default]
Script variable Python
ratedLowSpeedCOP [Default]
Script variable Python
Honeybee Primer
406OpenStudio_DX_Cooling_Coil
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 407/510
condenserType [Default]
Script variable Python
evaporativeCondenserDescription [Default]
Script variable Python
Curves [Default]
Script variable Python
unitInternalStaticPressure [Default]
Script variable 2SpeedDXCoil
Outputs
out
The execution information, as output and error streams
DXCoil
...return DX coil definition
Check Hydra Example Files for OpenStudio DX Cooling Coil
Honeybee Primer
407OpenStudio_DX_Cooling_Coil
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 408/510
OpenStudio DX Heating Coil
EPlus DX Heating Coil -
Inputs
dxCoilSpeed [Required]
...0 = 1 speed, 1 = 2 speed
name [Required]
...provide a unique coil for each one that you use
Honeybee Primer
408OpenStudio_DX_Heating_Coil
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 409/510
availabilitySchedule [Default]
... an OpenStudio or Honeybee can be plugged in here to limit the availability of the
cooling coil.
ratedHighSpeedAirflowRate [Default]
Script variable 2SpeedDXCoil
ratedHighSpeedTotalHeating [Default]
...This value is typically blank, it can be autosized (the Units are in Watts)/
ratedHighSpeedCOP [Default]
... the efficiency at design conditions for the DX coil
ratedLowSpeedAirflowRate [Default]
Script variable 2SpeedDXCoil
ratedLowSpeedTotalHeating [Default]
... This value is typically blank, it can be autosized (the Units are in Watts)/
ratedLowSpeedCOP [Default]
... the efficiency at design conditions for the DX coil
minimumOutdoorDryBulb [Default]
... If left blank, the default is -8C (17.6F) temperature when the compressor is shut off
outdoorDryBulbDefrostDisabled [Default]
... If left blank, the default is 5C (41F). It is the temperature, below which, defrost is
enabled to de-ice the heat source.
maxOutdoorDryBulbForCrankcase [Default]
... If left blank, the default is 10C (50F). It is the temperature above which the
compressor crankcase heater is disabled.
crankCaseHeaterCapacity [Default]
... If left blank, the default is zero. It is the capacity of the compressor crankcase heater
(Watts), which will turn on if below the stated temperature and the compressor is not
running.
Honeybee Primer
409OpenStudio_DX_Heating_Coil
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 410/510
defrostStrategy [Default]
... If left blank, the default is 'ReverseCycle'. Two options for this 'ReverseCycle',
'Resistive'. Spelling must be correct. It is the type of heating cycle used to melt frost
accumulated on the outdoor coil.
defrostControl [Default]
... If left blank, the default is 'timed'. Two options are 'timed' and 'on-demand'.
resistiveDefrostHeatCap [Default]
If left blank, the default in honeybee is zero. It is the capacity in Watts of the resistive
element used for defrost. Curves ... Not yet implemented. Allows you to specify custom
part load curves for DX coils. unitInternalStaticPressure ... (units are Pascals). This item
is rarely used, but helps to calculate EER and IEER for variable speed DX systems.
Refers to the total internal pressure of the air handler.
Curves [Default]
Script variable Python
Outputs
readMe
The execution information, as output and error streams
DXCoil
...return DX coil definition
Check Hydra Example Files for OpenStudio DX Heating Coil
Honeybee Primer
410OpenStudio_DX_Heating_Coil
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 411/510
OpenStudio Evaporative Condenser
Evaporative Condenser -
Inputs
uniqueName [Required]
... a required field to uniquely name the evaporative condenser
serviceType [Required]
... what does the evaporator serve: 0=single speed DX, 1=two speed DX, 2=VRF, or
Honeybee Primer
411OpenStudio_Evaporative_Condenser
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 412/510
3=commercial refrigeration system
hiSpeedEvaporativeEffectiveness [Default]
... Used for both one stage and two stage condensers, supply no information and the
value defaults to 0.9
hiSpeedEvaporativeCondAirflowRate [Default]
Script variable EvaporativeCondenser
hiSpeedEvapPumpPower [Default]
... Used for both one stage and two stage condensers, power in Watts is autosized by
default 0.004266 Watts/Watt cooling or 15 W/ton cooling
loSpeedEvaporativeEffectiveness [Default]
... only needed for two speed condenser, supply no information and the value defaults to
0.9
loSpeedEvaporativeCondAirflowRate [Default]
Script variable EvaporativeCondenser
loSpeedEvapPumpPower [Default]
... only needed for two-speed condenser, power in Watts is autosized by default
0.004266 Watts/Watt cooling or 15 W/ton cooling
storageTank [Default]
the description of a storage tank used to hold the evaporative condenser water, if any
Curves [Default]
this feature has not been implemented yet.
Outputs
out
The execution information, as output and error streams
evapCondenserDefinition
...description of an evaporative condenser returned for users.
Honeybee Primer
412OpenStudio_Evaporative_Condenser
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 413/510
Check Hydra Example Files for OpenStudio Evaporative Condenser
Honeybee Primer
413OpenStudio_Evaporative_Condenser
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 414/510
OpenStudio Fan Detail
Energy Plus Fan Definition -
Inputs
fanType [Required]
... 0 = Constant Volume, 1 = Variable Volume
fanName [Required]
... Provide a Unique name for the fan
Honeybee Primer
414OpenStudio_Fan_Detail
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 415/510
fanEfficiency [Default]
... the fan blade mechanical efficiency, value must be between 0 and 1
pressureRise [Default]
... total static pressure of the fan, Pascals
maxFlowRate [Default]
... the peak flow rate of the fan, if left blank, this value autosizes
motorEfficiency [Default]
... the motor efficiency of the fan, value must be between 0 and 1
motorPctInAirstream [Default]
... percent of heat liberated by fan to the airstream, default is 100 percent
minFanFlowFraction [Default]
... the minimum airflow fraction of the fan, value must be between 0 and 1
fanPowerCoeff1 [Default]
... power curve coefficiencts for Variable Volume Fans
fanPowerCoeff2 [Default]
... power curve coefficiencts for Variable Volume Fans
fanPowerCoeff3 [Default]
... power curve coefficiencts for Variable Volume Fans
fanPowerCoeff4 [Default]
... power curve coefficiencts for Variable Volume Fans
fanPowerCoeff5 [Default]
... power curve coefficiencts for Variable Volume Fans
Outputs
fanDefinition
Honeybee Primer
415OpenStudio_Fan_Detail
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 416/510
... updated fan definition returned by this component
fanParameters
Script variable ConstantVolumeFan
Check Hydra Example Files for OpenStudio Fan Detail
Honeybee Primer
416OpenStudio_Fan_Detail
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 417/510
OpenStudio Mechanical Controller
Mechanical Ventilation Controller This is an optional field that overrides the economizer
behavior It adds DCV if you want it as well. It can also be tricked into providing a mini purge
cycle too if you want it. -
Inputs
uniqueName [Required]
a required field to uniquely name the economizer
Honeybee Primer
417OpenStudio_Mechanical_Controller
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 418/510
availabilitySch [Required]
provide the name (string) of a Honeybee schedule that is valid. Supply nothing, and
outside air will be delivered always, which is probably not what you want.
DCV [Default]
provide a toggle here. 1 means you want DCV, 0 means you don't. The default is zero.
Outputs
readMe
The execution information, as output and error streams
MechanicalVentController
...returns a controller that can be added to the Airside Economizer Definition
Check Hydra Example Files for OpenStudio Mechanical Controller
Honeybee Primer
418OpenStudio_Mechanical_Controller
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 419/510
OpenStudio Availability Manager List
AvailabilityManagerList -
Inputs
name [Required]
... provide a unique name for this manager list (required)
type [Required]
... there are two options currently available for AvailabilityManager types, 0 = Scheduled
Honeybee Primer
419OpenStudio_Availability_Manager_List
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 420/510
and 1 = NightCycle. (required)
scheduleName [Required]
... both types of AvailabilityManager require a schedule. Just provide a schedule name
available from Honeybee. This schedule will determine whether the manager is
available for control. By default, if left blank (recommended) the schedule will be Always
On (always available). This is what most people want.
controlType [Default]
... an optional field for NightCycle type AvailabilityManagers only. It will be ignored for
type Scheduled. There are two options 0: StayOff and 1:CycleOnAny (the default). If left
blank, it will default (this is usually what is preferred, so leave it blank if you are not
sure)
Outputs
readMe!
The execution information, as output and error streams
availabilityManagerList
...returns an object that will modify the availability manager
Check Hydra Example Files for OpenStudio Availability Manager List
Honeybee Primer
420OpenStudio_Availability_Manager_List
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 421/510
Component list:
Update_Honeybee
Honeybee Primer
42111 | Developers
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 422/510
Update Honeybee
This component [removes | updates] Honeybee components from [grasshopper | a source
folder] -
Inputs
sourceDirectory [Optional]
Optional address to a folder that contains Honeybee updated userObjects. If None the
component will download the latest version from GitHUB.
Honeybee Primer
422Update_Honeybee
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 423/510
updateThisFile [Required]
Set to True if you want the Honeybee components in this file be updated from the
source directory
updateAllUObjects [Required]
Set to True to sync all the Ladybug and Honeybee userObjects
Outputs
readMe!
...
Check Hydra Example Files for Update Honeybee
Honeybee Primer
423Update_Honeybee
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 424/510
Component list:
Apply_OpenStudio_Measure
Convert_IMG Create _Pollinator
Customize_EnergyPlus_Objects
ExportEPC
Extrude_Windows
GrizzlyBear
Import _IES
Load_OpenStudio_Measure
open_ Pollination
Get_Annual_SQL_Data
OpenStudio_Centr al_Plant_Orchestrator
OpenStudio_Cooling_Tower
OpenStudio_EIR_Chiller
OpenStudio_Hot_Water_Boiler
FileExplorer
Gener ator_PV
Gener ator_Wind _Horizontialaxis
generationsystem
simple_Inverter
Create_Therm_Boundaries
Create_Therm_Polygons Import_THERM_XML
Read_THERM_Result
Therm_Material
Therm_Material_to_EnergyPlus_Material
Write_THERM_File
Mirror_Honeybee
Move_Honeybee
Rotate_Honeybee
Honeybee Primer
42412 | WIP
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 425/510
IES_Custom_Lamp
IES_Luminaire
IES_Luminaire_Zone
Read_generation_system_results
Visualise_Honeybeegeneration_cashflow
Honeybee Primer
42512 | WIP
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 426/510
Apply OpenStudio Measure
This component applies an OpenStudio measure to an OpenStudio file. The component will
eventually be integrated to Export to OpenStudio component. Read more about OpenStudio
measures here: http://nrel.github.io/OpenStudio-user-
documentation/reference/measure_writing_guide/ You can download several measures from
here: https://bcl.nrel.gov/nrel/types/measure Many thanks to NREL team for their support
during the process. See (https://github.com/mostaphaRoudsari/Honeybee/issues/214) and
(https://github.com/mostaphaRoudsari/Honeybee/issues/290)for just two examples! -
Inputs
Honeybee Primer
426 Apply_OpenStudio_Measure
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 427/510
osmFilePath [Required]
A file path of the an OpemStdio file
epwWeatherFile [Required]
An .epw file path on your system as a text string.
OSMeasure [Required]
Loaded OpenStudio measure. Use load OpenStudio measures to load the measure to
Honeybee
runIt [Required]
set to True to apply the measure and run the analysis
Outputs
ReadMe!
The execution information, as output and error streams
projectFolder
Path to new project folder
modifiedIdfFilePath
Path to modified EnergyPlus file
modifiedOsmFilePath
Path to modified OpenStudio file
resultsFileAddress
Path to .csv results file
Check Hydra Example Files for Apply OpenStudio Measure
Honeybee Primer
427 Apply_OpenStudio_Measure
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 428/510
Convert IMG
Convert Image -
Inputs
imageFilePath [Required]
Path to an image file(BMP, GIF, JPEG, PNG, TIFF)
targetImageType [Default]
0>"BMP", 1>"GIF", 2>"Jpeg", 3>"PNG", 4>"TIFF"
Honeybee Primer
428Convert_IMG
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 429/510
Outputs
convertedFilePath
New file path
Check Hydra Example Files for Convert IMG
Honeybee Primer
429Convert_IMG
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 430/510
Create Pollinator
Craet Pollinator (Put parametric results together) -
Inputs
parameters [Required]
Input and output parameters in separate branches
values [Required]
List of values for each input or output parameter
Honeybee Primer
430Create_Pollinator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 431/510
workingDir [Default]
Optional workingDir
fileName [Default]
Optional filename
Outputs
pollinator
.csv file that can be loaded and visualized in Pollination. Use OpenPollination to open
pollination web page.
Check Hydra Example Files for Create Pollinator
Honeybee Primer
431Create_Pollinator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 432/510
Customize EnergyPlus Objects
Customize EnergyPlus Objects [NOT READY YET!] -
Inputs
EPObjectName [Required]
Script variable Python
indexes [Optional]
Script variable Python
Honeybee Primer
432Customize_EnergyPlus_Objects
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 433/510
values [Optional]
Script variable Python
Outputs
originalObj
Script variable Python
modifiedObj
Script variable Python
Check Hydra Example Files for Customize EnergyPlus Objects
Honeybee Primer
433Customize_EnergyPlus_Objects
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 434/510
ExportEPC
Export to Energy Performace Calculator (EPC) ... Add more description here -
Inputs
HBZones [Required]
Honeybee Zones
Outputs
Honeybee Primer
434ExportEPC
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 435/510
readMe!
The execution information, as output and error streams
Check Hydra Example Files for ExportEPC
Honeybee Primer
435ExportEPC
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 436/510
Extrude Windows
Extrude pseudo walls from window polygons. This component has only been tested with
rectangular windows. -
Inputs
glazings [Required]
Any number of glazing polygons.
thickness [Required]
Honeybee Primer
436Extrude_Windows
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 437/510
Thickness of the window. Can be a single number or a list of numbers. If its a list then
the list should be equal to the number of glazings.
Outputs
readMe!
The execution information, as output and error streams
windowExtrusions
Geometric representations of glazing walls.
Check Hydra Example Files for Extrude Windows
Honeybee Primer
437Extrude_Windows
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 438/510
GrizzlyBear
Grizzlybear exports Honeybee zones to gbXML file -
Inputs
location [Required]
Script variable _location
zipCode [Optional]
Script variable zipCode_
Honeybee Primer
438GrizzlyBear
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 439/510
HBZones [Required]
Input your honeybee zones
HBContext [Optional]
Script variable HBContext_
meshSettings [Optional]
Custom mesh setting. Use Grasshopper mesh setting components
writegbXML [Required]
Set to true to create gbxml
workingDir []
C:\gbXML by default
fileName []
choose a filename, no need to add the xml extension.
Outputs
readMe!
...
resultFileAddress
...
Check Hydra Example Files for GrizzlyBear
Honeybee Primer
439GrizzlyBear
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 440/510
Import IES
Import IES files -
Inputs
iesFilePath [Required]
Filepath to a valid IES file
newName [Optional]
Optional new name for the ies file
Honeybee Primer
440Import_IES
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 441/510
modifier [Optional]
Optional number between 0 and 1 which will be "multiplied by "all output quantities. This
is the best way to scale fixture brightness for different lamps, but care should be taken
when this option is applied to multiple files."
runIt [Required]
Set to True to import the IES file
Outputs
HB_IES
HB IES object. Do not scale or rotate this object. Just locate it in the right place
Check Hydra Example Files for Import IES
Honeybee Primer
441Import_IES
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 442/510
Load OpenStudio Measure
This component loads OpenStudio measureds into Honeybee. The measure can be applied
to an OpenStudio model. Read more about OpenStudio measures here:
http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/ You
can download several measures from here: https://bcl.nrel.gov/nrel/types/measure -
Inputs
OSMeasure [Required]
Path to measure directory [NOT THE FILE]. This input will be removed once measure is
Honeybee Primer
442Load_OpenStudio_Measure
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 443/510
loaded
Outputs
readMe!
The execution information, as output and error streams
OSMeasure
Loaded OpenStudio measure
Check Hydra Example Files for Load OpenStudio Measure
Honeybee Primer
443Load_OpenStudio_Measure
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 444/510
open Pollination
Use this component to open the Pollination page -
Inputs
open [Required]
Script variable Python
Outputs
Honeybee Primer
444open_Pollination
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 445/510
readMe!
The execution information, as output and error streams
Check Hydra Example Files for open Pollination
Honeybee Primer
445open_Pollination
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 446/510
Get Annual SQL Data
Export Honeybee Objects to OpenStudio -
Inputs
sqlFilePath [Required]
Script variable Python
Outputs
Honeybee Primer
446Get_Annual_SQL_Data
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 447/510
allAnnualTotals
Script variable getAnnualSQLData
annualElectricity
Script variable Python
annualNaturalGas
Script variable analyzeSQL
annualWater
Script variable getAnnualSQLData
Check Hydra Example Files for Get Annual SQL Data
Honeybee Primer
447Get_Annual_SQL_Data
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 448/510
OpenStudio Central Plant Orchestrator
EPlus Plantside Organizer -
Inputs
HVACSystemID [Required]
Script variable EPlusCentralPlant
Boiler [Default]
Script variable Python
Honeybee Primer
448OpenStudio_Central_Plant_Orchestrator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 449/510
Chiller [Default]
Script variable Python
CoolingTower [Default]
Script variable EPlusCentralPlant
Outputs
out
The execution information, as output and error streams
plantDetails
Script variable Python
Check Hydra Example Files for OpenStudio Central Plant Orchestrator
Honeybee Primer
449OpenStudio_Central_Plant_Orchestrator
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 450/510
OpenStudio Cooling Tower
EPlus Cooling Tower -
Inputs
name [Required]
Script variable Python
speedControl [Default]
an integer that defines the speed control of the cooling tower 1:1-speed, 2:2-speed
Honeybee Primer
450OpenStudio_Cooling_Tower
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 451/510
(default if left blank), 3:variable speed
inputMethod [Default]
an integer that defines how the cooling Tower performance is entered.
0:UFactorTimesAreaAndDesignWaterFlowRate (honeybee default if left blank) ,
1:NominalCapacity
modelType [Default]
used only for Variable Speed towers, an input that defines the empirical model used for
the cooling tower. Provide an integer for 0:"CoolToolsCrossFlow" (default if left blank) or
1:"YorkCalc"
designWB [Default]
used only for Variable Speed towers, an input in deg Celsius, that indicates the outdoor
wet bulb at design conditions. If left blank, the default is 25.5556 degrees Celsius (78
degrees Fahrenheit). Minimum is 20 degrees C
designRange [Default]
used only for Variable Speed towers, an input in deg Celsius, that indicates the
difference in temperature between the water entering and leaving the tower. If left blank,
the default is 5.5556 degrees Celsius (10 degrees Celsius). Must be greater than 0.
designApproach [Default]
used only for Variable Speed towers, an input in deg Celsius, that indicates how close
the leaving water temperature comes to the outdoor dry bulb (it will always be greater
than the outdoor dry bulb). If left blank, the default is 3.8889 degrees Celsius (7 degrees
Fahrenheit). Must be greater than o
sizingFactor [Default]
an optional field that allows a user to specify a sizing factor for the peak load when all
components are autosized. The default if left blank is 1.15 (recommended). Variables
affected by the sizing factor can be found in the EnergyPlus documentation.
nominalCapacity [Required]
the nominal capacity at highest speed (in Watts) of the cooling tower assuming 95-85F
leaving/entering water temperature, air at 78F WB, 95F DB, with design water flow rate
at 3 GPM/ton. If left blank, it autosizes
Honeybee Primer
451OpenStudio_Cooling_Tower
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 452/510
designWaterFlowRate [Default]
if the input method is 0 (UFactorTimesAreaAndDesignWaterFlowRate) then this is
required (value is in cubic meters per second. If left blank, this can be autosized based
on
airflowAtHighSpeed [Default]
the tower airflow rate at high speed in cubic meters per second. If this is left blank, this
field will be autosized (recommended). The airflow rate assumes 190 Pascals of fan
pressure rise an 0.5 total fan efficiency
fanPowerAtHighSpeed [Default]
the fan power at high airflow rate (in Watts). If left blank, the fan power autosized
(recommended) where the power is 0.0105 times the Tower's High Speed Capacity.
lowSpeedCapacity [Default]
the capacity at low fan speed (in Watts) of the cooling tower under same operating
conditions as above. This field will be ignored if the speed is not two-speed.
airflowAtLowSpeed [Default]
the flow rate in m3/s of the tower flow rate at low speed. If left blank, it autosized
(recommended) where the airflow rate is 50% of the airflow at high speed. The airflow
entered must be less than the airflow rate at high speed.
fanPowerAtLowSpeed [Default]
the fan power, (in Watts) at the low-speed airflow rate. It can be autosized
(recommended) where the fan power is set to 16% of the high speed fan power.
freeConvectionCapacity [Default]
the capacity of the cooling tower with no fans (in Watts). If free convection mode is not
modeled, then this field should be set to zero.
airflowInFreeConvection [Default]
the airflow in cubic meters per second through the tower when no fans are on. If left
blank, it can autosize. If inputMethod=0, honeybee will assume it defaults to 0, if
inputMethod=1, the airflow rate is 10% of the airFlowRate at high speed.
basinHeaterCapacity [Default]
Honeybee Primer
452OpenStudio_Cooling_Tower
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 453/510
the capaity (in Watts) of a basin heater that comes on to prevent freezing of the basin
water. If left blank, it will autosize to 0. The heater only comes on when the fans are off,
and the temperatre falls below the setpoint temperature
basinHeaterSetpointTemp [Default]
the setpoint temperature for the basin heater (in degrees C). The heater is active when
the outdoor dry bulb temperature falls below this temperature. Temperature must be
greater than 2 degrees C. Default if blank is 2 degrees C.
basinHeaterSchedule [Default]
if left blank, it will default (recommended) to being "always available". However this can
be overridded to make it only available at certain times.
numberOfCells [Default]
an integer specifying the number of cells. If left blank, the assumption is a single-celled
cooling tower
cellControl [Default]
an integer that specifies one of two options: 0=MinimalCell OR 1=MaximalCell. Option 0
runs as few cells as possible at maximum water flow rate, option 1 assumes maximum
cells at minimum water flow rate
cellMinWaterFlowFraction [Default]
specifies the smallest fraction of the design water flow rate. Flows less than this would
result in fluid distribution problems in the tower. By default, if left blank (recommended),
the default value is 0.33
cellMaxWaterFlowFraction [Default]
specifies the allowable largest fraction of design water flow rate. This field can be
autosized, with a default value of 2.5 (recommended) [for
future]heatRejectionCapacityFactor : a decimal indicating the capacity of the cooling
tower. By default, the factor is 1.25 (assumes that 25% of the load is turned into
compressor heat to be rejected) [for future]designUFactorTimesArea: a value between 0
and 300,000 that defines, in Watts per Kelvin, the heat transfer effectiveness of the
cooling Tower. If inputType is NominalCapacity, this field will be ignored by honeybee.
Left for future because this field can be autosized. [for future]_freeConvAirflowFactor: is
a value that is a fraction of the autocalculated peak flow rate, that is the free convectionflow rate of the tower. Left for future because this field is set to 0.1 by EnergyPlus by
Honeybee Primer
453OpenStudio_Cooling_Tower
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 454/510
default. [for future]_freeConvUFactorTimesArea: a value that is a fraction of the
designUFactorTimesArea. Left for future because this field has defaults or is autosized.
If inputType is NominalCapacity, this field will be ignored by honeybee. [for
future]_freeConvNominalCapacityRatio: a value that is a fraction of the Nominal
capacity [for future]_evaporationLossMode: used to chose which method to model the
amount of water evaporated by the cooling tower. There are two options (LossFactor or
SaturatedExit (the default used for now) [for future]evaporationLossFactor : the rate of
water evaporated from the cooling tower (percent per kelvin). Only used if the lossMode
is LossFactor. The default if left blank is 0.2, with a range between 0.15 - 0.27 [for
future]driftLossPercent : the rate of water lost to exiting air as entrained droplets (a
percentage). If left blank, it defaults to 0.008%, where towers with drift eliminators have
avalues between 0.002% - 0.2% [for future]blowDownCalculation: specifies which
method is used to determine blowdown rates to prevent scaling. Two options,
ConcentrationRation or ScheduleRate with default already provided as
ConcentrationRatio [for future]blowDownConcentrationRatio: the ratio of solids in the
blowdown water to solids in the make up water. This field is used to adjust the rate of
blowdown in the tower. Default is 3, with values between 3 and 5 allowed. [for
future]blowdownMakeupSchedule: a schedule that defines the amount of water (in
m3/s) flushed from the basin periodically. Only used if blowdown calc mode is
ScheduledRate [for future]storageTankName:if specified, the tower will try and take all
water from this unit before attempting to use the water mains
fanPowerRatioflowRatioCurve [Default]
Script variable EPlusCoolingTower
Outputs
out
The execution information, as output and error streams
coolingTower
Script variable Python
Check Hydra Example Files for OpenStudio Cooling Tower
Honeybee Primer
454OpenStudio_Cooling_Tower
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 455/510
OpenStudio EIR Chiller
EPlus EIR Chiller -
Inputs
name [Required]
... provide a unique name for each chiller that you specify
rCapacity [Default]
....r=Reference condition chiller capacity (in Watts), if left blank, the capacity is
Honeybee Primer
455OpenStudio_EIR_Chiller
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 456/510
autosized.
rCOP [Default]
...r=Reference COP at design conditions (includes energy of the copressor only)
rLeavingChWt [Default]
...r=Reference Leaving Chilled Water Temp (in degrees Celsius). If left blank, the default
temperature is 6.67 degrees Celsius.
rEnteringCWT [Default]
... r=Reference Leaving Condenser Water Temp (in degrees Celsius). If left blank, the
default temperature is 29.4 degrees Celsius
rChWFlowRate [Default]
... r=Reference Chilled Water Flow Rate (in Meters Cubed Per Second). If left blank, the
default flow rate is autosized.
rCWFlowRate [Default]
... r=Reference Condenser Water Flow Rate (in Meters Cubed Per Second). If left blank,
the default flow rate is autosized.
minPartLoadRatio [Default]
... the minimum part load ratio of the chiller. If left blank, the default value is 0.1. Range
0.05 <= minPLR <= 0.25
maxPartLoadRatio [Default]
... the maximum part load ratio of the chiller. If left blank, the default value is 1.0. Range
1 <= maxPLR <= 1.2
optimumPartLoadRatio [Default]
... the optimum part load ratio of the chiller. If left blank, the default value is 1.0. Range
0.05 <= maxPLR <= 1.2. Must be >= min and <= max.
minUnloadingRatio [Default]
... The PLR at which the chiller has to be falsely loaded to meet the actual load (usually
by hot gas bypass). If left blank, default is 0.2.
condenserType [Default]
Honeybee Primer
456OpenStudio_EIR_Chiller
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 457/510
... 0=WaterCooled, 1=AirCooled, 2=EvaporativelyCooled. If left blank, the condenser is
WaterCooled. Ratio of CondenserFanPower to Reference compressor power (W/W).
condenserFanPowerRatio [Default]
... Used only when condenserType is AirCooled or EvaporativelyCooled. Dimensionless
ratio Watts of fan power per Watt of Cooling at Design Conditions
fracOfCompressorPowerRej [Default]
... If hermetic compressor, value should be 1.0 (the default). If open compressor, the
motor efficiency. 0.0<=frac<=1.0
chillerFlowMode [Default]
... 0:NotModulated (default), 1:ConstantFlow (constant volume pumping system),2:LeavingSetpointModulated (vary flow to match temp setpoint)
sizingFactor [Default]
use only when the capacities and flow rates are autosized. Default is 1.0 1.0
<=sizingFactor<=1.3
Curves [Default]
... Not yet implemented. Allows you to specify custom part load curves for chiller
performance coils.
Outputs
out
The execution information, as output and error streams
ChillerDesc
...returns the chiller description
Check Hydra Example Files for OpenStudio EIR Chiller
Honeybee Primer
457OpenStudio_EIR_Chiller
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 458/510
OpenStudio Hot Water Boiler
EPlus Hot Water Boiler -
Inputs
name [Required]
... provide a unique name for each boiler that you specify
sequence [Required]
...is a placeholder now (defaulted always to zero. should allow users to create multiple
Honeybee Primer
458OpenStudio_Hot_Water_Boiler
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 459/510
boilers and assign sequencing capabilities. Must be an integer, including zero.
fuelType [Default]
... Leave blank and the default is NaturalGas. Choices are 0=Electricity, 1=NaturalGas,
2=PropaneGas, 3=FuelOil#1, 4=FuelOil#2, 5=Coal, 6=Diesel, 7=Gasoline,
8=OtherFuel1, 9=OtherFuel2
nominalCapacity [Default]
...If left blank, a boiler will be autosized. However, entering a value allows the capacity
to be user-defined, (the Units are in Watts).
sizingFactor [Default]
... a dimensionless number that will be multiplied by the capacity and the design water flow rate. Usually will be something like "1.1" (a 10% increase).
nominalEfficiency [Default]
... The thermal capacity of the boiler. A value between 0 and 1.
designOutletTemperature [Default]
... If left blank?, otherwise enter a value to specify the leaving temp at design, in Celsius
designWaterFlowRate [Default]
... If left blank ?, the water flow rate will autosize. Otherwise enter a value to specify the
design water flow rate (units are meters cubed per second)
minPartLoadRatio [Default]
... Specify a value for the boiler turndown.
maxPartLoadRatio [Default]
... Specify a value for the max boiler capacity (cannot exceed 1.1)
optimumPartLoadRatio [Default]
... Specify a value for the ideal operating part load ration (between min and max part
load ratio)
outletTempMaximum [Default]
... If left blank, the value is 99 degrees Celsius. Otherwise provide your own value for
Honeybee Primer
459OpenStudio_Hot_Water_Boiler
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 460/510
the maximum temperature out of the boiler. This value cannot exceed 99.
boilerFlowMode [Default]
... The default, if not specified, is "NotModulated". However, there are three available
choices. "NotModulated", "ConstantFlow", and "LeavingSetpointModulated"
parasiticElectricLoad [Default]
... The default, if not specified, is 0 (zero). Provide a value to indicate, in Watts, how
much parasitic power is consumed by the boiler by controls, fans, or pumps integral to
the boiler.
curveTemperatureVariable [Default]
... There are two options: "EnteringBoiler" and "LeavingBoiler". This value is used tocontrol which value of hot water to use when evaluating efficiency curves (if provided).
Curves ... Not yet implemented. Allows you to specify custom part load curves for DX
coils.
Curves [Default]
Script variable Python
Outputs
out
The execution information, as output and error streams
HotWaterBoiler
...returns the hot water boiler description
Check Hydra Example Files for OpenStudio Hot Water Boiler
Honeybee Primer
460OpenStudio_Hot_Water_Boiler
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 461/510
FileExplorer
Locate a file/directory in windows explorer. If a file-path is provided then the directory
containing the file is opened. If a folder-path is provided then the folder containing that folder
is opened. - Args: _destination: File path or Directory path
Inputs
destination [Required]
File path or Directory path
Honeybee Primer
461FileExplorer
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 462/510
Outputs
ReadMe!
The execution information, as output and error streams
Check Hydra Example Files for FileExplorer
Honeybee Primer
462FileExplorer
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 463/510
Generator_PV
Inputs
name [Default]
An optional input, a name or a list of names of PV generators which correspond
sequentially to the Honeybee surfaces in _HBSurfaces. Without this input PV
generators will be assigned default names.
HBSurfaces [Required]
Honeybee Primer
463Generator_PV
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 464/510
A Honeybee/context surface or a list of Honeybee/context surfaces to which one
Photovolatic generator will be mounted on each surface.
cellsEfficiency [Required]
A float or a list of floats that sequentially detail the efficiency of the Photovoltaic
generator cells on each Honeybee surface in _HBSurfaces as a fraction. e.g the first
float corresponds to the first Honeybee surface. If only one float is given this value will
be used for all other PV generators.
integrationMode [Required]
EnergyPlus allows for different ways of integrating with other EnergyPlus heat transfer
surfaces and models and calculating Photovoltaic cell temperature. This field is a
integer or a list of integers sequentially to _HBSurfaces between 1 and 6 that defines
the heat transfer integration mode used in the calculations as one of the following
options. Decoupled a value of 1, DecoupledUllebergDynamic a value of 2,
IntegratedSurfaceOutsideFace a value of 3, IntegratedTranspiredCollector a value of 4,
IntegratedExteriorVentedCavity a value of 5, PhotovoltaicThermalSolarCollector a value
of 6. If only one integer is given this value will be used for all other PV generators. More
information about each mode can be found on page 1767 and 1768 of the Energyplus
Input Output reference.
NoParallel [Required]
A integer or a list of integers that sequentially correspond to each Honeybee surface in
_HBSurfaces. These integers define the series-wired strings of PV modules that are in
parallel to form the PV generator on each Honeybee surface. The product of this field
and the next field will equal the total number of modules in the PV generator on each
Honeybee surface. If only one integer is given this value will be used for all other PV
generators.
Noseries [Required]
A integer or a list of integers that sequentially correspond to each Honeybee surface in
_HBSurfaces. These integers define the number of modules wired in series (on each
string) to form the PV generator on each Honeybee surface in _HBSurfaces. The
product of this field and the previous field will equal the total number of modules in the
PV generator on each Honeybee surface. If only one integer is given this value will be
used for all other PV generators.
costPVPerModule [Required]
A float or a list of floats which give the cost of each PV generator on each Honeybee
Honeybee Primer
464Generator_PV
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 465/510
surface in _HBSurfaces in whatever currency the user wishes - (This is the sum of the
cost of each PV module on the surface in question, as a PV generator is made up of
one or several PV modules). If only one float is given this value will be used for all other
PV generators.
powerOutputPerModule [Required]
A float or a list of floats which give the rated power output of each PV generator on each
Honeybee surface in _HBSurfaces in watts. (This is the sum of the rated power output
of each PV module on the surface in question, as a PV generator is made up of one or
several PV modules). If only one float is given this value will be used for all other PV
generators.
PVInverter [Required]
The inverter servicing all the PV generators in this component - to assign an inverter
connect the HB_inverter here from the Honeybee inverter component
Outputs
readMe
Script variable PVgen
PV_HBSurfaces
The Honeybee/context surfaces that have been modified by this component - these
surfaces now contain PV generators to run in an EnergyPlus simulation. To do so you
need to add them to a Honeybee generation system first - connect them to the
PV_HBSurfaces input of a Honeybee_generationsystem component.
Check Hydra Example Files for Generator_PV
Honeybee Primer
465Generator_PV
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 466/510
Generator_Wind_Horizontialaxis
Inputs
TemplateMediumTurbine [Optional]
If set to True a medium sized turbine will be created with pre-set values, the turbines
values can be viewed from the ReadMe! output. Template values can be changed for
each input below by entering a value for each input. Otherwise if no input is given
template values will be used for each input.
TemplateLargeTurbine [Optional]
Honeybee Primer
466Generator_Wind_Horizontialaxis
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 467/510
If set to True a large sized turbine will be created with pre-set values, the turbines
values can be viewed from the ReadMe! output. Template values can be changed for
each input below by entering a value for each input. Otherwise if no input is given
template values will be used for each input.
name [Required]
The name for this wind turbine
simpleOrAnalytical [Required]
An integer of 1 or 2 that defines whether the wind turbine is simple or analytical, the
default is the simple model with a coefficient of 0.40 - The simple model uses one
maximum power coefficient as a maximum fraction of power extraction from ambient
wind. While the analytical model uses 6 with the default analytical coefficents (used only
if turbine switched to analytical) being 0.5176,116,0.4,0,5 and 21 details of each model
can be seen at http://bigladdersoftware.com/epx/docs/8-3/input-output-reference/group-
electric-load-center.html#field-maximum-power-coefficient and
http://bigladdersoftware.com/epx/docs/8-3/input-output-reference/group-electric-load-
center.html#field-power-coefficient-parameter respectively.
powerControl [Required]
This field is the type of rotor control for the wind turbine. This protects the systemagainst the overloading for a system with no speed or pitch control and also to
maximize the energy yield for the system. Four different control types are classified in
the literature: 1-Fixed Speed Fixed Pitch (FSFP), 2-Fixed Speed Variable Pitch (FSVP),
3-Variable Speed Fixed Pitch (VSFP), and 4-Variable Speed Variable Pitch (VSVP).
enter an integer input of 1,2,3 and 4 to select these options respectively.
rotorSpeed [Required]
This field is the maximum rotational speed of the rotor at the rated power of the windturbine in rev/min (revolution per minute). It is used to determine the tip speed ratio of
the rotor and relative flow velocity incident on a single blade of the VAWT systems.
rotorDiameter [Required]
This field is the diameter of the rotor (in meters ). Note that this field is not the height of
the blade, but the diameter of the perpendicular circle from the vertical pole in the VAWT
systems. It determines the swept area of the rotor of the HAWT systems and the
chordal velocity of the VAWT systems.
overallHeight []
Honeybee Primer
467Generator_Wind_Horizontialaxis
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 468/510
This field is the height of the hub of the HAWT system, or of the pole of the VAWT
system (in meters). It is necessary to estimate local air density and the wind speed at
this particular height where the wind turbine system is installed.
numberOfBlades [Required]
This field is the number of blades of the wind turbine. The azimuth angle of the rotor of
the VAWT system is determined by dividing 360 degree by this field so that the model
determines the chordal velocity component and the normal velocity component of the
system. The default value is 3.
powerOutput [Required]
This field is the nominal power output of the wind turbine system at the rated wind
speed (in W or Btu/hr). Note that the maximum power of the system should be entered
with no control, i.e. FSFP control type, can physically produce. Manufacturer data
sometimes describes this as “peak power” or “rated capacity”. If the local wind speed is
greater than the rated wind speed, the model assumes constant power output of this
field.
ratedWindSpeed [Required]
This field is the wind speed that the wind turbine system indicates the peak in the power
curve (in m/s ). The system produces the maximum power at this speed and the speedof the rotor is managed based on this wind speed.
cutInWindSpeed [Required]
This field is the lowest wind speed where the wind turbine system can be operated (in
m/s). No power generation is achieved as long as the ambient wind speed is lower than
this speed
cutOutWindspeed [Required]
This field is the greatest wind speed (in m/s). When the wind speed exceeds this value,
the wind turbine system needs to be stopped because of inefficiencies in the system. All
systems that have either pitch or speed control must be stopped when the ambient wind
speed exceeds this speed. Note that the user should input a wind speed above which
physical damage to the system might be caused in the case of a FSFP system. It
appears as “extreme/survival/design wind speed” in the literature. The system will be
turned off when the ambient wind speed is over this speed.
overallTurbineEfficiency [Required]
Honeybee Primer
468Generator_Wind_Horizontialaxis
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 469/510
This field is the overall system efficiency of the wind turbine system. It includes all the
conversion losses as well as transient losses during the dynamic control when the
ambient wind speed is between the rated wind speed and cut-out wind speed (see
previous fields). The user also has the ability to specify delivery losses from the system
to the local area. If the user does not enter a fraction, the model assumes the default
value of 0.835. Note that the fraction must be between zero and one.
maxTipSpeedRatio [Required]
This field is the maximum tip speed ratio between the rotor velocity and ambient wind
velocity. The rotor speed varies with this ratio to maximize the power output when the
rotor control types are variable speed ones. This field allows the user to adjust the
power output from the particular system or to find the optimal tip speed ratio of the
system. Optimal tip speed ratio is dependent on the number of blades. It is typically
about 6, 5, and 3 for two-bladed, three-bladed, and four-bladed rotor, respectively. For
the vertical axis wind turbine, it is smaller than horizontal axis wind turbine, and varies
with the chord area.
maxPowerCoefficient [Required]
Used only with the simple model, this is the maximum fraction of power extraction
possible from the ambient wind. This value can be calculated from the power curve
published in most manufacturers' specifications by using the kinetic energy equation as
Cp = P/0.5 ρ A*V^3 where: P = power production at the rated wind speed [W], ρ =
density of air [kg/m3], A = swept area of rotor [m2], V = rated wind speed [m/s], Cp =
power coefficient
powerCoefficients [Required]
Used only with the analytical model - Use a grasshopper panel set to multiline data to
specify the 6 power coefficients - If none are specified the defaults outlined in the
Energy Plus documentation will be used. More information can be found at:
http://bigladdersoftware.com/epx/docs/8-2/input-output-reference/group-electric-load-
center.html#field-power-coefficient-parameter
localAvWindspeed [Required]
This is the local annual average wind speed that represents a representative wind
profile at the location of the system (in m/s ). It is used to factor the difference in wind
speed between the weather file wind data and the locally measured wind data so that
the model minimizes uncertainties caused by improper wind data at the particular
location. Considerable differences between the weather file wind data and the local
wind data typically appear so it is important to consider this carefully in order to use
Honeybee Primer
469Generator_Wind_Horizontialaxis
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 470/510
accurate local wind data in the simulation. The model internally determines a multiplier
and it is multiplied by the weather file wind data adjusted at the height of the system
heightLocalMetrologicalStation [Required]
This is the height that the local wind speed is measured (in meters ). The annual
average wind speed (see previous field) input by the user is internally recalculated by
existing EnergyPlus functions at the height of the local station. This modified wind
speed is then factored and applied to the weather file wind data. The minimum and
default values are zero and 50 meters.
turbinecost [Required]
The cost of the turbine
Outputs
ReadMe!
The execution information, as output and error streams
HBWindTurbine
A Honeybee wind turbine. To run this in an EnergyPlus system you must first add it to a
Honeybee generation system - to do so connect this output to the
HB_generationobjects input of the Honeybee_generationsystem component
Check Hydra Example Files for Generator_Wind_Horizontialaxis
Honeybee Primer
470Generator_Wind_Horizontialaxis
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 471/510
generationsystem
Use this component to create a Honeybee generator system. -
Inputs
GeneratorSystemName [Required]
The name of this Honeybee generation system please make it unique!
MaintenanceCost [Required]
The annual cost of maintaining this Honeybee generation system in US dollars (Other
Honeybee Primer
471generationsystem
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 472/510
currencies will be available in the future)
PVHBSurfaces [Optional]
The Honeybee/context surfaces that contain PV generators to be included in this
generation system
HBGenerationObjects [Optional]
Honeybee batteries or wind turbines to be included in this generation system
Outputs
readMe!
The execution information, as output and error streams
HBGeneratorSystem
The Honeybee generation system - connect this to the input HB_generators on the
Honeybee_Run Energy Simulation component to include this generation system in an
EnergyPlus simulaton
Check Hydra Example Files for generationsystem
Honeybee Primer
472generationsystem
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 473/510
simple_Inverter
Inputs
inverterName [Required]
The inverter name - Make it unique from other inverters
inverterEfficiency [Default]
The efficiency of the inverter by default this is 90%
inverterCost [Required]
Honeybee Primer
473simple_Inverter
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 474/510
The cost of the inverter in US dollars (Other currencies will be available in the future)
replacementTime [Default]
Specify how often in years the inverter will need to be replaced. The default is 5 years.
Outputs
readMe!
The execution information, as output and error streams
HB_inverter
Honeybee inverter- to include this inverter in a generation system connect it to the input
HB_generationobjects on the Honeybee_generationsystem component
Check Hydra Example Files for simple_Inverter
Honeybee Primer
474simple_Inverter
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 475/510
Create Therm Boundaries
Use this component to create a THERM boundary condition. -
Inputs
boundaryCurve [Required]
A polyline or list of polylines that coincide with the thermPolygons that you plan to
connect to the "Write Therm File" component.
name [Required]
Honeybee Primer
475Create_Therm_Boundaries
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 476/510
An name for the boundary condition to keep track of it through the creation of the
THERM model. If no value is input here, a default unique name will be generated.
temperature [Required]
A numerical value that represents the temperature at the boundary in degrees Celcius.
filmCoefficient [Required]
Either a numerical value in W/m2-K that represents the conductivity of the air film at the
boundary condition or simply input the word 'indoor' or 'outdoor' to have the film
coefficient autocalculated based on the position of geometry in the Rhino scene and an
interpolation of values from Table 10 from chapter 26 of ASHRAE Fundementals 2013:
Typical film coefficient values range from 26 W/m2-K (for an NFRC exterior envelope) to
2.5 W/m2-K (for an interior wood/vinyl surface). Note that, when inputting 'outdoor', the
component will assume an outdoor wind speed of 3.4 m/s (22.7 W/m2-K) and, for higher
wind speeds, higher film coefficients should be input (ie. 6.7 m/s = 34.0 W/m2-K).
emissivity [Optional]
An optional number between 0 and 1 to set an override for the emissivity along the
boundary. By default, the Grasshopper components will take the emissivity of the
material that is adjacent to the boundary. However, a value here can over-ride this value
to account for coatings like those on Low-E glass or matte paint on metallic materials.
uFactorTag [Optional]
An optional text string to define a U-Factor tag for the boundary condition. U-Factor tags
are used tell THERM the boundary on which you would like to compute a U-Value. The
default is set to to have no U-Factor tag. This input can be any text string. For example
"Frame", "Edge", or "Spacer."
RGBColor [Optional]
An optional color to set the color of the boundary condition when you import it into
THERM.
Outputs
readMe!
...
thermBoundary
Honeybee Primer
476Create_Therm_Boundaries
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 477/510
A polyline with the specified boudary condition properties, to be plugged into the
"boundaries" input of the "Write Therm File" component.
Check Hydra Example Files for Create Therm Boundaries
Honeybee Primer
477Create_Therm_Boundaries
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 478/510
Create Therm Polygons
Use this component to create a THERM polygon with material properties. -
Inputs
geometry [Required]
A closed planar curve or list of closed planar curves that represent the portions of a
construction that have the same material type. This input can also accept closed planar
surfaces/breps/polysurfaces and even meshes!
Honeybee Primer
478Create_Therm_Polygons
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 479/510
material [Required]
Either the name of an EnergyPlus material from the OpenStudio library (from the "Call
from EP Construction Library" component) or the output of any of the components in the
"06 | Energy | Material" tab for creating materials.
RGBColor [Optional]
An optional color to set the color of the material when you import it into THERM. All
materials from the Honyebee Therm Library already possess colors but materials from
the EP material lib will have a default blue color if no one is assigned here.
Outputs
readMe!
...
thermPolygon
A polygon representing material properties
Check Hydra Example Files for Create Therm Polygons
Honeybee Primer
479Create_Therm_Polygons
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 480/510
Import THERM XML
Use this component to read the content of a THERM XML file into Grasshopper. The
component will extract both THERM polygons and boundary conditions along with all of their
properties. -
Inputs
thermXMLFile [Required]
A filepath to a therm XML file on your machine.
Honeybee Primer
480Import_THERM_XML
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 481/510
Outputs
readMe!
...
thermPolygons
The therm polygons within the therm XML file.
thermBCs
The therm boundary conditions within the therm XML file.
Check Hydra Example Files for Import THERM XML
Honeybee Primer
481Import_THERM_XML
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 482/510
Read THERM Result
Use this component to import the colored mesh results from a THERM simulation. Note that,
because the THERM API version is not free, you will have to open the file generated by run
the "Write THERM File" component are run it yourself (maybe in the future, we will be able
to launch it from the command line). _ Before you run the file in THERM, make sure that you
go to Options > Preferences > Simulation and check "Save Conrad results file (.O)" in order
to enure that your THERM simulation writes all results out in a format that this component
understands. -
Inputs
Honeybee Primer
482Read_THERM_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 483/510
resultFile [Required]
The resultFileAddress from the "Write THERM File" component. Make sure that you
have opened THERM and run your file before using this component. Also, before you
run the file in THERM, make sure that you go to Options > Preferences > Simulation
and check "Save Conrad results file (.O)" in order to enure that your THERM simulationwrites this file.
thermFile [Optional]
An optional filepath to a THERM file that has been generated with the 'Honeybee_Write
THERM File' component. The header of this file contains information on the
transformations used to map the original geometry between Rhino space and the
THERM canvas. As a result, connecting a file here ensures that imported results
happen on top of the original Rhino geometry. If no file address is connected here, theTHERM results are imported with their THERM canvass coordinates.
uFactorFile [Optional]
An optional path to a THERM file that has been saved after importing and simulating
files generated with the 'Honeybee_Write THERM File' component. Before you run the
file in THERM, make sure that you go to Options > Preferences > Preferences and
check "Automatic XML Export on Save" in order to enure that your THERM simulation
writes this uFactorFile.
dataType [Optional]
An optional integer to set the type of data to import. If left blank, this component will
import the temperature data. Choose from the following two options: 0 - Temperature
(temperature meshValues at each point in C) 1 - Heat Flux (heat flux meshValues at
each point in C)
legendPar [Optional]
Optional legend parameters from the Ladybug "Legend Parameters" component.
runIt [Required]
Script variable Python
Outputs
readMe!
...
Honeybee Primer
483Read_THERM_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 484/510
uFactorTags
Script variable readTHERM
uFactors
Script variable readTHERM
meshValues
The numerical meshValues of the results in either degrees C or W/m2 (depending on
the dataYpe_ input of this component).
meshPoints
The meshPoints of the mesh that THERM has generated.
coloredMesh
A mesh of the original THERM geometry that is colored with the results.
legend
A legend for the coloredMesh above. Connect this output to a grasshopper "Geo"
component in order to preview this legend separately in the Rhino scene.
legendBasePt
The legend base point, which can be used to move the legend in relation to the
newMesh with the grasshopper "move" component.
title
The title text of the results. Hook this up to a native Grasshopper 'Geo' component to
preview it separately from the other outputs.
titleBasePt
Point for the placement of the title, which can be used to move the title in relation to the
chart with the native Grasshopper "Move" component.
Check Hydra Example Files for Read THERM Result
Honeybee Primer
484Read_THERM_Result
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 485/510
Therm Material
Use this component to create a custom THERM material, which can be plugged into the
"Honeybee_Create Therm Polygons" component. -
Inputs
materialName [Required]
A text name for your THERM Material.
conductivity [Required]
Honeybee Primer
485Therm_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 486/510
A number representing the conductivity of the THERM material in W/m-K.
absorptivity [Optional]
A number between 0 and 1 that represents the solar absorptivity of the material. The
default is set to 0.5.
emissivity [Optional]
A number between 0 and 1 that represents the emissivity of the material. The default is
set to 0.9.
type [Optional]
An integer that represents the type of material. The defaul is set to 0 - solid. Choose
from the following options: 0 - Solid material 1 - Gas material
RGBColor [Optional]
An optional color to set the color of the material when you import it into THERM.
Outputs
thermMaterial
A therm material that can be plugged into the "Honeybee_Create Therm Polygons"
component.
Check Hydra Example Files for Therm Material
Honeybee Primer
486Therm_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 487/510
Therm Material to EnergyPlus Material
Use this component to create a custom opaque material, which can be plugged into the
"HoneybeeEnergyPlus Construction" component. This component requires you to know a lot
of the characteristics of the material and, you may want to borrow some characteristcs of a
similar material in the library. Use the "HoneybeeCall From EP Construction Library" and the
"Honeybee_Decompose EP Material" to help with this. If you are not able to find all of the
necessary material characteristcs and your desired material is relatively light, it might be
easier for you to use a "Honeybee_EnergyPlus NoMass Opaque Material." -
Inputs
Honeybee Primer
487Therm_Material_to_EnergyPlus_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 488/510
thermMaterial [Required]
The name of a Therm material from the ThermMaterials output from the from the "Call
from EP Construction Library" component.
roughness [Default]
A text value that indicated the roughness of your material. This can be either
"VeryRough", "Rough", "MediumRough", "MediumSmooth", "Smooth", and
"VerySmooth". The default is set to "Rough".
thickness [Required]
A number that represents the thickness of the material in meters (m).
density [Required]
A number representing the density of the material in kg/m3. This is essentially the mass
one cubic meter of the material.
specificHeat [Required]
A number representing the specific heat capacity of the material in J/kg-K. This is
essentially the number of joules needed to raise one kg of the material by 1 degree
Kelvin.
Outputs
EPMaterial
An opaque material that can be plugged into the "Honeybee_EnergyPlus Construction"
component.
Check Hydra Example Files for Therm Material to EnergyPlus Material
Honeybee Primer
488Therm_Material_to_EnergyPlus_Material
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 489/510
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. -
Inputs
polygons [Required]
A list of thermPolygons from one or more "Honeybee_Create Therm Polygons"
components.
Honeybee Primer
489Write_THERM_File
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 490/510
boundaries [Required]
A list of thermBoundaries from one or more "Honeybee_Create Therm Boundaries"
components.
meshLevel [Optional]
An optional integer to set the mesh level of the resulting exported file. The default is set
to a coarse value of 6 but it may be necessary to increase this if THERM tells you to
'increase the quad tree mesh parameter in the file'.
workingDir [Optional]
An optional working directory to a folder on your system, into which you would like to
write the THERM XML and results. The default will write these files in into your Ladybug
default folder. NOTE THAT DIRECTORIES INPUT HERE SHOULD NOT HAVE ANY
SPACES OR UNDERSCORES IN THE FILE PATH.
fileName [Optional]
An optional text string which will be used to name your THERM XML. Change this to
aviod over-writing results of previous runs of this component.
writeTHMFile [Required]
Script variable Python
Outputs
readMe!
...
thermFile
Script variable Python
uFactorFile
Script variable writeTHERM
resultFile
The location where the THERM results will be written once you open the XML file above
in THERM and hit "simulate."
Check Hydra Example Files for Write THERM File
Honeybee Primer
490Write_THERM_File
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 491/510
Honeybee Primer
491Write_THERM_File
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 492/510
Mirror Honeybee
Mirror Honeybee Objects -
Inputs
HBObj [Required]
Script variable Python
plane [Required]
Mirror plane
Honeybee Primer
492Mirror_Honeybee
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 493/510
Outputs
HBObj
Script variable moveHBObj
Check Hydra Example Files for Mirror Honeybee
Honeybee Primer
493Mirror_Honeybee
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 494/510
Move Honeybee
Move Honeybee Objects -
Inputs
HBObj [Required]
Script variable Python
vector [Required]
Transform vector
Honeybee Primer
494Move_Honeybee
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 495/510
Outputs
HBObj
Script variable moveHBObj
Check Hydra Example Files for Move Honeybee
Honeybee Primer
495Move_Honeybee
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 496/510
Rotate Honeybee
Rotate Honeybee Objects -
Inputs
HBObj [Required]
Script variable Python
angle [Required]
Angle of rotation in degrees
Honeybee Primer
496Rotate_Honeybee
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 497/510
cenPt [Optional]
Script variable moveHBObj
axis [Optional]
Optional rotation axis as a vector. Default is Z Axis
Outputs
HBObj
Script variable moveHBObj
Check Hydra Example Files for Rotate Honeybee
Honeybee Primer
497Rotate_Honeybee
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 498/510
IES Custom Lamp
This component can be used to specify a lamp of custom chromaticity, color or color
temperature. . If lampName is specified from an existing list of lamps (which can be seen by
hovering over the _lampName input), then the chromaticity associated with the lamp will be
used. . In case _lampName isn't present in the list,a lamp with chromaticity corresponding to
3200K will be defined. . If case the custom lamp is being defined by specifying _colorTemp
or xCor,_yCor , it is recommended that the lampDetails output be connected to a text panel
for displaying the chromaticity and color temperature of the lamp. . In case of a conflict, input
options on the top will override inputs below them. - -
Honeybee Primer
498IES_Custom_Lamp
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 499/510
Technical Notes:
The Color Matching Functions used for calculations were obtained from Wyszecki, Gunter,
and Walter Stanley Stiles. Color science. Vol. 8. New York: Wiley, 1982. . The calculation of
CCT and Duv are based on: Ohno, Yoshi. Practical use and calculation of CCT and Duv.
Leukos 10.1 (2014): 47-55. . CCT calculations should be within +/- 0.1 % margin of error.
The Planckian Table used for calculations is based on a 1% step-size. . While (x,y), (u,v) or
(u'v') coordinates may be specified for any valid location on the chromaticity diagram, CCT
and Duv will only be displayed if the absolute value of Duv is less than or equal to 0.02. . .
!!WARNING !!
The colors specified in this component only affect the luminance and chromaticity of the light
source. The color fidelity or gamut area of the source cannot be modified by this component.
So, color fidelity metrics such as CRI cannot be considered in these calculations.
Inputs
lampName [Required]
Specify a name for the lamp.The name can be a predefined lamp name or any other
name. The following lamp names are predefined. The values in parenthesis are the x,y
1931 chromaticity coordinates and lumen depreciation values.: clear metal halide
(0.396, 0.39, 0.8) cool white (0.376, 0.368, 0.85) cool white deluxe (0.376, 0.368, 0.85)
deluxe cool white (0.376, 0.368, 0.85) deluxe warm white (0.44, 0.403, 0.85) fluorescent
(0.376, 0.368, 0.85) halogen (0.4234, 0.399, 1) incandescent (0.453, 0.405, 0.95)
mercury (0.373, 0.415, 0.8) metal halide (0.396, 0.39, 0.8) quartz (0.424, 0.399, 1)
sodium (0.569, 0.421, 0.93) warm white (0.44, 0.403, 0.85) warm white deluxe (0.44,
0.403, 0.85) xenon (0.324, 0.324, 1) For example,specifying "cool white" (without the
quotes) as input will set the x,y,Lumen Depreciation values to 0.376, 0.368 and 0.85respectively. Specifying an arbitrary name like "lampx" will create a lamp with x,y,lumen
depreciation values of 0.333,0.333 and 1 respectively. These values can then be
modified by specifying _colorTemp or xCor and yCor or rgbColors.
colorTemp [Default]
Specify a color temperature for the lamp.The color temperature will be used to calculate
the chromatcity coordinates of the lamp on the CIE 1931 xy diagram. Lumen
depreciation factor for the lamp can be set by specifying a value for the deprFactor
input. Valid values for color temperature are from 1000 to 25000.
Honeybee Primer
499IES_Custom_Lamp
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 500/510
xCor [Default]
Specify a chromaticity coordinate for the lamp. The default coordinate is the x
coordinate for the CIE 1931 Color Space.
yCor [Default]
Specify a chromaticity coordinate for the lamp. The default coordinate is the y
coordinate for the CIE 1931 Color Space.
colorSpace [Default]
Specify a color space for the chromaticity coordinates. The values and their
corresponding color spaces are 0 - CIE 1931 Color Space (default) 1 - CIE 1960 Color
Space 2 - CIE 1976 Color Space
rgbColors [Default]
Specify a (r,g,b) color value using either the Grasshopper Colour Swatch (preferred) or
a text panel. If the alpha value for the Colour Swatch is set to a value other than 255
then that value will be multiplied with the deprFactor .
deprFactor [Default]
Lamp lumen depreciation factor.
Outputs
readMe!
The execution information, as output and error streams
lampDetails
Information about the lamp defined as per the input parameters.
customLamp
Connect this to the customLamp_ input in the Honeybee_IES Luminaire option.
Check Hydra Example Files for IES Custom Lamp
Honeybee Primer
500IES_Custom_Lamp
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 501/510
IES Luminaire
This is the core component for adding photometric data into a lighting simulation. It parses
an IES photometric file to create a geometric representation of the photometric data on the
Rhino viewport. It also calls xform and ies2rad, two programs within RADIANCE, to create a
RADIANCE representation of the photometric data. In case writeRad is set to True and all
the other input requirements are satisfied a .rad file containing photometric information will
be created. This file, accessible through radFilePath should be connected to the
additionalRadFiles input in the Honeybee Run Daylight Simulation component. . .
Technical Notes:
Honeybee Primer
501IES_Luminaire
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 502/510
The parsing of IES files is based on IES LM-63-2002. . This component is only compatible
with Type C photometry. However, if Type B photometry is to be used, external programs
such as the Photometric Toolbox can be used to convert Type B photometry to Type C. . The
luminous shapes, as defined by LM-63-2002 currently compatible with this component are
rectangular, circular and rectangular with luminous openings. . The curves drawn for creating
the luminaire web is not based on interpolation. So it is possible that the curve may look
irregular in case the number of vertical angles are less. .
Suggested practices/workflow:
The writeRad option should only be set to True once the amiming and positioning of
luminaires has been confirmed. . In case the photometric distribution of the luminaire is not
quadrilaterally symmetric, the _drawLuminaireWeb option should be set to True. This willhelp in aiming and locating the luminaire properly. . In case the customLamp_ option is being
used, the lumen depreciation factor of the custom lamp should be properly set for
illuminance or luminance calculations.
Inputs
iesFilePath [Required]
Specify the file path for .ies photometry file.
luminaireID [Required]
Custom name for the luminaire rad file. The default name is the same as the name of
the IES file.
luminaireZone [Required]
List of (3-d coordinate, Aiming Angle) combinations that are generated through the IES
Luminaire Array component.
lightLossFactor [Default]
Optional value for light loss factor. Default is 1.0
candelaMultiplier [Default]
Assign a scaling value for the candela tables. This value gets multiplied by the
lightLossFactor value.
customLamp [Optional]
Honeybee Primer
502IES_Luminaire
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 503/510
Specify a custom lamp using the IES Custom Lamp component
drawLuminaireWeb [Default]
Draw a geometric representation of the candela distribution of the luminaire on the
Rhino viewport. If set to True then geometry normalized to unit dimensions will be
drawn. If a number is provided, then geometry will be drawn and scaled to that value.
drawLuminaireAxes [Default]
Draw the C0-G0 axes of the luminaire on the Rhino viewport. If set to True then axes
normalized to 1.5 times the unit dimensions will be drawn. If a number is provided, then
geometry will be drawn and scaled to that value.
drawLuminairePoly [Default]
Draw the polygon, circle or box representing the luminous opening of the luminaire on
the Rhino viewport. If set to True then geometry normalized to unit dimensions will be
drawn. If a number is provided, then geometry will be drawn and scaled to that value.
extendLumAxesToPt [Optional]
Specify a point to which the luminaire axes should be extended to. Please note that if
the aiming of the luminaire is very far way from this point then some abnormal results
might be seen.
radDir [Default]
Custom location for the luminaire rad file. The default location is the same as where the
original IES file is located.
writeRad [Required]
Set to True to create the file for electric lighting simulation.
Outputs
readMe!
The execution information, as output and error streams
luminaireDetails
A description of the luminaire generated after parsing the IES file.
luminaire3dWeb
Honeybee Primer
503IES_Luminaire
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 504/510
The geometry created in the Rhino viewport for visualizing the luminaire. Can be used
for generating previews.
luminaireList
List of luminaires and their locations and mounting angles.
radFilePath
Location of the RAD file that should be included in the project. Connect this output to
the additionalRadFiles input in the Honeybee_Run_DaylightSimulation module.
Check Hydra Example Files for IES Luminaire
Honeybee Primer
504IES_Luminaire
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 505/510
IES Luminaire Zone
This component is to be used for specifying the location of luminaires for electric light
-
For external lighting applications the best option would be to use the aimingPoint_ opti
In case luminaires are being aimed by specifying spin, tilt and orientation angles, the
1. spin : specifies the rotation of a luminaire about its G0 axis.
2. tilt : species the rotation of a luminaire around the Y axis.
3. orientation: specifies the rotation of a luminaire around the Z axis. The recommended
sequence of applying rotations is tilt,orientation and spin. _ The aiming conventions
Honeybee Primer
505IES_Luminaire_Zone
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 506/510
followed in this component are based on the IES LM-63-2002 and were tested against
indoor lighting simulations with AGI32 software.
Inputs
ptsList [Required]
List of points/3d coordinates where the luminaires are to be located.
spin [Default]
Luminaire spin angle.
tilt [Default]
Luminaire tilt angle.
orientation [Default]
Luminaire rotation angle.
aimingPoint [Optional]
Location at which the photometric axis of each luminaire should be aimed.
customLamp [Optional]
Specify a custom lamp using the IES Custom Lamp component
Outputs
readMe!
The execution information, as output and error streams
luminaireZone
List of coordinates and rotation angles for luminaires
Check Hydra Example Files for IES Luminaire Zone
Honeybee Primer
506IES_Luminaire_Zone
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 507/510
Read_generation_system_results
This component reads the results of an EnergyPlus simulation from the WriteIDF
Component or any EnergyPlus result .csv file address. Note that, if you use this component
without the WriteIDF component, you should make sure that a corresponding .eio file is next
to your .csv file at the input address that you specify. _ This component reads only the
results related to Honeybee generation systems. For other results related to zones, you
should use the "Honeybee_Read EP Result" for HVAC use the "Honeybee_Read EP HVAC
Result" component and, for results related to surfaces, you should use the "Honeybee_Read
EP Surface Result" component. -
Inputs
Honeybee Primer
507Read_generation_system_results
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 508/510
resultFileAddress [Required]
The result file address that comes out of the WriteIDF component.
idfFileAddress [Required]
The IDF file address that comes out of the WriteIDF component.
Outputs
Readme!
The execution information, as output and error streams
totalelectdemand
The total electricity demand of the facility in Kwh
netpurchasedelect
The net purchased electricity of the facility in Kwh
a negative value means that the facility produced surplus electricity and it was sold
to the grid.
generatorproducedenergy
The electricity produced by each Honeybee generator in the facility
financialdata
The financial data of the Honeybee generators in the facility.
Check Hydra Example Files for Read_generation_system_results
Honeybee Primer
508Read_generation_system_results
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 509/510
Visualise_Honeybeegeneration_cashflow
Use this component to the calculate and visualise the financial value of Honeybee
generation systems over 25 years. At present you can only create grid connected renewable
energy systems without storage. For this reason you must specify both the grid electricity
price and fed in tariff rate. - The financial value of the Honeybee generator systems is
calculated by calculating how much energy is consumed by the facility and produced by the
Honeybee generator systems for every hour of the year. - For every hour of the year if
electricity is generated and the facility requires electricity, the facility will automatically
consume the electricity generated. This will generate a revenue as the facility did not have topurchase electricity from the grid. - Any surplus electricity generated in any hour throughout
the year will be fed back into the grid at the tariff rate, and generate a revenue. -
Honeybee Primer
509Visualise_Honeybeegeneration_cashflow
8/19/2019 Honeybee Primer
http://slidepdf.com/reader/full/honeybee-primer 510/510
Inputs
inputData [Required]
To use this component please input all the outputs from the component
readEP_generation_system_results here
discountFactor [Optional]
An optional input - specify the interest rate as a percentage to calculate a discount
factor for each Honeybee generation system. A discount factor is a ratio used to
calculate the present value of a future revenue or cost that occurs in any year of the
system lifetime (25 years) using the equation - fd = 1/(1+i)^N where: i = real interest rate
,N = number of years. If this field is left blank no discount factor will be applied
gridElectCostSchedule [Required]
The cost of grid connected electricty per Kwh in US dollars If you want to specify a flat
t j t if l thi ill b d ll th h f th Oth i
Honeybee Primer