Honeybee Primer Components

Table
of Contents
What is this primer? 1.1
Components 1.2
00 | Honeybee 1.2.1
AskMe 1.2.1.1
Honeybee 1.2.1.2
Find_Non-Convex 1.2.1.3
IntersectMasses 1.2.1.4
SplitBuildingMass2Floors 1.2.1.5
SplitFloor2ThermalZones 1.2.1.6
Glazing_based_on_ratio 1.2.1.7
Masses2Zones 1.2.1.8
Solve_Adjacencies 1.2.1.9
addHBGlz 1.2.1.10
createHBSrfs 1.2.1.11
createHBZones 1.2.1.12
Decompose_Based_On_Boundary_Condition 1.2.1.13
Decompose_Based_On_Type 1.2.1.14
Label_Zone_Surfaces 1.2.1.15
Label_Zones 1.2.1.16
Surface_Attribute_List 1.2.1.17
Zone_Attribute_List 1.2.1.18
Dump_Honeybee_Objects 1.2.1.19
Load_Honeybee_Objects 1.2.1.20
Mirror_Honeybee 1.2.1.21
Move_Honeybee 1.2.1.22
Rotate_Honeybee 1.2.1.23
Scale_Honeybee 1.2.1.24
Item_Selector 1.2.1.25
ChangeHBObjName 1.2.1.26
DecomposeHBZone 1.2.1.27
1
Extrude_Windows 1.2.1.28
Get_or_Set_HB_Object_Name 1.2.1.29
Glazing_Parameters_List 1.2.1.30
OpenFileDirectory 1.2.1.31
PerimeterCoreZoning 1.2.1.32
Remove_Glazing 1.2.1.33
Select_by_Type 1.2.1.34
Separate_Zones_By_Floor 1.2.1.35
Separate_Zones_By_Orientation 1.2.1.36
Separate_Zones_By_Program 1.2.1.37
Separate_conditioned_and_unconditioned_zones 1.2.1.38
Skylight_Based_on_Ratio 1.2.1.39
orientHBGlz 1.2.1.40
01 | Daylight | Material 1.2.2
Radiance_Glass_Material 1.2.2.1
Radiance_Opaque_Material 1.2.2.2
Add_to_Radiance_Library 1.2.2.3
Call_from_Radiance_Library 1.2.2.4
Radiance_Materials_Info 1.2.2.5
Set_Radiance_Materials 1.2.2.6
Radiance_BSDF_Material 1.2.2.7
Radiance_Glass_Material_By_Color 1.2.2.8
Radiance_Metal_Material 1.2.2.9
Radiance_Metal_Material_By_Color 1.2.2.10
Radiance_Mirror_Material 1.2.2.11
Radiance_Mirror_Material_By_Color 1.2.2.12
Radiance_Opaque_Material_By_Color 1.2.2.13
Radiance_Trans_Material 1.2.2.14
Radiance_Trans_Material_By_Color 1.2.2.15
02 | Daylight | Light Source 1.2.3
Generate_Climate_Based_Sky 1.2.3.1
Generate_Cumulative_Sky 1.2.3.2
Generate_Standard_CIE_Sky 1.2.3.3
Watch_The_Sky 1.2.3.4
2
IES_Custom_Lamp 1.2.3.5
IES_Luminaire 1.2.3.6
IES_Luminaire_Zone 1.2.3.7
IES_Project 1.2.3.8
Generate_Average_Sky 1.2.3.9
Generate_Custom_Sky 1.2.3.10
Generate_Dark_Sky 1.2.3.11
Generate_Sky_With_Certain_Illuminance_level 1.2.3.12
03 | Daylight | Recipes 1.2.4
Annual_Daylight_Simulation 1.2.4.1
Daylight_Factor_Simulation 1.2.4.2
Generate_Test_Points 1.2.4.3
Grid_Based_Simulation 1.2.4.4
Image_Based_Simulation 1.2.4.5
Vertical_Sky_Component 1.2.4.6
DSParameters 1.2.4.7
RADParameters 1.2.4.8
Advanced_Dynamic_Shading_Recipe 1.2.4.9
Ambient_Resolution 1.2.4.10
Conceptual_Dynamic_Shading_Recipe 1.2.4.11
Daysim_Glare_Control_Recipe 1.2.4.12
Daysim_Shading_State 1.2.4.13
Generate_Zone_Test_Points 1.2.4.14
04 | Daylight | Daylight 1.2.5
Glare_Analysis 1.2.5.1
Run_Daylight_Simulation 1.2.5.2
Import_rad 1.2.5.3
ReadAnnualResultsIII 1.2.5.4
Read_Annual_Result_I 1.2.5.5
Read_Annual_Result_II 1.2.5.6
Read_RAD_Result 1.2.5.7
Convert_HDR_to_GIF 1.2.5.8
FalseColor 1.2.5.9
3
Import_Pts_File 1.2.5.10
Lookup_Daylighting_Folder 1.2.5.11
Daysim_Occupancy_Generator 1.2.5.12
Daysim_Occupancy_Generator_Based_On_List 1.2.5.13
Daysim_shading_group_sensors 1.2.5.14
Lighting_control_Recipe 1.2.5.15
Convert_HDR_to_TIF 1.2.5.16
Convert_IMG 1.2.5.17
Convert_TIF_to_HDR 1.2.5.18
Daysim_Annual_Profiles 1.2.5.19
Daysim_Electrical_Lighting_Use 1.2.5.20
Import_dgp_File 1.2.5.21
MSH2RAD 1.2.5.22
Read_All_the_Hourly_Results_from_Annual_Daylight_Study 1.2.5.23
Read_DS_Result_for_a_point 1.2.5.24
Read_Hourly_Results_from_Annual_Daylight_Study 1.2.5.25
Refine_Daylight_Simulation 1.2.5.26
Set_Exposure_for_HDR 1.2.5.27
05 | Energy | Building Program 1.2.6
ListZonePrograms 1.2.6.1
bldgPrograms 1.2.6.2
Get_EnergyPlus_Loads 1.2.6.3
Get_EnergyPlus_Schedules 1.2.6.4
Get_Zone_EnergyPlus_Loads 1.2.6.5
Get_Zone_EnergyPlus_Schedules 1.2.6.6
06 | Energy | Material | Construction 1.2.7
EnergyPlus_Construction 1.2.7.1
EnergyPlus_NoMass_Opaque_Material 1.2.7.2
EnergyPlus_Window_Material 1.2.7.3
Search_EP_Construction 1.2.7.4
Add_to_EnergyPlus_Library 1.2.7.5
Call_from_EP_Construction_Library 1.2.7.6
Decompose_EP_Construction 1.2.7.7
Decompose_EP_Material 1.2.7.8
4
EnergyPlus_Glass_Material 1.2.7.9
EnergyPlus_Opaque_Material 1.2.7.10
EnergyPlus_Shade_Material 1.2.7.11
EnergyPlus_Window_Air_Gap 1.2.7.12
R-Value_With_Air_Films 1.2.7.13
07 | Energy | Schedule 1.2.8
Annual_Schedule 1.2.8.1
Call_from_EP_Schedule_Library 1.2.8.2
Convert_EnergyPlus_Schedule_to_Values 1.2.8.3
Daily_Schedule 1.2.8.4
Constant_Schedule 1.2.8.5
Create_CSV_Schedule 1.2.8.6
Decompose_EnergyPlus_Schedule 1.2.8.7
Search_EP_Schedule_Library 1.2.8.8
Seasonal_Schedule 1.2.8.9
08 | Energy | Set Zone Properties 1.2.9
Set_EP_Zone_Construction 1.2.9.1
Set_EnergyPlus_Zone_Loads 1.2.9.2
Set_EnergyPlus_Zone_Schedules 1.2.9.3
Set_Loads_And_Schedules 1.2.9.4
AddEarthtube 1.2.9.5
Create_EP_Ground 1.2.9.6
Create_EP_Plenum 1.2.9.7
Honeybee_Lighting_Density_Calculator 1.2.9.8
Set_EP_Air_Flow 1.2.9.9
Set_EP_Surface_Construction 1.2.9.10
Set_EP_Zone_Interior_Construction 1.2.9.11
Set_EP_Zone_Underground_Construction 1.2.9.12
Set_EnergyPlus_Zone_Thresholds 1.2.9.13
Set_Zone_Properties 1.2.9.14
infORventPerArea_Calculator 1.2.9.15
09 | Energy | HVACSystems 1.2.10
Assign_HVAC_System 1.2.10.1
5
HVACSystemsList 1.2.10.2
HVAC_Air_Details 1.2.10.3
HVAC_Cooling_Details 1.2.10.4
HVAC_Heating_Details 1.2.10.5
Load_OpenStudio_Measure 1.2.10.6
Generator_PV 1.2.10.7
generationsystem 1.2.10.8
simple_Inverter 1.2.10.9
10 | Energy | Energy 1.2.11
Export_To_OpenStudio 1.2.11.1
_Run_Energy_Simulation 1.2.11.2
Add_Internal_Mass_to_Zone 1.2.11.3
EnergyPlus_Window_Shade_Generator 1.2.11.4
Honeybee_EP_context_Surfaces 1.2.11.5
Make_Adiabatic_By_Type 1.2.11.6
Energy_Simulation_Par 1.2.11.7
Generate_EP_Output 1.2.11.8
Lookup_EnergyPlus_Folder 1.2.11.9
Read_EP_Custom_Result 1.2.11.10
Read_EP_Result 1.2.11.11
Read_EP_Surface_Result 1.2.11.12
Read_HVAC_Sizing 1.2.11.13
Read_Result_Dictionary 1.2.11.14
Color_Surfaces_by_EP_Result 1.2.11.15
Color_Zones_by_EP_Result 1.2.11.16
Construct_Energy_Balance 1.2.11.17
Energy_Shade_Benefit_Evaluator 1.2.11.18
Adaptive_Comfort_Analysis_Recipe 1.2.11.19
Indoor_View_Factor_Calculator 1.2.11.20
Matrix_to_Data_Tree 1.2.11.21
Microclimate_Map_Analysis 1.2.11.22
Outdoor_Comfort_Analysis_Recipe 1.2.11.23
PET_Analysis_Recipe 1.2.11.24
PMV_Comfort_Analysis_Recipe 1.2.11.25
6
Read_Microclimate_Matrix 1.2.11.26
Thermal_Autonomy_Analysis 1.2.11.27
Visualize_Microclimate_Map 1.2.11.28
Apply_OpenStudio_Measure 1.2.11.29
Balance_Temperature_Calculator 1.2.11.30
Make_Adiabatic 1.2.11.31
Make_Adiabatic_by_Name 1.2.11.32
Normalize_Data_by_Floor_Area 1.2.11.33
OpenStudio_to_gbXML 1.2.11.34
Re-run_IDF 1.2.11.35
Re-run_OSM 1.2.11.36
Read_EP_HVAC_Result 1.2.11.37
Read_generation_system_results 1.2.11.38
ShadowPar 1.2.11.39
Simulation_Control 1.2.11.40
Surface_Data_Based_On_Type 1.2.11.41
Surface_Data_Based_On_Type_Detailed 1.2.11.42
gbXML_to_Honeybee 1.2.11.43
11 | THERM 1.2.12
Import_WINDOW_Glz_System 1.2.12.1
Write_THERM_File 1.2.12.2
Create_Therm_Boundaries 1.2.12.3
Create_Therm_Polygons 1.2.12.4
Assembly_Uvalue 1.2.12.5
Import_WINDOW_IDF_Report 1.2.12.6
Import_THERM_XML 1.2.12.7
Read_THERM_Result 1.2.12.8
Custom_Radiant_Environment 1.2.12.9
Therm_Material 1.2.12.10
Therm_Material_to_EnergyPlus_Material 1.2.12.11
Thermally_Bridged_EP_Construction 1.2.12.12
12 | Developers 1.2.13
Update_Honeybee 1.2.13.1
7
13 | WIP 1.2.14
Condensation_calculator 1.2.14.1
Import_idf 1.2.14.2
Customize_EnergyPlus_Objects 1.2.14.3
ExportEPC 1.2.14.4
Visualise_Honeybeegeneration_cashflow 1.2.14.5
8
What is this primer?
honeybee-primer
This primer is auto-generated from Grasshopper components. Feel free to edit the pages
and send a pull request. You can see the source of this primer on GitHub.
Honeybee for Grasshopper

Honeybee connects Grasshopper3D to EnergyPlus, Radiance, Daysim, OpenStudio and
Therm for building energy and daylighting simulation.
You need to have Ladybug installed in order to use Honeybee.
9
What is this primer?
Useful links
Ladybug Tools
Honeybee on Github
Honeybee group page on Grasshopper
Facebook page
Honeybee on Twitter
10
00 | Honeybee
Component list:
AskMe
Honeybee
Find_Non-Convex
IntersectMasses
SplitBuildingMass2Floors
SplitFloor2ThermalZones
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
Dump_Honeybee_Objects
Load_Honeybee_Objects
Mirror_Honeybee
Move_Honeybee
Rotate_Honeybee
Scale_Honeybee
Item_Selector
ChangeHBObjName
DecomposeHBZone
Extrude_Windows
Get_or_Set_HB_Object_Name
Glazing_Parameters_List
11
00 | Honeybee
OpenFileDirectory
PerimeterCoreZoning
Remove_Glazing
Select_by_Type
Separate_Zones_By_Floor
Separate_Zones_By_Orientation
Separate_Zones_By_Program
Separate_conditioned_and_unconditioned_zones
Skylight_Based_on_Ratio
orientHBGlz
12
AskMe
AskMe - [source code]
Use this component to get basic information on Honeybee Objects, whether they are HBSrfs
or HBZones. -
Inputs
HBObjects [Required]
Any valid Honeybee object.
Outputs
13
AskMe
readMe!
Information about the Honeybee object. Connect to a panel to visualize.
Check Hydra Example Files for AskMe
14
Honeybee
Honeybee - [source code]
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
15
Honeybee
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
16
Find_Non-Convex
Find Non-Convex - [source code]
In EnergyPlus, Solar distribution determines how EnergyPlus treats the beam solar radiation
and reflectances from exterior surfaces that strike the building, and ultimately, enter the
zone. There are five choices: MinimalShadowing, FullExterior and FullInteriorAndExterior,
FullExteriorWithReflections, FullInteriorAndExteriorWithReflections. If you intend to use
either of FullInteriorAndExterior, FullExteriorWithReflections,
FullInteriorAndExteriorWithReflections, you must make sure that all your zones are convex.
If you encounter a severe error saying, "DetermineShadowingCombinations: There are #
surfaces which are casting surfaces and are non-convex," you should find those non-convex
surface in your model and turn them into convex surfaces by splitting them. Spotting a non-
convex surface is quite easy. While this component is here to quickly help you detect non-
17
Find_Non-Convex
convex surfaces in your model, having conceptual understanding about what it means to
have a no-convex surface will make you aware of such surfaces while you are creating
zones. Following are a couple ways to eyeball a non-convex surface.
1. Imagine you’re drawing lines from one vertice of a surface to all other vertices of the
same surface and you’re doing this for all the vertices of the surface. Now if all those
lines fall totally inside the surface then it’s a convex surface. If any of the lines, or even
a part of it falls outside of the surface then it’s a non-convex surface. _
2. Imagine you are walking from one vertice of a surface to the next verice of the same
surface, and you are travelling to all the vertices of the surface like that. While making
this journey, you'll make turns. If all those turns that you took at vertices, are either
clockwise or counter-clockwise, then the surface is convex. If at least one of the turns
was in the opposite direction, meaning, if total number of turns you took were 6, and out
of those, 5 times you turned clockwise (or counter-clockwise) and one time you turned
counter-clockwise (or clockwise), then it is a non-convex surface. _
3. EnergyPlus displays severe error for non-convex zones. So if any of the face of the
zone is made of more than one planar surfaces, and none of those surfaces are non-
convex, however, if the resultant zone is not convex then EnergyPlus will still announce
a severe error. To address this, in addition to providing your breps as input to this
component, please also pass your breps through the native grasshopper Merge Faces
(FMerge) component. And then provide the output of FMerge component (Simplified
Brep) to the input of this component. _ Please visit the following link to know why
EnegyPlus does not like non-convex surfaces. http://bigladdersoftware.com/epx/docs/8-
2/input-output-reference/group-simulation-parameters.html#field-solar-distribution -
Inputs
breps [Required]
A list of breps that you wish to scan for non-convex surfaces
Outputs
readMe!
Messages
nonConvex
A list of non-convex surfaces, if found in breps provided.
faultyGeometry
18
Find_Non-Convex
A list of faultyGeometry if found in breps provided. Typically these are surfaces with
more edge curves than the visibale edges of the surface. If such surfaces are found in
your model, please use native grasshopper Deconstruct Brep component to analyze the
faultyGeometry.
Check Hydra Example Files for Find Non-Convex
19
IntersectMasses
IntersectMasses - [source code]
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 that
can be incorrect. As such, it is recommended that you bake the output of this component
20
IntersectMasses
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 adjacent
polysurfaces 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
21
SplitBuildingMass2Floors - [source code]
Use this component to divide up a brep (polysurface) representative of a complete building

massing into floors. This generic zoning will divide the input mass into seprate floors based
on an input floor height. 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 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
22
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 breaking 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 into floors, and can be used in
conjunction with the Honeybee_SplitBuildingFloor2ThermalZones component to genreate
core zone and perimeter zones. -
Inputs
bldgMasses [Required]
A Closed brep or list of closed breps representing a building massing.
bldgsFlr2FlrHeights [Required]
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.
runIt [Required]
Script input _runIt.
Outputs
readMe!
...
splitBldgFloors
A series of breps that correspond to inputted floor heights. These can be inserted into
the Honeybee_SplitBuildingFloor2ThermalZones component to further split the floors
into thermal zones for energy simulation.
23
Check Hydra Example Files for SplitBuildingMass2Floors
24
SplitFloor2ThermalZones - [source code]
Use this component to divide up a brep (polysurface) representative of a building floor into
smaller volumes that roughly correspond to how a generic EnergyPlus model should be
zoned. This zoning 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. Note: This component is intended mainly for convex geometry. Most concave
geometries will fail, and any shapes with holes in them will fail. You should therefore prepare
the massing of your building by dividing it into convex volumes before using this component.
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. Core and perimeter zoneing should work for almost all
25
masses where all walls are planar. 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 breaking 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
bldgFloors [Required]
A Closed brep or list of closed breps representing building floors. In this WIP only
convex geometries and very simple concave geometries will succeed. You should
prepare the massing of your building by dividing it into convex volumes before using this
component. You can use the Honeybee_SplitBuildingMass2Floors to generate floors
from a building mass.
perimeterZoneDepth [Required]
A number for perimeter depths in Rhino model units that will be used to divide up each
floor of the building into core and perimeter zones.
runIt [Required]
Outputs
readMe!
...
splitBldgZones
A series of breps that correspond to the recommended means of breaking up building

geometry into zones for energy simulations. All zones for each floor will have its own
list.
Check Hydra Example Files for SplitFloor2ThermalZones
26
27
Glazing based on ratio - [source code]
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.
28
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
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 ratios
based 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 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.
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 input
can 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
29
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.
EPConstructions [Optional]
A optional text string of an EnergyPlus construction name that sets the material
construction of the window. This input can also accept lists of values and will assign
different EPconstructions based on cardinal direction, starting with north and moving
counter-clockwise. The default will assign a generic double pane window without low-e
coatings.
RADMaterials [Optional]
A optional text string of an Radiance glass material name that sets the material of the
window. This input can also accept lists of values and will assign different RadMaterials
based on cardinal direction, starting with north and moving counter-clockwise.
runIt [Required]
set runIt to True to generate the glazing
Outputs
readMe!
...
30
HBObjWGLZ
Newhoneybee zones that contain glazing surfaces based on the parameters above.
Check Hydra Example Files for Glazing based on ratio
31
Masses2Zones
Masses2Zones - [source code]
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]
32
Masses2Zones
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 by
default.
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
33
Masses2Zones
assigned to them. Connect these to a "Honeybee_Label Zones" component to see

some of these properties.
Check Hydra Example Files for Masses2Zones
34
Solve_Adjacencies
Solve Adjacencies - [source code]
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]
35
Solve_Adjacencies
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.
altWindowConstr [Optional]
An optional alternate EP window construction to assign to all adjacent surfaces. The

default is set to be the "Interior Window" construction with a single pane of clear glass.
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
36
Solve_Adjacencies
37
addHBGlz
addHBGlz - [source code]
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
38
addHBGlz
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 list of EnergyPlus constructions 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. The list should match with
childSurfaces list. In case the list doesn't match the first construction will be used for all
surfaces.
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). The list should match with
childSurfaces list. In case the list doesn't match the first material will be used for all
surfaces.
Outputs
HBObjWGLZ
The Honeybee surface or zone with assigned glazing (in case of success).
Check Hydra Example Files for addHBGlz
39
createHBSrfs
createHBSrfs - [source code]
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
40
createHBSrfs
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
41
createHBZones
createHBZones - [source code]
Create an HBZone from HB Surfaces
Inputs
name [Required]
The name of the zone as a string
42
createHBZones
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
43
Decompose Based On Boundary Condition -

[source code]
Decompose zone surfaces by boundary condition -
Inputs
HBZone [Required]
Honeybee Zone
Outputs
44
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
45
Decompose Based On Type - [source code]
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.
46
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"
airWalls
A list of the air walls of your zones as breps. Connect to a Grasshopper "Preview"
windows
A list of windows of your zones as breps. Connect to a Grasshopper "Preview"

interiorWindows
A list of interior windows of your zones as breps. Connect to a Grasshopper "Preview"

skylights
A list of skylights of your zones as breps. Connect to a Grasshopper "Preview"

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"

floors
A list of floors of your zones as breps. Connect to a Grasshopper "Preview" component

to add color to the breps.
47
exposedFloors
A list of floors exposed to the outside air as breps. Connect to a Grasshopper "Preview"
groundFloors
A list of ground floors of your zones as breps. Connect to a Grasshopper "Preview"

undergroundWalls
A list of underground walls of your zones as breps. Connect to a Grasshopper "Preview"

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"

Check Hydra Example Files for Decompose Based On Type
48
Label_Zone_Surfaces
Label Zone Surfaces - [source code]
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
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
49
Label_Zone_Surfaces
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".
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
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
50
Label_Zone_Surfaces
51
Label_Zones
Label Zones - [source code]
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]
52
Label_Zones
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".
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.
zoneWireFrames
Check Hydra Example Files for Label Zones
53
Surface_Attribute_List
Surface Attribute List - [source code]
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
54
Zone_Attribute_List
Zone Attribute List - [source code]
Provides a list of preset values to choose from
Inputs
Check Hydra Example Files for Zone Attribute List
55
Dump Honeybee Objects - [source code]
Dump Honeybee Objects Use this component to dump Honeybee objects to a file on your
system. You can use load Honeybee objects to load the file to Grasshopper. WARNING:
This component does not write custom schedules or materials within the file but it does write
the names of the constructions and schedules. Accordingly, to properly load objects agian,
you must connect the full strings of these objects to a "Add to EnergyPlus Library"
component in any GH cript that loads the HBZones from the file. -
Inputs
56
A list of Honeybee objects
fileName [Required]
A name for the file to which HBObjects will be written (e.g. 20ZonesExample.HB).
workingDir [Default]
An optional working directory into which the HBZones will be written. The default is set
to C:\ladybug.
dump [Required]
Set to True to save the objects to file
Outputs
readMe!
...
filePath
The location of the file where the HBZones have been saved.
Check Hydra Example Files for Dump Honeybee Objects
57
Load Honeybee Objects - [source code]
Load Honeybee Objects Use this component to load Honeybee objects from a file on your
system. The valid files are created by dump Honeybee objects component. -
Inputs
filePath [Required]
A valid path to a file on your drive (e.g. c:\ladybug\20ZonesExample.HB)
load [Required]
58
Set to True to load the objects from the file
Outputs
readMe!
...
HBObjects
Script variable radOpaqueMaterial
Check Hydra Example Files for Load Honeybee Objects
59
Mirror_Honeybee
Mirror Honeybee - [source code]
Mirror Honeybee Objects -
Inputs
HBObj [Required]
Honeybee surface or Honeybee zone.
plane [Required]
Mirror plane.
60
Mirror_Honeybee
name [Default]
An optional text string that will be appended to the name of the transformed object(s). If
nothing is input here, a default unique name will be generated.
keepAdj [Optional]
Set to 'False' to remove existing adjacencies and boundary conditions (this is useful if
you plan to re-solve adjacencies after this component). If left blank or set to 'True', the
component will preserve adjacencies with other zones.
Outputs
HBObj
Transformed objects
Check Hydra Example Files for Mirror Honeybee
61
Move_Honeybee
Move Honeybee - [source code]
Move Honeybee Objects -
Inputs
HBObj [Required]
Honeybee surface or Honeybee zone
vector [Required]
Transform vector
62
Move_Honeybee
name [Default]
keepAdj [Optional]
Outputs
HBObj
Transformed objects
Check Hydra Example Files for Move Honeybee
63
Rotate_Honeybee
Rotate Honeybee - [source code]
Rotate Honeybee Objects -
Inputs
HBObj [Required]
angle [Required]
Angle of rotation in degrees
64
Rotate_Honeybee
cenPt [Optional]
Script variable moveHBObj
axis [Optional]
Optional rotation axis as a vector. Default is Z Axis
name [Default]
keepAdj [Optional]
Outputs
HBObj
Script variable moveHBObj
Check Hydra Example Files for Rotate Honeybee
65
Scale_Honeybee
Scale Honeybee - [source code]
Scale Honeybee Objects Non-Uniformly -
Inputs
HBObj [Required]
Honeybee surface or Honeybee zone
plane [Default]
Base Plane
66
Scale_Honeybee
X [Default]
Scaling factor in {x} direction
Y [Default]
Scaling factor in {y} direction
Z [Default]
Scaling factor in {z} direction
name [Default]
keepAdj [Optional]
Outputs
HBObj
Transformed objects
Check Hydra Example Files for Scale Honeybee
67
ChangeHBObjName
ChangeHBObjName - [source code]
Change Honeybee Object Names -
Inputs
names [Required]
List of new names for HBObjects
68
ChangeHBObjName
Outputs
HBObjects
Check Hydra Example Files for ChangeHBObjName
69
DecomposeHBZone
DecomposeHBZone - [source code]
Decompose Honeybee Zone -
Inputs
HBZone [Required]
Honeybee Zone
Outputs
70
DecomposeHBZone
HBSurfaces
Honeybee Surfaces
Check Hydra Example Files for DecomposeHBZone
71
Extrude_Windows
Extrude Windows - [source code]
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]
72
Extrude_Windows
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
73
Get or Set HB Object Name - [source code]
Change Honeybee Object Names -
Inputs
names [Optional]
List of new names for HBObjects
74
Outputs
HBObjects
Renamed Honeybee objects
names
Renamed Honeybee objects
Check Hydra Example Files for Get or Set HB Object Name
75
Glazing Parameters List - [source code]
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]
76
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
77
OpenFileDirectory
OpenFileDirectory - [source code]
Ues this component to Open a file/directory in windows explorer. This is particularly useful
for understanding where the results of Energy/Daylight simulations are located on your
system. - Args: _filePath: Either a File path or a Directory path that you want to open in
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.
Inputs
filePath [Required]
78
OpenFileDirectory
File path or Directory path
Outputs
ReadMe!
Check Hydra Example Files for OpenFileDirectory
79
PerimeterCoreZoning
PerimeterCoreZoning - [source code]
Separate zones into perimeter and core -
Inputs
HBZones [Required]
Outputs
80
PerimeterCoreZoning
perimeters
Script output perimeters.
interiors
Script output interiors.
Check Hydra Example Files for PerimeterCoreZoning
81
Remove_Glazing
Remove Glazing - [source code]
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...
82
Remove_Glazing
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
83
Select_by_Type
Select by Type - [source code]
Select surfaces by type -
Inputs
HBZones [Required]
Honeybee Zones
showWalls [Default]
Set to true to output the walls
84
Select_by_Type
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
85
Separate Zones By Floor - [source code]
Separate zones based on floor height -
Inputs
HBZones [Required]
List of HBZones
Outputs
86
floorHeights
List of floor heights
HBZones
Honeybee zones. Each branch represents a different floor
Check Hydra Example Files for Separate Zones By Floor
87
Separate Zones By Orientation - [source

code]
Separate zones based on orientation -
Inputs
HBZones [Required]
List of HBZones
onlyWGlz [Optional]
88
Only consider surfaces with glazing
Outputs
orientations
List of orientation vectors
HBZones
Honeybee zones. Each branch represents a different orientation
Check Hydra Example Files for Separate Zones By Orientation
89
Separate Zones By Program - [source code]
Separate zones based on zone program -
Inputs
HBZones [Required]
List of HBZones
Outputs
90
zonePrograms
List of programs
HBZones
Honeybee zones. Each branch represents a different program
Check Hydra Example Files for Separate Zones By Program
91
Separate conditioned and unconditioned

zones - [source code]
Separate zones into conditioned and unconditioned -
Inputs
HBZones [Required]
List of Honeybee zones
Outputs
92
conditionedZones
List of conditioned Honeybee zones
unconditionedZones
List of unconditioned Honeybee zones
Check Hydra Example Files for Separate conditioned and unconditioned zones
93
Skylight Based on Ratio - [source code]
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.
94
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
Honeybee thermal zones or surfaces for which glazing should be generated.
skyLightRatio [Required]
If you have input a full zone or roof surface 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.
EPConstruction [Optional]
A optional text string of an EnergyPlus construction name that sets the material
construction of the window. The default will assign a generic double pane window
without low-e coatings.
RADMaterial [Optional]
A optional text string of an Radiance glass material name that sets the material of the
window.
runIt [Required]
set runIt to True to generate the glazing
Outputs
95
readMe!
...
HBObjWGLZ
Newhoneybee zones that contain glazing surfaces based on the parameters above.
Check Hydra Example Files for Skylight Based on Ratio
96
orientHBGlz
orientHBGlz - [source code]
Use this component to set the orientation(s) of the glazing. -
Inputs
orientation [Required]
The orientation/s that you'd like to add glazing to.
ratio [Required]
The window to wall ratio.
97
orientHBGlz
Outputs
glzRatio
A list of glazing orientations that can be plugged into (glazingCreator).
Check Hydra Example Files for orientHBGlz
98
01 | Daylight | Material
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
99
Radiance Glass Material - [source code]
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]
100
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
101
Radiance Opaque Material - [source code]
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
Script input materialName.
102
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
Check Hydra Example Files for Radiance Opaque Material
103
Add to Radiance Library - [source code]
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
104
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
105
Call from Radiance Library - [source code]
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)
106
Outputs
materials
Script output materials.
Check Hydra Example Files for Call from Radiance Library
107
Radiance Materials Info - [source code]
Radiance Materials Info -
Inputs
Radiance material name
Outputs
108
RADMaterialStr
Radiance material definition
Check Hydra Example Files for Radiance Materials Info
109
Set Radiance Materials - [source code]
Radiance Default Materials -
Inputs
HBObject [Required]
List of Honeybee zones or surfaces
wallRADMaterial [Optional]
Optional wall material to overwrite the default walls
110
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
111
Radiance BSDF Material - [source code]
Radiance BSDF Material Create RADIANCE BSDF material -
Inputs
Name of material for the Radiance simulation.
XMLFilePath [Required]
File path to XML that contains the BSDF information.
112
upOrientation [Default]
An optional vector that sets the hemisphere that the BSDF material faces. For materials
that are symmetrical about the HBSrf plane (like non-angled venitian blinds), this can be
any vector that is not perfectly normal to the HBSrf. For asymmetrical materials like
angled veneitan blinds, this variable should be coordinated with the direction the HBSrfs
are facing. The default is set to (0.01, 0.01, 1.00), which should hopefully not be
perpendicular to any typical HBSrf.
thickness [Optional]
Optional parameter to set the thickness of the BSDF material. The default is set to 0.
Outputs
RADMaterial
Check Hydra Example Files for Radiance BSDF Material
113
Radiance Glass Material By Color - [source

code]
Radiance Glass Material By Color Read more here to understand Radiance materials:
Inputs
114
color [Required]
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
Check Hydra Example Files for Radiance Glass Material By Color
115
Radiance Metal Material - [source code]
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 >
Inputs
A unique name for material
116
roughness [Default]
Specularity values above 0.9 is typical for metal
Outputs
RADMaterial
Check Hydra Example Files for Radiance Metal Material
117
Radiance Metal Material By Color - [source

code]
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 >
Inputs
118
Material name
color [Required]
Material color
roughness [Default]
Specularity values above 0.9 is typical for metal
Outputs
RADMaterial
Check Hydra Example Files for Radiance Metal Material By Color
119
Radiance Mirror Material - [source code]
Radiance Mirror Material Read more here to understand Radiance materials:

Inputs
120
Outputs
RADMaterial
Check Hydra Example Files for Radiance Mirror Material
121
Radiance Mirror Material By Color - [source

code]
Radiance Mirror Material By Color Read more here to understand Radiance materials:
Inputs
122
color [Required]
color of the glass
Outputs
RADMaterial
Check Hydra Example Files for Radiance Mirror Material By Color
123
Radiance Opaque Material By Color - [source

code]
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 >
Inputs
124
Material name
color [Required]
Material color
roughness [Default]
Specularity values above 0.1 are uncommon
Outputs
avrgRef
Average diffuse reflectance of the material
RADMaterial
Check Hydra Example Files for Radiance Opaque Material By Color
125
Radiance Trans Material - [source code]
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
126
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
127
Radiance Trans Material By Color - [source

code]
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
128
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]
roughness [Default]
Outputs
transMaterial
Radiance Material Definition
Check Hydra Example Files for Radiance Trans Material By Color
129
02 | Daylight | Light Source
Component list:
Generate_Climate_Based_Sky
Generate_Cumulative_Sky
Generate_Standard_CIE_Sky
Watch_The_Sky
IES_Custom_Lamp
IES_Luminaire
IES_Luminaire_Zone
IES_Project
Generate_Average_Sky
Generate_Custom_Sky
Generate_Dark_Sky
Generate_Sky_With_Certain_Illuminance_level
130
Generate Climate Based Sky - [source code]
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).
131
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
132
Generate Cumulative Sky - [source code]
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://www.solemma.net/references/PLEA2004_RobinsonAndStone.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
133
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
Check Hydra Example Files for Generate Cumulative Sky
134
Generate Standard CIE Sky - [source code]
Genrate Standard CIE Sky -
Inputs
north [Optional]
135
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
Check Hydra Example Files for Generate Standard CIE Sky
136
Watch_The_Sky
Watch The Sky - [source code]
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
137
Watch_The_Sky
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
138
IES_Custom_Lamp
IES Custom Lamp - [source code]
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. - -
139
IES_Custom_Lamp
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.85
respectively. 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.
140
IES_Custom_Lamp
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!
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
141
IES_Luminaire
IES Luminaire - [source code]
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:
142
IES_Luminaire
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 will
help 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.
luminaireZone [Required]
List of (3-d coordinate, Aiming Angle) combinations that are generated through the IES
Luminaire Array component.
lightLossFactor [Default]
An optional number that will be multiplied by the luminosity of the light. This can be used
to account for different light bulb luminosities or light loss from additional fixture
obstructions around the light. The default is set to 1.0.
candelaMultiplier [Default]
Assign a scaling value for the candela tables. This value gets multiplied by the
lightLossFactor value. Default is set to 1.0.
customLumName [Default]
Specify a custom name for the luminaire. This input should only be used in case the
manufacturer hasn't provided a value for [LUMCAT] in the photometric data.
143
IES_Luminaire
customLamp [Optional]
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 inside the Ladybug
folder on your system.
writeRad [Required]
Set to True to create the file for electric lighting simulation.
Outputs
luminaireDetails
A description of the luminaire generated after parsing the IES file.
luminaireGeo
The geometry created in the Rhino viewport for visualizing the luminaire. Can be used
144
IES_Luminaire
for generating previews.
luminaireList
List of luminaires and their locations and mounting angles.
elecLightingData
Details about the luminaire, locations and lamps used in the simulation. Connect this
output to the _elecLightingData input of the Honeybee_IES Project component.
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. This
output will soon be deprecated. It is recommended that you use the elecLightingData
output instead.
Check Hydra Example Files for IES Luminaire
145
IES_Luminaire_Zone
IES Luminaire Zone - [source code]
This component is to be used for specifying the location of luminaires for electric li
ghting simulations.
-
For external lighting applications the best option would be to use the aimingPoint_ o
ption to specify where all the luminaires should be aimed to.
In case luminaires are being aimed by specifying spin, tilt and orientation angles, t
he following conventions apply:
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
146
IES_Luminaire_Zone
sequence of applying rotations is tilt,orientation and spin. _ The aiming conventions

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]
A number represeting the luminaire spin angle in degrees. This can also be a list of spin
angles that match the _ptsList.
tilt [Default]
A number represeting the luminaire tilt angle in degrees. This can also be a list of tilt
angles that match the _ptsList.
orientation [Default]
A number represeting the luminaire rotation angle in degrees. This can also be a list of
orientation angles that match the _ptsList.
aimingPoint [Optional]
A point represeting the location at which the photometric axis of the luminaires should
be aimed. This can also be a list of points that match the _ptsList.
customLamp [Optional]
A custom lamp definition from the "Honeybee_IES Custom Lamp" component.
Outputs
readMe!
luminaireZone
List of coordinates and rotation angles for luminaires
Check Hydra Example Files for IES Luminaire Zone
147
IES_Luminaire_Zone
148
IES_Project
IES Project - [source code]
This component is meant for summarizing the details of all the luminaires used in a
simulation.
Inputs
elecLightingData [Required]
Connect the elecLightingData output of the Honeybee_IES Luminaire component here.
outputsToExcel [Optional]
149
IES_Project
Set this input to True if the outputs are to be written to a MS Excel compatible .csv file.
excelFileLoc [Default]
Specify a directory to which the MS Excel file should be saved to.
Outputs
out
radFilePaths
List of .rad files corresponding to the luminaires to be used in the simulation. Connect
this to the additionalRadFiles_ input of Honeybee_Run Daylight Simulation component.
billOfQuantity
The bill of quantity of the luminaires used for simulation.
luminaireSchedule
List of luminaires, their location and aiming angles.
lumScheduleDetailed
A more detailed luminaire schedule that includes information about custom lamps (if
any) used in the simulation.
Check Hydra Example Files for IES Project
150
Generate Average Sky - [source code]
Generate Average Climate Based Sky This component generate an average climate based
data for a single hour during a month -
Inputs
north [Optional]
151
month [Required]
hour [Required]
Outputs
radiationValues
Average direct and diffuse radiation during the month for the input hour
skyFilePath
Check Hydra Example Files for Generate Average Sky
152
Generate_Custom_Sky
Generate Custom Sky - [source code]
Genrate Custom Sky This component generate a custom sky based on user's input -
Inputs
north [Optional]
153
Generate_Custom_Sky
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]
day [Required]
Day of the study [1-31]
hour [Required]
Outputs
skyFilePath
Check Hydra Example Files for Generate Custom Sky
154
Generate_Dark_Sky
Generate Dark Sky - [source code]
This component generates a dark sky with 0 illuminance. It's useful for lighting (and not
daylighting) simulation with honeybee. -
Inputs
Outputs
skyFilePath
155
Generate_Dark_Sky
Check Hydra Example Files for Generate Dark Sky
156
Generate Sky With Certain Illuminance level -

[source code]
Genrate a Uniform CIE Sky Based on Illuminace Value -
Inputs
illuminanceValue [Required]
Desired value for horizontal sky illuminance in Lux
Outputs
157
skyFilePath
Check Hydra Example Files for Generate Sky With Certain Illuminance level
158
03 | Daylight | Recipes
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
Ambient_Resolution
Conceptual_Dynamic_Shading_Recipe
Daysim_Glare_Control_Recipe
Daysim_Shading_State
Generate_Zone_Test_Points
159
Annual Daylight Simulation - [source code]
Analysis Recipe for Annual Daylighting Simulation -
Inputs
north [Optional]
160
epwWeatherFile [Required]
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
161
Daylight Factor Simulation - [source code]
Analysis Recipie for Daylight Factor Analysis -
Inputs
Test points
Point vectors
162
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
Radiance parameters
Outputs
analysisRecipe
Recipe for daylight factor analysis
Check Hydra Example Files for Daylight Factor Simulation
163
Generate Test Points - [source code]
Genrate Test Points -
Inputs
testGeometry [Required]
Test surface as a Brep.
gridSize [Required]
Size of the test grid.
164
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
165
Grid Based Simulation - [source code]
Analysis Recipie for Grid-Based Analysis -
Inputs
skyFile [Required]
Test points
166
Point vectors
testMesh [Optional]
Script variable gridBasedSimulation
simulationType [Default]
[0] illuminance(lux), [1] radiation (kwh), [2] luminance (Candela)
Radiance parameters
Outputs
analysisRecipe
Recipe for grid-based analysis
Check Hydra Example Files for Grid Based Simulation
167
Image Based Simulation - [source code]
Analysis Recipie for Image-Based Analysis -
Inputs
skyFile [Required]
rhinoViewsName [Default]
viewName to be rendered
168
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
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
169
Vertical Sky Component - [source code]
Analysis Recipie for Vertical Sky Component, which is typically used to evaluate daylight and
sky access in urban areas. The Vertical Sky Component (VSC) is described by the UK
Building Research Establishment (BRE) as the ratio of the direct sky illuminance falling on
the vertical wall at a reference point, to the simultaneous horizontal illuminance under an
unobstructed sky [Littlefair, 1991]. It also states that the Standard CIE Overcast Sky model is
to be used for the sky illuminance distribution. This means that the reference value for the
VSC percentage is effectively the unobstructed horizontal sky component. The calculation
performed by this component comes from this discussion on the RADIANCE forum:
http://www.radiance-online.org/pipermail/radiance-general/2006-September/004017.html -
170
Inputs
Test points
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
171
DSParameters
DSParameters - [source code]
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]
172
DSParameters
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
173
RADParameters
RADParameters - [source code]
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]
174
RADParameters
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 ambient

divisions 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!
radParameters
Script output radParameters.
Check Hydra Example Files for RADParameters
175
RADParameters
176
Advanced Dynamic Shading Recipe -

[source code]
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
177
shading_state1 []
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
178
Ambient_Resolution
Ambient Resolution - [source code]
Use this component to calculate the ambient resoluation (ar) needed to resolve a detail of a
diven dimension in Rhino model units. The full geometry scene of HBObjects is needed to
calculate this number accurately The resulting ar from this component can be plugged into
the Honeybee_RADParameters component. -
Inputs
All of the Honeybee objects that are going to be used in the daylight simulation.
179
Ambient_Resolution
minDetailDim [Required]
A number in Rhino model units that represents the dimension of the smallest detail that
must be resolved in the daylight simulation.
aa [Default]
An optional number for Ambient Accuracy. This value should be matched between this
component and the Honeybee_RADParameters component. If no value is input here, a
default of 0.25 will be used, which is the default low-resolution value for aa.
Outputs
ar
The abmient resolution needed to resolve a detail of the input _minDetailDim. This can
be plugged into the Honeybee_RADParameters component.
Check Hydra Example Files for Ambient Resolution
180
Conceptual Dynamic Shading Recipe -

[source code]
Conceptual Shading Recipe for Annual Simulation with Daysim You need to add sensor
points later in the Daysim result reader. -
Inputs
Outputs
dynamicShadingGroup
181
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
182
Daysim Glare Control Recipe - [source code]
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
183
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
184
Daysim Shading State - [source code]
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
185
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
186
Generate Zone Test Points - [source code]
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
187
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
188
04 | Daylight | Daylight
Component list:
Glare_Analysis
Run_Daylight_Simulation
Import_rad
ReadAnnualResultsIII
Read_Annual_Result_I
Read_Annual_Result_II
Read_RAD_Result
Convert_HDR_to_GIF
FalseColor
Import_Pts_File
Lookup_Daylighting_Folder
Daysim_Occupancy_Generator
Daysim_Occupancy_Generator_Based_On_List
Daysim_shading_group_sensors
Lighting_control_Recipe
Convert_HDR_to_TIF
Convert_IMG
Convert_TIF_to_HDR
Daysim_Annual_Profiles
Daysim_Electrical_Lighting_Use
Import_dgp_File
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
189
Glare_Analysis
Glare Analysis - [source code]
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]
190
Glare_Analysis
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.
DGI
Daylight glare index
glareComfortRange
Comfort Ranges. Imperceptible Glare [0.35 > DGP], Perceptible Glare [0.4 > DGP >=
0.35], Disturbing Glare [0.45 > DGP >= 0.4], Intolerable Glare [DGP >= 0.45]
imageWithTaskArea
Path to HDR image with task area marked with blue circle
Check Hydra Example Files for Glare Analysis
191
Run Daylight Simulation - [source code]
export geometries to rad file, and run daylighting/energy simulation -
Inputs
List of Honeybee objects
analysisRecipe [Required]
An analysis recipe
192
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
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
193
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
resultFiles
Script variable runDaylightAnalysis
radGeoFile
studyFolder
done
True if the study is over
Check Hydra Example Files for Run Daylight Simulation
194
Import_rad
Import rad - [source code]
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
195
Import_rad
RADMaterials
List of materials
RADSurfaces
List of surfaces
Check Hydra Example Files for Import rad
196
ReadAnnualResultsIII - [source code]
read the annual ill files very fast!! Please find the source code from:
https://github.com/MingboPeng/Ironbug
Inputs
illFilesAddress [Required]
A list of .ill files generated by Radiance
workingHours [Default]
197
a list of hours in 24H pormat, by default is from 8 - 18 (LEED v4)
minThreshold []
Default 300lux.
maxThreshold []
Default 0 (infinity).
Outputs
lessThanRange
% of total hours that is less than the minimum threshold
inTheRange
% of total hours that is between the minimum and maximum threshold
moreThanRange
% of total hours that is larger than the maximum threshold
CDA
% of total hours that is between the minimum and maximum threshold, with partial
credits
Check Hydra Example Files for ReadAnnualResultsIII
198
Read Annual Result I - [source code]
Read Annual Daylight Results I [Standard Daysim Results] -
Inputs
List of .ill files
List of 3d Points
199
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.
200
UDLI_100_2000
the test point receives between 100 and 2000 lux.
UDLI_More_2000
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
201
Read Annual Result II - [source code]
Read Annual Daylight Results II [Daysim] -
Inputs
resultFilesAddress []
List of .ill files
testPts []
List of 3d Points
202
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
203
Read_RAD_Result
Read RAD Result - [source code]
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
204
Read_RAD_Result
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
205
Convert_HDR_to_GIF
Convert HDR to GIF - [source code]
Convert HDR to GIF -
Inputs
HDRFilePath [Required]
adjustExposure [Optional]
"Mimic human visual response in the output. The goal of this process is to produce
206
Convert_HDR_to_GIF
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
207
FalseColor
FalseColor - [source code]
False Color -
Inputs
legendUnit [Optional]
Unit of the legend (e.g. lux, cd/m2,...)
208
FalseColor
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 contour lines.
contourBands [Optional]
Set to True ro render the image with solid-colored contour regions.
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
209
FalseColor
Check Hydra Example Files for FalseColor
210
Import_Pts_File
Import Pts File - [source code]
Import Radiance Test Grid -
Inputs
ptsFileAddress [Required]
Script input resultFileAddress.
Outputs
211
Import_Pts_File
points
Script output monthlyHeating.
vectors
Script variable readIdf
Check Hydra Example Files for Import Pts File
212
Lookup Daylighting Folder - [source code]
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]
213
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)
resultFiles
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
materialFiles
214
skyFiles
octFiles
dgpFiles
annualProfiles
A .csv file generated by Daysim that can be used as an schedule for annual daylight
simulation
htmReport
analysisMesh
Check Hydra Example Files for Lookup Daylighting Folder
215
Daysim Occupancy Generator - [source

code]
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
216
component to generate the input. Default is all year between 9 to 5.
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
217
Daysim Occupancy Generator Based On List

- [source code]
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
218
occValues [Required]
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
219
Daysim shading group sensors - [source

code]
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.
220
exteriorSensors [Optional]
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
221
Lighting control Recipe - [source code]
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
222
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
223
Convert_HDR_to_TIF
Convert HDR to TIF - [source code]
Convert HDR to TIF -
Inputs
adjustExposure [Optional]
"Mimic human visual response in the output. The goal of this process is to produce
224
Convert_HDR_to_TIF
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
225
Convert_IMG
Convert IMG - [source code]
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"
226
Convert_IMG
Outputs
convertedFilePath
New file path
Check Hydra Example Files for Convert IMG
227
Convert_TIF_to_HDR
Convert TIF to HDR - [source code]
Convert HDR to TIF -
Inputs
TIFFFilePath [Required]
Outputs
228
Convert_TIF_to_HDR
HDRFilePath
Check Hydra Example Files for Convert TIF to HDR
229
Daysim Annual Profiles - [source code]
Read Daysim Annual Profiles -
Inputs
annualProfiles [Required]
Address to a valid *_intgain.csv generated by daysim.
Outputs
230
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
231
Daysim Electrical Lighting Use - [source

code]
Daysim's electrical lighting use -
Inputs
htmlReport [Required]
Address to a valid .htm file generated by daysim.
Outputs
232
electricLightingUse
Lists of annual occupancy profiles if any
Check Hydra Example Files for Daysim Electrical Lighting Use
233
Import_dgp_File
Import dgp File - [source code]
Import Annual Daylight Glare Probability -
Inputs
dgpFile [Required]
Annual Daylight glare probability file
Outputs
234
Import_dgp_File
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
235
MSH2RAD
MSH2RAD - [source code]
Convert a mesh to RAD file -
Inputs
mesh [Required]
List of meshes
Full string of rad material as the base material
236
MSH2RAD
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
237
Read All the Hourly Results from Annual

Daylight Study - [source code]
Read the results of the annual study for a all the hours of the year for all the points -
Inputs
List of .ill files
238
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
239
Read DS Result for a point - [source code]
Read Daysim result for a test point -
Inputs
List of .ill files
List of 3d Points
240
targetPoint [Required]
One of the points from the test points
Outputs
annualIllumNoDynamicSHD
annualIllumDynamicSHDGroupI
annualIllumDynamicSHDGroupII
Check Hydra Example Files for Read DS Result for a point
241
Read Hourly Results from Annual Daylight

Study - [source code]
Read the results of the annual study for a single hour of the year -
Inputs
List of .ill files
242
List of 3d Points
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
shadingGroupInEffect
0: no blind, 1: shading group I, 2: shading group II
Check Hydra Example Files for Read Hourly Results from Annual Daylight Study
243
Refine Daylight Simulation - [source code]
Refine simulation for an existing Radiance scene (.oct file) -
Inputs
octFile [Required]
analysisRecipe [Required]
An analysis recipe
244
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]
Outputs
readMe!
results
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
245
Set Exposure for HDR - [source code]
Set Exposure for HDR -
Inputs
exposure [Default]
A number between 0 and 1
246
render [Required]
Set to True to render the new image
Outputs
outputFilePath
Check Hydra Example Files for Set Exposure for HDR
247
05 | Energy | Building Program
Component list:
ListZonePrograms
bldgPrograms
Get_EnergyPlus_Loads
Get_EnergyPlus_Schedules
Get_Zone_EnergyPlus_Loads
Get_Zone_EnergyPlus_Schedules
248
ListZonePrograms
ListZonePrograms - [source code]
Find list of spaces for each space based on program -
Inputs
bldgProgram [Required]
An index number for
Outputs
249
ListZonePrograms
zonePrograms
Honeybee zones in case of success
Check Hydra Example Files for ListZonePrograms
250
bldgPrograms
bldgPrograms - [source code]
Provides a list of available building programs from the template
Inputs
Check Hydra Example Files for bldgPrograms
251
Get EnergyPlus Loads - [source code]
Look up loads for an specific bldgProgram and zoneProgram -
Inputs
zoneProgram [Required]
Script input _zoneProgram.
Outputs
252
equipmentLoadPerArea
infiltrationRatePerArea
lightingDensityPerArea
numOfPeoplePerArea
numOfPeoplePerArea
ventilationPerArea
ventilationPerArea
ventilationPerPerson
Check Hydra Example Files for Get EnergyPlus Loads
253
Get EnergyPlus Schedules - [source code]
Look up schedules for an specific bldgProgram and zoneProgram -
Inputs
zoneProgram [Required]
Outputs
254
occupancySchedule
occupancySchedule
occupancyActivitySch
Script variable LookupSchedules
heatingSetPtSchedule
coolingSetPtSchedule
lightingSchedule
lightingSchedule
equipmentSchedule
equipmentSchedule
infiltrationSchedule
Check Hydra Example Files for Get EnergyPlus Schedules
255
Get Zone EnergyPlus Loads - [source code]
Look up loads for a Honeybee Zone -
Inputs
HBZone [Required]
Outputs
256
Per m^2
Per m^2
Per m^2
numOfPeoplePerArea
Per m^2
ventilationPerArea
m3/s.m2
m3/s.person
Check Hydra Example Files for Get Zone EnergyPlus Loads
257
Get Zone EnergyPlus Schedules - [source

code]
Look up schedules for a Honeybee Zone -
Inputs
HBZone [Required]
Honeybee zone
Outputs
258
occupancySchedule
occupancySchedule
occupancyActivitySch
Script variable LookupSchedules
lightingSchedule
lightingSchedule
equipmentSchedule
equipmentSchedule
Check Hydra Example Files for Get Zone EnergyPlus Schedules
259
06 | Energy | Material | Construction
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
260
EnergyPlus Construction - [source code]
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
261
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
262
EnergyPlus NoMass Opaque Material -

[source code]
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. -
263
Inputs
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]
A number representing the R-Value of the material in m2-K/W.
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
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
264
EnergyPlus Window Material - [source code]
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
265
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 U-value of the window in W/m2-K. This is the rated (NFRC)
U-value under winter heating conditions. As a result, the U-Value input here should
include the air films for a vertically-mounted product.
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

Check Hydra Example Files for EnergyPlus Window Material
266
Search EP Construction - [source code]
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]
267
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
268
Add to EnergyPlus Library - [source code]
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
269
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
270
Call from EP Construction Library - [source

code]
Call from EP Library -
Inputs
keywords [Optional]
List of keywords to filter the list of materials
Outputs
271
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
272
Decompose EP Construction - [source code]
Decompose EnergyPlus Construction -
Inputs
cnstrName [Required]
EnergyPlus construction name
Outputs
273
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. Note that this U-value does not include the
resistance of air films on either side of the construction and this resistance is typically
included in U-values used by manufacturers. Use the "Honeybee_R-Value With Air
Films" component to account for these air films.
UValue_IP
U-value of the construction in Btu/h·ft2·°F. Note that this U-value does not include the
resistance of air films on either side of the construction and this resistance is typically
included in U-values used by manufacturers. Use the "Honeybee_R-Value With Air
Films" component to account for these air films.
RValue_SI
R-value of the construction in m2-K/W.
RValue_IP
R-value of the construction in h·ft2·°F/Btu.
Check Hydra Example Files for Decompose EP Construction
274
Decompose EP Material - [source code]
Decompose EnergyPlus Material -
Inputs
EnergyPlus material name
Outputs
275
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
RValue_IP
Check Hydra Example Files for Decompose EP Material
276
EnergyPlus Glass Material - [source code]
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]
277
A text name for your glass material.
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 the
glass 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.
frontEmissivity [Optional]
A number between 0 and 1 that represents the infrared hemispherical emissivity of the
front (outdoor-facing) side 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.
backEmissivity [Optional]
A number between 0 and 1 that represents the infrared hemispherical emissivity of the
back (indoor-facing) side 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
278
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.
Outputs
EPMaterial
A glass material that can be plugged into the "Honeybee_EnergyPlus Construction"

component.
Check Hydra Example Files for EnergyPlus Glass Material
279
EnergyPlus Opaque Material - [source code]
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
280
name [Required]
A text name for your Opaque Material.
roughness [Default]
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
visAbsp [Default]
An number between 0 and 1 that represents the abstorptance of visible light by the
281
Outputs
EPMaterial
An opaque material that can be plugged into the "Honeybee_EnergyPlus Construction"

component.
Check Hydra Example Files for EnergyPlus Opaque Material
282
EnergyPlus Shade Material - [source code]
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
283
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.
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
284
EnergyPlus Window Air Gap - [source code]
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
285
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
Check Hydra Example Files for EnergyPlus Window Air Gap
286
R-Value With Air Films - [source code]
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
287
"Honeybee_Decompose EP Material."
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
UValue_IP_wAir
RValue_SI_wAir
RValue_IP_wAir
Check Hydra Example Files for R-Value With Air Films
288
07 | Energy | Schedule
Component list:
Annual_Schedule
Call_from_EP_Schedule_Library
Convert_EnergyPlus_Schedule_to_Values
Daily_Schedule
Constant_Schedule
Create_CSV_Schedule
Decompose_EnergyPlus_Schedule
Search_EP_Schedule_Library
Seasonal_Schedule
289
Annual_Schedule
Annual Schedule - [source code]
Use this component to generate schedules that can be assigned to HBZones. -
Inputs
sun [Required]
Sunday. Connect a list of 24 values that represent the schedule value at each hour of
the day.
mon [Required]
290
Annual_Schedule
Monday. Connect a list of 24 values that represent the schedule value at each hour of
the day.
tue [Required]
Tuesday. Connect a list of 24 values that represent the schedule value at each hour of
the day.
wed [Required]
Wednesday. Connect a list of 24 values that represent the schedule value at each hour
of the day.
thu [Required]
Thursday. Connect a list of 24 values that represent the schedule value at each hour of
the day..
fri [Required]
Friday. Connect a list of 24 values that represent the schedule value at each hour of the
day.
sat [Required]
Saturday. Connect a list of 24 values that represent the schedule value at each hour of
the day.
holiday [Optional]
Optional input for holidays. Connect a list of 24 values that represent the schedule value
at each hour of the day. If no value is input here, the schedule for Sunday will be used
for all holidays.
coolDesignDay [Optional]
Optional input for the cooling design day that is used to size the system. Connect a list
of 24 values that represent the schedule value at each hour of the day. If no value is
input here, the schedule for Monday will be used for the cooling design day.
heatDesignDay [Optional]
Optional input for the heating design day that is used to size the system. Connect a list
of 24 values that represent the schedule value at each hour of the day. If no value is
input here, the schedule for Sunday will be used for the heating design day.
291
Annual_Schedule
scheduleName [Required]
A text string representing a name for the schedule that this component will create. This
name should be unique among the schedules in your Grasshopper document to ensure
that you do not overwrite other schedules.
schedTypeLimits [Default]
A text string from the scheduleTypeLimits output of the "Honeybee_Call From EP

Schedule Library" component. This value represents the units of the schedule input
values. The default is "Fractional" for a schedule with values that range between 0 and
1. Other common inputs include "Temperature", "On/Off", and "ActivityLevel".
runIt [Required]
Set to "True to write the schedule to the Honeybee library such that you can assign the
schedule with other Honeybee components.
Outputs
readMe!
...
schedule
The name of the schedule that has been written to the memory of the GH document.
Connect this to any shcedule input of a Honeybee component to assign the schedule.
weekSched
The name of the weekly schedule that has been written to the memory of the GH
document. If your final intended annual schedule is seasonal (composed of different
weekly schedules), you can use this output with the "Honeybee_Seasonal Schedule" to
create such schedules.
schedIDFText
The text needed to tell EnergyPlus how to run the schedule. If you are done
creating/editing a shcedule with this component, you may want to make your GH
document smaller by internalizing this IDF text and using the "Honeybee_Add To
EnergyPlus Library" component to add the schedule to the memory the next time you
open the GH file. Then you can delete this component.
Check Hydra Example Files for Annual Schedule
292
Annual_Schedule
293
Call from EP Schedule Library - [source

code]
Call from EP Schedule Library -
Inputs
keywords [Optional]
List of keywords to filter the list of schedules
Outputs
294
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
295
Convert EnergyPlus Schedule to Values -

[source code]
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
296
weekStartDay [Default]
An integer or text descriptor to set the schedule start day of the week. The default is set
to 0 - sun - sunday. - Choose from one of the following: 0 - sun - sunday 1 - mon -
monday 2 - tue - tuesday 3 - wed - wednesday 4 - thu - thursday 5 - fri - friday 6 - sat -
saturday
epwFileForHol [Optional]
The file address of an EPW file on your system. This component will automatically look
up the national holidays of the country listed in the epw file and factor them into the
output "values".
customHol [Optional]
Connect a list of DOYs (from 1 to 365) or a list of strings (example: DEC 25). - These
will be added to any holidays in the epwFile holidays (if connected).
Outputs
values
Hourly values that define the schedule.
holidays
Holidays that have been incorporated into the hourly values of the schedule. Connect
these to the 'holidays' output of the "Honeybee_Energy Simulation Par" component to
have them factored into the simulation.
Check Hydra Example Files for Convert EnergyPlus Schedule to Values
297
Daily_Schedule
Daily Schedule - [source code]
Use this component to make daily schedules for "Honeybee_AnnualSchedule". This

component works with the native Grasshopper Gene Pool. -
Inputs
genePool [Required]
Input Galapagos Gene Pool
button [Required]
298
Daily_Schedule
Connect a button (Params/Input)
template [Optional]
Choose one of the templates: - 0 - minimum values from 1:00 to 6:00 and from 23:00 to
24:00 maximum values from 7:00 to 22:00 - 1 - minimum values from 7:00 to 22:00
maximum values from 1:00 to 6:00 and from 23:00 to 24:00 - 2 - minimum values from
1:00 to 24:00 - 3 - maximum values from 1:00 to 24:00
overwriteValues [Optional]
Change the maximum and minimum values of the template without modifying the
schedule range. - Connect a list of two numbers.
lowBound [Optional]
A number representing the lower boundary of the schedule range. The default is set to
0.
highBound [Optional]
A number representing the higher boundary of the schedule range. The default is set to
1.
Outputs
readMe!
...
Check Hydra Example Files for Daily Schedule
299
Constant_Schedule
Constant Schedule - [source code]
Use this component to generate a schedule with a constant value or a schedule with 24
values that repeat in the same 24-hour pattern every day. -
Inputs
value [Required]
A value or list of 24 values that will be repeated for every day of the year.
300
Constant_Schedule
A text string representing a name for the schedule that this component will create. This
name should be unique among the schedules in your Grasshopper document to ensure
that you do not overwrite other schedules.
A text string from the scheduleTypeLimits output of the "Honeybee_Call From EP

Schedule Library" component. This value represents the units of the schedule input
values. The default is "Fractional" for a schedule with values that range between 0 and
1. Other common inputs include "Temperature", "On/Off", and "ActivityLevel".
Outputs
readMe!
...
schedule
weekSched
The name of the weekly schedule that has been written to the memory of the GH
document. If your final intended annual schedule is seasonal (composed of different
weekly schedules), you can use this output with the "Honeybee_Seasonal Schedule" to
create such schedules.
schedIDFText
Check Hydra Example Files for Constant Schedule
301
Create_CSV_Schedule
Create CSV Schedule - [source code]
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.
302
Create_CSV_Schedule
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.
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
303
Decompose EnergyPlus Schedule - [source

code]
Decompose Schedule -
Inputs
schName [Optional]
Schedule name
Outputs
304
name
name
schedule
schedule
comments
comments
Check Hydra Example Files for Decompose EnergyPlus Schedule
305
Search EP Schedule Library - [source code]
Filter EP Schedule Library -
Inputs
scheduleList [Required]
Script input scheduleList.
zoneProgram [Optional]
Script input zoneProgram.
306
scheduleType [Optional]
Script input scheduleType.
Outputs
selSchedules
Script output selSchedule.
Check Hydra Example Files for Search EP Schedule Library
307
Seasonal_Schedule
Seasonal Schedule - [source code]
Use this component to generate a seasonal schedule (aka. a schedule composed of

different weekly schedules). Using the weekSched outputs of the other schedule generating
components, you can combine these to create a yearly schedule that has different week
schedules for different times of the year. -
Inputs
A name for the schedule that this component will create. This name should be unique
308
Seasonal_Schedule
among the schedules in your Grasshopper document to ensure that you do not
overwrite other schedules.
A text string from the scheduleTypeLimits output of the 'Honeybee_Call From EP

Schedule Library' component. This value represents the units of the schedule input
values. The default is 'Fractional' for a schedule with values that range between 0 and
1. Other common inputs include 'Temperature', 'On/Off', and 'ActivityLevel'.
baseWeekSched [Required]
A text string represeting the name of a weekly schedule to use for any parts of the year
not specified in the analysisPeriods below. Such weekly schedules are output from
either the 'Honeybee_Constant Schedule' or the 'Honeybee_Annual Schedule'
components.
seasonWeekSched1 [Required]
A text string represeting the name of a weekly schedule to use for analysisPeriod1
below. Such weekly schedules are output from either the "Honeybee_Constant
Schedule" or the "Honeybee_Annual Schedule" components.
analysisPeriod1 [Required]
An analysis period from the LadybugAnalysis Period that specifies when the
seasonWeekSched1 above is active.
Outputs
readMe!
...
schedule
schedIDFText
309
Seasonal_Schedule
Check Hydra Example Files for Seasonal Schedule
310
08 | Energy | Set Zone Properties
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
Set_EP_Air_Flow
Set_EP_Surface_Construction
Set_EP_Zone_Interior_Construction
Set_EP_Zone_Underground_Construction
Set_EnergyPlus_Zone_Thresholds
Set_Zone_Properties
infORventPerArea_Calculator
311
Set EP Zone Construction - [source code]
Update EP construction of zone based on type -
Inputs
HBZones [Required]
Honeybee zones
wallEPConstruction [Optional]
Optional new construction for walls
312
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
modifiedHBZones
Honeybee zone with updated constructions
Check Hydra Example Files for Set EP Zone Construction
313
Set EnergyPlus Zone Loads - [source code]
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]
314
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).
ASHRAE recommends the following general infiltration rates based on the area of the
facade exposed to the outdoors (note that you have to use the
"Honeybee_infOrVentPerArea" to convert): 0.0001 (m3/s per m2 facade) - Tight building
0.0003 (m3/s per m2 facade) - Average building 0.0006 (m3/s per m2 facade) - Leaky
building
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.
315
recirculatedAirPerArea [Optional]
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
316
Set EnergyPlus Zone Schedules - [source

code]
Use this component to change the schedules of your HBZones. -
Inputs
HBZones [Required]
HBZones for which you want to change shcedules.
occupancySchedules [Optional]
317
A text string representing the occupancy shceudle that you want to use. This can be
either a shcedule from the "Honeybee_Call from EP Schedule Library" component, a
schedule from the "Honeybee_Annual Schedule" component, or a CSV schedule from
the "Honeybee_Create CSV Schedule" component.
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 "HoneybeeCall from EP Schedule
Library" component, a schedule from the "Honeybee_Annual Schedule" component, or
a CSV schedule from the "Honeybee_Create CSV Schedule" component. If this is a
custon schedule, the values in it should be Watts and the "units" or "schedTypeLimits"
input should be "ActivityLevel."
heatingSetPtSchedules [Optional]
A text string representing the heating setpoint shceudle that you want to use. This can
be either a shcedule from the "HoneybeeCall from EP Schedule Library" component, a
the "Honeybee_Create CSV Schedule" component. If this is a custon schedule, the
values in it should be Watts and the "units" or "schedTypeLimits" input should be
"Temperature."
coolingSetPtSchedules [Optional]
A text string representing the cooling setpoint shceudle that you want to use. This can
be either a shcedule from the "HoneybeeCall from EP Schedule Library" component, a
the "Honeybee_Create CSV Schedule" component. If this is a custon schedule, the
values in it should be Watts and the "units" or "schedTypeLimits" input should be
"Temperature."
lightingSchedules [Optional]
A text string representing the lighting shceudle that you want to use. This can be either
a shcedule from the "Honeybee_Call from EP Schedule Library" component, a schedule
from the "Honeybee_Annual Schedule" component, or a CSV schedule from the
"Honeybee_Create CSV Schedule" component.
equipmentSchedules [Optional]
A text string representing the equipment shceudle that you want to use. This can be
318
infiltrationSchedules [Optional]
A text string representing the infiltration shceudle that you want to use. This can be
ventilationSchedules [Optional]
A text string representing the ventilation shceudle that you want to use. Note that this
schedule overrides the typical ventilation that occurs based on the occupancy shcedule
and the "ventilationPerPerson." The ventilation will be hard-sized based on this
schedule and the maximum combined flowrates of "ventilationPerPerson" and
"ventilationPerarea." This can be either a shcedule from the "Honeybee_Call from EP
Schedule Library" component, a schedule from the "Honeybee_Annual Schedule"
component, or a CSV schedule from the "Honeybee_Create CSV Schedule"
component.
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
319
Set Loads And Schedules - [source code]
Set schedules and loads for zones based on program -
Inputs
HBZones [Required]
A HBZone or list of HBZones for which you want to change the program (including
schedules and loads).
zonePrograms [Optional]
320
The zone program that you want to assign to the HBZones. This should be a value from
the "Honeybee_ListZonePrograms" component. This input can also be a list of
programs tha aligns with the input HBZones.
Outputs
currentSchedules
The schedules that have been assigned to the zones.
currentLoads
The loads that have been assigned to the zones
HBZones
HBZones that have had their program set to the input zonePrograms_.
Check Hydra Example Files for Set Loads And Schedules
321
AddEarthtube
AddEarthtube - [source code]
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
322
AddEarthtube
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 be
added 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
323
AddEarthtube
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]
_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]
_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]
_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
324
AddEarthtube
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]
_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 0.7 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]
_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]
_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
325
AddEarthtube
along the earth tube.
pipeLengths [Default]
_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]
_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 in
determining 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 is
a value of 8 the default is 1 - Bare and wet.
pipeThermalConductivity [Default]
_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
326
AddEarthtube
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
327
Create_EP_Ground
Create EP Ground - [source code]
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. All
values for soil type are taken from the Engineering Toolbox, specifically these pages below...
328
Create_EP_Ground
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 - Mud
or 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
329
Create_EP_Plenum
Create EP Plenum - [source code]
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.
conditioned [Optional]
330
Create_EP_Plenum
Set to 'True' if the plenum is active or is conditioned and set to 'False' to have the
plenum be unconditioned. The default is set to 'False' to have the zones unconditioned.
Outputs
HBPlenumZones
...
Check Hydra Example Files for Create EP Plenum
331
Honeybee Lighting Density Calculator -

[source code]
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
332
for a typical office area or 300 lux for a typical residential space. Note that a lux value
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
333
(W/m2)The lighting load per square meter of floor, which can be plugged into the "Set
EnergyPlus Loads" component.
Check Hydra Example Files for Honeybee Lighting Density Calculator
334
Set_EP_Air_Flow
Set EP Air Flow - [source code]
Use this component to edit the airflow between your zones's air walls and/or set natural
ventilation. The natural ventilation that this component models is mostly meant for single
zones and cases where there is not much airflow between zones. Specifically, this
component can model a few common types of natural ventilation: 1 - Single-sided Ventilation
- ventilation driven by the height difference across individual windows on a single side of a
building. 2 - Cross Ventilation - ventilation driven by the pressure difference across windows
on two opposite sides of a building. 3 - Chimney Ventilation - ventilation driven by a
chimney/stack that is attached to a zone. 4 - Cowl Ventilation - ventilation driven by wind
through a cowl attached to a zone. 5 - Fan-driven Ventilation - ventilation at a constant flow
rate driven by a fan. The component can model "multi-zone" natural ventilation so long as
335
Set_EP_Air_Flow
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 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 buoyancy-driven flow. Natural ventilation
(that i nt fan-driven) is computed using the following formulas: Ventilation Wind = Wind
Coefficient Opening Area Schedule WindSpd Ventilation Stack = Stack Discharge
Coefficient Opening Area Schedule SQRT(2 Gravity Operable Height * (|(Temp Zone - Temp
Outdoors)| / Temp Zone)) 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: 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 - WINDOW NATURAL VENTILATION - Choose this to have the
component automatically calculate natural ventilation airflow based on ALL of your
zone's exterior windows, a specified fraction of operable glazing, and a specified
fraction of the glazing height that is operable. It will be assumed that each window has a
single opening, that this window opening is sliding, and that the difference in the heights
between the different windows is not great enough to induce bouyancy driven flow from
one window to another. The default assumes an opening that extends the full window
height with half of the total glazing area operable (a horizontal sliding window). The
default also assumes the presence of insect screens (discharge doefficient of 0.17).
336
Set_EP_Air_Flow
Finally, the default negates wind-driven cross ventilation but this option should be set to
True if there is roughly equal opeerable area on both sides of the zone or there is some
other (non-window) opening in the zone. 2 - CUSTOM STACK / WIND VENTILATION -
Choose this option if you have window ventilation that does not fit the description above
or if you are trying to model an object like a chimney or a cowl. You will have to specify
an effective window area for the object and the height between inlet and outlet. Note
that you can eliminate either the wind or the stack part of the equation by setting the
respective discharge coefficent to 0. 3 - FAN-DRIVEN VENTILATION - Choose this
option to have your zones ventilated at a constant volume flow rate, representing fan-
driven ventilation. You will have to specify the design flow rate 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
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 be
deltaTempForNatVent [Optional]
337
Set_EP_Air_Flow
A number or list of numbers between -100 and 100 that represents the temperature
differential between indoor and outdoor below which ventilation is shutoff. This should
usually be a negative number so that you open the windows when the outdoors is
cooler than the indoors. This can be either a single number to be applied 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.
fractionOfGlzAreaOperable [Optional]
A number or list of numbers between 0.0 and 1.0 that represents the fraction of the
window area that is operable. By default, it will be assumed that this is 0.5 assuming
sliding windows that slide horizontally.
fractionOfGlzHeightOperable [Optional]
A number or list of numbers between 0.0 and 1.0 that represents the fraction of the
distance from the bottom of the zones windows to the top that are operable. By default,
it will be assumed that this is 1.0 assuming sliding windows that slide horizontally.
windDrivenCrossVent [Optional]
Set to 'True' if there is operable area of roughly equal area on different sides of the zone
such that wind-driven cross ventilation will be induced. Set to 'False' if the operable area
is primarily on one side of the zone and there is no wind-driven ventilation. The default
will examine the difference in directions that the zone's windows are facing and, if this
maximum difference is greater than 90 degrees, cross ventilation will be turned on. This
input overrides this default.
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
'Stack Discharge Coefficient' variable in the equation of this component's description. If
left blank, this variable will be assumed to be 0.17 for single-sided ventilation with
sliding windows and insect screens. This value should be changed if windows are
awning or casement. Some common values for this coefficient include the following: 0.0
- Completely discounts stack ventilation from the natural ventilation calculation. 0.17 -
For buoyancy with ONE opening WITH an insect screen. In this case, the effective area
should be the whole opening. 0.25 - For buoyancy with ONE opening with NO insect
screen. In this case, the effective area should be the whole opening. 0.45 - For
buoyancy with TWO openings of different heights, each of which HAVE insect screens.
338
Set_EP_Air_Flow
In this case, the effective area should be just the area of ONE of the two window
openings (if opening areas are equal). 0.65 - For buoyancy with TWO openings of
different heights, each of which have NO insect screens. In this case, the effective area
should be just the area of ONE of the two window openings (if opening areas are
equal).
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
HBZones with their airflow modified.
Check Hydra Example Files for Set EP Air Flow
339
Set EP Surface Construction - [source code]
Add Glazing -
Inputs
HBSurface [Required]
A HBSurface
EPConstruction [Optional]
Optional EnergyPlus construction
340
childEPConstruction [Optional]
Optional EnergyPlus construction for child surface
Outputs
readMe!
...
HBSurface
Modified Honeybee surface
Check Hydra Example Files for Set EP Surface Construction
341
Set EP Zone Interior Construction - [source

code]
Set EP Zones Interior Construction -
Inputs
HBZones [Required]
Honeybee zones
intWallEPConstruction [Optional]
342
Optional new construction for interior walls
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
modifiedHBZones
Check Hydra Example Files for Set EP Zone Interior Construction
343
Set EP Zone Underground Construction -

[source code]
Update EP construction of zone based on type -
Inputs
HBZones [Required]
Honeybee zone
undergroundWallEPConstruction [Optional]
344
Optional new construction for underground walls
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
modifiedHBZones
Check Hydra Example Files for Set EP Zone Underground Construction
345
Set EnergyPlus Zone Thresholds - [source

code]
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]
346
A number or list of numbers that represent the thermostat cooling setpoint in degrees
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
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
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.
maxHumidity [Optional]
A number or list of numbers that represent the maximum relative humidity allowed by a
humidistat in %. The HVAC will dehumidify the zone air if the relative humidity goes
above this threshold. The default is set to 'no limit' or no humidistat. This can be either a
single number to be applied to all connected zones or a list of numbers for each
different zone.
minHumidity [Optional]
A number or list of numbers that represent the minimum relative humidity allowed by a
humidistat in %. The HVAC will humidify the zone air if the relative humidity goes below
this threshold. The default is set to 'no limit' or no humidistat. This can be either a single
number to be applied to all connected zones or a list of numbers for each different zone.
outdoorAirReq [Optional]
347
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 - means that the
flows calculated from the fields Outdoor Air Flow per Person, Outdoor Air Flow per
Area, Outdoor Air Flow per Zone, and Air Changes per Hour (using the associated
conversions to m3/s for each field) will be added to obtain the zone outdoor air flow rate.
1 - Maximum - means that the maximum flow derived from Outdoor Air Flow per
Person, Outdoor Air Flow per Area, Outdoor Air Flow per Zone, and Air Changes per
Hour (using the associated conversions to m3/s for each field) will be used as the zone
outdoor air flow rate.
daylightIllumSetPt [Optional]
A number of list of numbers that represent the illuminance threshold in lux beyond which
electric lights will be dimmed if there is sufficent daylight. The default has no dimming
for daylight, meaning that lights will be on whenever the schedule states that they are
on (regardless of daylight). If you specify a daylightCntrlFract_ below, this component
will automatically assume a setpoint of 300 lux. Some other common setpoints are: 50
lux - Corridors and hallways 150 lux - Spaces where people are working on computer
screens, which already provide their own light. 300 lux - Spaces where people are
reading and writing on paper, such as residences and offices. 500 lux - Commerical or
retail spaces where perception of particular objects is important. 1000 lux - Reserved
only for spaces where lighting is critical for human safety like workshops with power
tools or operating rooms in hospitals.
daylightCntrlPt [Optional]
A point that represents the location of a daylight senor within the zone. If an illumance
setpoint is specified above, the default is set to place the sensor in the center of the
zone at 0.8 meters above the ground.
daylightCntrlFract [Optional]
A number between 0 and 1 that represents the fraction of the zone lights that will be
dimmed when the illimance at the daylightCntrlPt is at the specified daylightIllumSetPt.
The default is set to 1 when there is an illuminace threshold to dim all of the lights of the
zone. If you have a deep zone, you probably want to decrease this number so that you
don't dim the lights in the back of the space to be too dark.
Outputs
readMe!
348
HBZones
HBZones with thresolds set.
Check Hydra Example Files for Set EnergyPlus Zone Thresholds
349
Set_Zone_Properties
Set Zone Properties - [source code]
Use this component to set HBZone properties By default these values will be automatically
calculated by EnergyPlus. -
Inputs
HBZones [Required]
Input HBZones.
multiplier [Optional]
350
Set_Zone_Properties
A list of zone multipliers for each zone.
ceilingHeight [Optional]
A list of ceilings height for each zone.
volume [Optional]
A list of zone volumes for each zone.
inConvAlg [Optional]
A list of Inside Surface Convection Algorithm for each zone. Simple, TARP,
CeilingDiffuser, AdaptiveConvectionAlgorithm, TrombeWall.
outConvAlg [Optional]
A list of Outside Surface Convection Algorithm for each zone. Simple, TARP,
CeilingDiffuser, AdaptiveConvectionAlgorithm, TrombeWall.
partOfArea [Optional]
A list of Boolean for each zone. By default Zone area will be included in total floor area.
Outputs
HBZones
Modified HBZones.
Check Hydra Example Files for Set Zone Properties
351
infORventPerArea Calculator - [source code]
Use this component to transform ACH or inifitration per area of facade to m3/s-m2. Plug the
result to the Honeybee setEPZoneLoads component, infiltrationRatePerArea or
infiltrationRatePerArea inputs For the blowerPressue input, the component assumes a
natural pressure differential between indoors and outdoors at 4 Pascals. However, the
passive house standard sets this at a low 0.4303. -
Inputs
HBZones [Required]
352
Honeybee zones for which you want to calculate the infiltration or ventilation rates.
airFlowRate [Required]
A number representing the air flow rate into the HBZone in Air Changes per Hour
(ACH). Alternatively this number can be in m3/s per m2 of exposed envelope area if the
input below is set to "False." The latter is useful for infiltration, which is typically
specified as a unit per area of exposed envelope.
ACHorM3sM2 [Default]
Set to "True" to have the airFlowRate above interpreted as ACH. Set to "False" to have
itinterpreted as m3/s per m2 of outdoor-exposed zone surface area. This latter is useful
for infiltration rates, which are usually defined as an intensity of flow per unit outdoor
exposure. The default is set to True for ACH.
blowerPressure [Default]
A number representing the pressure differential in Pascals (Pa) between

indoors/outdoors at which the specified flow rate above occurs. When set to 0 or left
untouched, the specified input flow rate to this component will be the same as that
output from the component (only the units will be converted and no translation from one
pressure to another will occur). However, many blower door tests for infiltration occur at
higher pressure differentials of 50 Pa or 75 Pa. You can input this pressure differential
here in order to convert the flow rate of this blower door test to typical building pressure
flow rates of 4 Pa.
Outputs
readMe!
Report of the calculations
infORventPerArea
infiltrationRatePerArea or ventilationPerArea in m3/s-m2 (Cubic meters per second per

square meter of floor area) that can be plugged into the "Set EnergyPlus Zone Loads"
component.
allFloors
The floors of the zones that are used to determine the infORventPerArea.
allExposed
353
If ACHorM3sM2 is set to "False", the area of the zone that is interpreted as exposed
srface area will be output here.
Check Hydra Example Files for infORventPerArea Calculator
354
09 | Energy | HVACSystems
Component list:
Assign_HVAC_System
HVACSystemsList
HVAC_Air_Details
HVAC_Cooling_Details
HVAC_Heating_Details
Load_OpenStudio_Measure
Generator_PV
generationsystem
simple_Inverter
355
Assign_HVAC_System
Assign HVAC System - [source code]
Use this component to assign OpenStudio Systems to your HBZones. By default, all
HBZones are assigned an Ideal Air Loads system and this component can be used to
change this to a real system from the OpenStudioHVACSystemsList component. This
component is also used to adjust the features of the HVAC system using the airDetails,
heatingDetails, and coolingDetails. Without the inputs to these Details, template OpenStudio
systems will be used. -
Inputs
HBZones [Required]
356
Assign_HVAC_System
The HBZones for which you want to change/adjust the HVAC system.
HVACSystems [Required]
A HVAC system template from the "Honeybee_HVACSystemsList" component.

ASHRAE recommends using the following baseline systems for different building types
and fuel sources: BUILDING TYPE FOSSIL FUEL/HYBRID/PURCHASED HEAT
ELECTRIC ONLY Residential 1: PTAC | Residential 2: PTHP | Residential Non-Res 3
Floors 3: Packaged Single Zone - AC 4: Packaged Single Zone - HP Non-Res 4-5
Floors 5: Packaged VAV w/ Reheat 6: Packaged VAV w/ PFP Boxes Non-Res >5 Floors
7: VAV w/ Reheat 8: VAV w/ PFP Boxes Heated Only Sotrage 9: Warm Air Furnace -
Gas Fired 10: Warm Air Furnace - Electric
airDetails [Default]
Parameters from the "Honeybee_HVAC Air Details" component. Use these to define the
features of the ventilation component (or air side) of the HVAC system.
heatingDetails [Default]
Parameters from the "Honeybee_HVAC Heating Details" component. Use these to

define the features of the heating plant (or hot water side) of the HVAC system.
coolingDetails [Default]
Parameters from the "Honeybee_HVAC Cooling Details" component. Use these to

define the features of the cooling plant (or chilled water side) of the HVAC system.
Outputs
readMe!
Script variable OSHVACSystems
HBZones
HBZones that have been modified to have the assigned _HVACSystems.
Check Hydra Example Files for Assign HVAC System
357
HVACSystemsList
HVACSystemsList - [source code]
List of available HVAC templates that can be assigned to HBZones.
Inputs
Check Hydra Example Files for HVACSystemsList
358
HVAC_Air_Details
HVAC Air Details - [source code]
Use this component to set the parameters of a HVAC ventilation system (or air side) that has
been assigned with the "HoneybeeAssign HVAC System" component. Not all of the inputs
on this component are assignable features of all HVAC systems. However, most HVAC
systems have these features and, if you assign a parameter that is not usable by a certain
HVAC system, the "Honeybee_Assign HVAC System" component will give you a warning to
let you know. -
Inputs
HVACAvailabiltySched [Default]
359
HVAC_Air_Details
A text string representing the HVAC availability 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 "Honeybee_Create CSV Schedule" component.
fanTotalEfficiency [Default]
A number between 0 and 1 that represents the overall efficiency of the fan. Specifically,
this is the ratio between the power delivered to the air fluid and the electrical power
intput to the fan. It is the product of the motor efficiency and the impeller efficiency. The
impeller efficiency is power delivered to the fluid (air) divided by the shaft power. The
power delivered to the fluid is the mass flow rate of the air multiplied by the pressure
rise divided by the air density. The default is usually between 0.6 and 0.7.
fanMotorEfficiency [Default]
A number between 0 and 1 that represents the efficiency of the fan electric motor. The
motor efficiency is the power delivered to the fan shaft divided by the electrical power
input to the motor. This value must be greater than the fanTotalEfficiency above. The
default is usually around 0.9.
fanPressureRise [Default]
A number representing the pressure rise across the fan in Pascals. This is the pressure
rise at full flow and standard (sea level) conditions (20°C and 101325 Pa). The default is
usually around 500 Pa.
fanPlacement [Default]
A boolean value that represents the placement of the fan in relation to cooling or heating
coils. The default is set to True to draw through. Choose from the following options:
True = Draw Through (the fan comes after the coils such that air is drawn by the fan
across the heating/cooling coils). False = Blow Through (the fan comes before the coils
such that air is blown through the heating/cooling coils).
airSystemHardSize [Optional]
A number that represents airflow in m3/s and sets the maximum air flow through the
HVAC air system including the fan and ducts. This overrides the default autosizing of
the air system is useful for evaluating strategies like larger ducts to minimize friction and
decrease fan energy use. It's particularly useful in cases of vetilation-dominated spaces
like labs and hospital patient rooms.
centralAirLoop [Optional]
360
HVAC_Air_Details
Set to "True" to have all instances of this HVAC Type have a single central air loop. If
set to False or left blank, each branch of a HBZone data tree that is plugged into this
component will have a separate air loop.
demandControlledVent [Optional]
A boolean value that represents whether system can vary its speed and the volume of
air to match occupancy. The default is False for all systems. Choose from the following
options: True = Demand Controlled Varialbe Minimum Air (the system can vary the
volume of air to match occupancy). False = Constant Volume Minimum Air (the fan has
only one miniumum flow rate when it is on).
heatingSupplyAirTemp [Default]
A number representing the target temperature of the supply air when the system is in
heating mode. For large systems, this is the rated outlet air temperature of the heating
coil. Default for a VAV system is 35C. Default for ideal air is 40 C.
coolingSupplyAirTemp [Default]
A number representing the target temperature of the supply air when the system is in
cooling mode. For large systems, this is the rated outlet air temperature of the cooling
coil. Default is typically around 12C, which is the coldest temperature before supply air
can cause clear thermal discomfort issues. Default for ideal air is 13 C.
airRecirculation [Optional]
An optional boolean that, when set to False, will make all air pass through the air loop
only once without recirculation. The default is set to True, which will recirculate air when
the air needed to meet heating/cooling loads is in excess of the minimum outdoor
ventilation. The only reasons why this output might be set to False is for systems where
outdoor air intake and exhaust cannot be located close enough to allow for recirculation
or one is modeling a space like a laboratory where the exhaust is toxic and cannot be
recirculated. Note that this input will have no effect on HVAC systems with a DOAS
since this system isn't intedned to heat and cool the space.
airsideEconomizer [Optional]
An integer or boolean value (0/1) that sets the economizer on the HVAC system. The
default is set to "True" or "1" to include a Differential Dry Bulb air side economizer or "2"
for a Differential Enthalpy economizer if the zone has humidity control. Choose from the
following options: 0 - No Economizer - The HVAC system will constantly provide the
same amount of minimum outdoor air and may run the cooling system to remove heat
and meet thermostat setpoints. 1 - Differential Dry Bulb - The HVAC system will
361
HVAC_Air_Details
increase the outdoor air flow rate when there is a cooling load and the outdoor air
temperature is below the temperature of the return (or exhaust) air. 2 - Differential
Enthalpy - The HVAC system will increase the outdoor air flow rate when there is a
cooling load and the outdoor air enthalpy is below that of the return (or exhaust) air. 3 -
Fixed Dry Bulb - The HVAC system will increase the outdoor air flow rate when there is
a cooling load and the outdoor air temperature is below a specified dry bulb temperature
limit (default is 28C). 4 - Fixed Enthalpy - The HVAC system will increase the outdoor air
flow rate when there is a cooling load and the outdoor air enthalpy is below a specified
enthalpy limit (default is 64000 J/kg). 5 - Electronic Enthalpy - The HVAC system will
calculate the humidity ratio limit of the outdoor air based on the dry-bulb temperature of
outdoor air and a quadratic/cubic curve, and compare it to the actual outdoor air
humidity ratio. If the actual outdoor humidity ratio is lower than the calculated humidity
ratio limit and there is cooling load, then the outdoor airflow rate is increased. 6 - Fixed
Dew Point and Dry Bulb - The HVAC system will compare both the outdoor dewpoint
temperature and the outdoor dry-bulb temperature to their specified high limit values
(default of 28C). The outdoor air flow rate will be increased when there is cooling load
and the outdoor air is below both thresholds. 7 - Differential Dry Bulb And Enthalpy -
The HVAC system will increase the outdoor air flow rate when there is a cooling load
and the outdoor air temperature is below a specified dry bulb temperature limit (default
is 28C) AND enthalpy below a specified enthalpy limit (default is 64000 J/kg).
sensibleHeatRecovery [Optional]
A number between 0 and 1 that sets the sensible heat recovery effectiveness of a heat
recovery system on the HVAC (at approximately 75% of maximum flow rate). Typical
values range from 0.45 (for a heat pipe or glycol loop system) to 0.81 (for an enthalpy
wheel). If this value and the value below are set to 0, no heat recovery will be written
into the model. The default varies based on HVAC type. Systems 1-10 (code baseline
systems) do not have heat recovery by default. Any system with a Dedicated Outdoor
Air System (DOAS) includes an enthalpy wheel by default.
latentHeatRecovery [Optional]
A number between 0 and 1 that sets the latent heat recovery effectiveness of a heat
recovery system on the HVAC (at approximately 75% of maximum flow rate). Typical
values for an enthalpy wheel are around 0.73 and most other types of heat recovery are
sensible-only, in which case this input will be 0. If this value and the value above are set
to 0, no heat recovery will be written into the model. The default varies based on HVAC
type. Systems 1-10 (code baseline systems) do not have heat recovery by default. Any
system with a Dedicated Outdoor Air System (DOAS) includes an enthalpy wheel by
default.
362
HVAC_Air_Details
Outputs
airDetails
A description of the HVAC ventilation system (or system air side), which can be plugged
into "Honeybee_HVAC Systems" component.
Check Hydra Example Files for HVAC Air Details
363
HVAC Cooling Details - [source code]
Use this component to set the parameters of a HVAC cooling system that has been
assigned with the "HoneybeeHVAC Systems" component. Not all of the inputs on this
component are assignable features of all HVAC systems. However, most HVAC systems
have these features and, if you assign a parameter that is not usable by a certain HVAC
system, the "Honeybee_OpenStudio Systems" component will give you a warning to let you
know. -
Inputs
coolingAvailSched [Default]
364
A text string representing the availability shcedule of the cooling system. This can be
either a shcedule from the schedule libirary or a CSV file path to a CSV schedule you
created with the "Honeybee_Create CSV Schedule" component. The default is set to
'ALWAYS ON.'
coolingCOP [Default]
A number (typically greater than 1) that sets the reference coefficient of performance
(COP) of the primary cooling component (under design-day conditions). The COP is the
ratio of heat removed by the cooling system per unit of electricity input. For a large
HVAC system, this input refers to the COP of the chiller compressor. For a smaller
system, this likely refers to the COP of the direct expansion cooling coil or equivalent.
Defaults range from 2 to 5.5 depending on the system type.
supplyTemperature [Optional]
A number representing the temperature of the water leaving the chiller in degrees
Celsius. This input does not have an effect on direct expansion cooling systems. If left
blank, the default temperature is usually 6.67 degrees Celsius.
pumpMotorEfficiency [Optional]
A number between 0 and 1 that represents the motor efficiency of the chilled water
pump. This input does not have an effect on direct expansion cooling systems. If left
blank, the defualt efficiency is usally 0.9.
coolingHardSize [Optional]
A number in Watts that sets the maximum capacity of the cooling system. This will
override the default, which is to autosize the cooling system based on the design day.
centralPlant [Optional]
Set to "True" to have all instances of this HVAC Type have a single central cooling plant.
If set to False or left blank, each branch of a HBZone data tree that is plugged into this
component will have a separate cooling plant.
heatRejectionType [Optional]
An integer that represents the type of heat rejection used by the cooling system. This
input does not have an effect on direct expansion cooling systems. If left blank, the
defualt is usally 0 = water cooled (the only exception is VRFs). Choose from the
following options: -1 = GroundSourced - The chiller (or VRF heat pumps) will reject AND
absorb heat to/from the ground. This effectively turns the boiler and chiller into a single
365
ground source heat pump with a high COP. Note that the ground loop temperature will
be approximated using district heating/cooling objects and you may want to place an
actual ground heat exchanger that is sized to accomodate the heating/cooling system in
the OpenStudio interface. 0 = Water Cooled - The chiller (or VRF heat pumps) will be
cooled using a condenser water loop with cooling tower and will use a higher default
COP. 1 = Air Cooled - The chiller (or VRF heat pumps) will reject heat directly to the air
and will have a lower default COP.
Outputs
coolingDetails
A description of the cooling system features, which can be plugged into

"Honeybee_HVAC Systems" component.
Check Hydra Example Files for HVAC Cooling Details
366
HVAC Heating Details - [source code]
Use this component to set the parameters of a HVAC heating system that has been
assigned with the "HoneybeeHVAC Systems" component. Not all of the inputs on this
component are assignable features of all HVAC systems. However, most HVAC systems
have these features and, if you assign a parameter that is not usable by a certain HVAC
system, the "Honeybee_HVAC Systems" component will give you a warning to let you know.
-
Inputs
heatingAvailSched [Default]
367
A text string representing the availability shcedule of the heating system. This can be
either a shcedule from the schedule libirary or a CSV file path to a CSV schedule you
created with the "Honeybee_Create CSV Schedule" component. The default is set to
'ALWAYS ON.'
heatingEffOrCOP [Default]
A number that sets the reference efficiency of the primary heating component (under
design-day conditions). For a system with a boiler, this is the fraction of energy
contained within fuel that is converted into usable heat energy (default boiler efficiencies
are typically between 0.7 and 0.9). For electric heat pump systems, this value is the
coefficient of performance (COP) of the heat pump ot the ratio of heat added by the
heat pump system per unit of electricity input. Defaults COPs typically range from 2 to 5
depending on the system type.
supplyTemperature [Optional]
A number representing the temperature of the water leaving the boiler in degrees
Celsius. This input does not have an effect on direct expansion heat pump systems. If
left blank, the default temperature is usually 82.0 degrees Celsius.
pumpMotorEfficiency [Optional]
A number between 0 and 1 that represents the motor efficiency of the hot water pump.
This input does not have an effect on direct expansion cooling systems. If left blank, the
defualt efficiency is usally 0.9.
heatingHardSize [Optional]
A number in Watts that sets the maximum capacity of the heating system. This will
override the default, which is to autosize the heating system based on the design day.
centralPlant [Optional]
Set to "True" to have all instances of this HVAC Type have a single central heating
plant. If set to False or left blank, each branch of a HBZone data tree that is plugged
into this component will have a separate heating plant.
Outputs
heatingDetails
...returns the chiller description
Check Hydra Example Files for HVAC Heating Details
368
369
Load OpenStudio Measure - [source code]
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
370
loaded
Outputs
readMe!
OSMeasure
Loaded OpenStudio measure
Check Hydra Example Files for Load OpenStudio Measure
371
Generator_PV
Generator_PV - [source code]
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]
372
Generator_PV
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.
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.
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
costPVgen [Optional]
A float or a list of floats that sequentially correspond to each Honeybee surface in
373
Generator_PV
_HBSurfaces. The float is the cost of each PV module in US dollars (Other currencies
will be available in the future). The cost of the PV generator will be the cost of the
module multiplied by the number of modules in parallel and series (number of modules
as a generator is made up of modules). If only one float is given this value will be used
for all other PV generators. Default is set to $0.
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
374
generationsystem
generationsystem - [source code]
Use this component to create a Honeybee generator system. -
Inputs
GeneratorSystemName [Required]
The name of this Honeybee generation system please make it unique!
PVHBSurfaces [Optional]
The Honeybee/context surfaces that contain PV generators to be included in this
375
generationsystem
generation system
HBGenerationObjects [Optional]
Honeybee batteries or wind turbines to be included in this generation system
Outputs
readMe!
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
376
simple_Inverter
simple_Inverter - [source code]
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]
377
simple_Inverter
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!
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
378
10 | Energy | Energy
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
Energy_Simulation_Par
Generate_EP_Output
Lookup_EnergyPlus_Folder
Read_EP_Custom_Result
Read_EP_Result
Read_EP_Surface_Result
Read_HVAC_Sizing
Read_Result_Dictionary
Color_Surfaces_by_EP_Result
Color_Zones_by_EP_Result
Construct_Energy_Balance
Energy_Shade_Benefit_Evaluator
Adaptive_Comfort_Analysis_Recipe
Indoor_View_Factor_Calculator
Matrix_to_Data_Tree
Microclimate_Map_Analysis
Outdoor_Comfort_Analysis_Recipe
PET_Analysis_Recipe
PMV_Comfort_Analysis_Recipe
Read_Microclimate_Matrix
Thermal_Autonomy_Analysis
Visualize_Microclimate_Map
Apply_OpenStudio_Measure
Balance_Temperature_Calculator
379
10 | Energy | Energy
Make_Adiabatic
Make_Adiabatic_by_Name
Normalize_Data_by_Floor_Area
OpenStudio_to_gbXML
Re-run_IDF
Re-run_OSM
Read_EP_HVAC_Result
Read_generation_system_results
ShadowPar
Simulation_Control
Surface_Data_Based_On_Type
Surface_Data_Based_On_Type_Detailed
gbXML_to_Honeybee
380
Export To OpenStudio - [source code]
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
381
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).
An .epw file path on your system as a text string.
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 - A solar 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 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.
HBGenerators [Optional]
Script variable exportToOpenStudio
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
382
with writing EnergyPlus outputs, you should use the "Honeybee_Write EP Result
Parameters" component to request certain types of common outputs.
OSMeasures [Optional]
Script variable exportToOpenStudio
additionalStrings [Optional]
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.
writeOSM [Required]
Set to "True" to have the component take your HBZones and other inputs and write
them into an OSM file. Note that only setting this to "True" and not setting the output
below to "True" will not automatically run the file through EnergyPlus for you.
runSimulation [Optional]
Set to "True" to have the component generate an IDF file from the OSM file and run the
IDF through through EnergyPlus. Set to "False" to not run the file (this is the default).
You can also connect an integer for the following options: 0 = Do Not Run OSM and IDF
thrrough EnergyPlus 1 = Run the OSM and IDF through EnergyPlus with a command
prompt window that displays the progress of the simulation 2 = Run the OSM and IDF
through EnergyPlus in the background (without the command line popup window). 3 =
Generate an IDF from the OSM file but do not run it through EnergyPlus
openOpenStudio [Optional]
Set to "True" to open the OSM file in the OpenStudio interface. This is useful if you want
to visualize the HVAC system in OpenStudio, you want to edit the HVAC further in
OpenStudio, or just want to run the simulation from OpenStudio instead of Rhino/GH.
Note that, for this to work, you must have .osm files associated with the OpenStudio
application.
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]
383
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!
Check here to see a report of the EnergyPlus run, including errors.
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 file is only
generated when you set "runSimulation_" to "True."
resultFileAddress
The file path of the CSV result file that has been generated on your machine. This file is
only generated when you set "runSimulation_" to "True."
eioFileAddress
The file path of the EIO file that has been generated on your machine. This file contains
information about the sizes of all HVAC equipment from the simulation. This file is only
rddFileAddress
The file path of the Result Data Dictionary (.rdd) file that is generated after running the
file through EnergyPlus. This file contains all possible outputs that can be requested
from the EnergyPlus model. Use the "Honeybee_Read Result Dictionary" to see what
outputs can be requested.
htmlReport
The file path to the HTML report that was generated after running the file through
EnergyPlus. Open this in a web browser for an overview of the energy model results.
studyFolder
The directory in which the simulation has been run. Connect this to the
'Honeybee_Lookup EnergyPlus' folder to bring many of the files in this directory into
384
Grasshopper.
model
The openStudio model ojbect. Use this output to generate gbXML files from your
OpwnStudio models.
Check Hydra Example Files for Export To OpenStudio
385
Run Energy Simulation - [source code]
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
386
epwFile [Required]
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." component

or 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
387
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.
additionalStrings [Optional]
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.
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.
An optional working directory to a folder on your system, into which your IDF and result
files 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.
Outputs
readMe!
388
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."
eioFileAddress
information about the sizes of all HVAC equipment from the simulation.
rddFileAddress
Script variable runEnergySimulation
htmlReport
Script variable runEnergySimulation
studyFolder
Grasshopper.
Check Hydra Example Files for Run Energy Simulation
389
Add Internal Mass to Zone - [source code]
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 only
factored into the the thermal calculations of the zone by undergoing heat transfer with the
indoor air. -
390
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 to
the 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 be
used 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!
HBZones
HBZones with internal masses assigned.
Check Hydra Example Files for Add Internal Mass to Zone
391
392
EnergyPlus Window Shade Generator -

[source code]
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
393
beam gain synced with that of the zones and windows. For this, you would take imported
EnergyPlus results and hook them up to the "zoneData" inputs and use the output
"zoneDataTree" in the shade benefit evaluation. -
Inputs
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 transmits light more evenly
than slatted blinds. 2 = Swtichable 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. The default blinds or shade 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. If no schedule is connected, the
shades are assumed to always be down. 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
394
temperature in the previous timestep exceeds SetPoint (C) below and schedule, if
specified, allows shading. 5 = OnIfHighZoneCooling - Shading is on if zone cooling rate
in the previous timestep exceeds SetPoint (W) below and schedule, if specified, allows
shading. 6 = OnNightIfLowOutdoorTempAndOffDay - Shading is on at night if the
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 as
the 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. 15 = OnIfHighGlare: Shading is
on if the glare index in the zone exceeds the maximum Discomfort Glare Index (DGI)
specified below. Common maximim DGI values are 22 for Offices, 20 for Museums or
Classrooms, 18 for Hospital Wards, and 16 for Art Gallereies. In the input below, you
should specify a list of 2 values that includes the DGI as a first value and a vector for
the second value, which represents the direction that the occupant view is facing. It will
be assumed that the occupant is in the center of the zone by default and you can
395
change this potition by adjusting the daylightCntrlPt_ input of the "Honeybee_Set

ZoneThresholds" component. 16 = MeetDaylightIlluminanceSetpoint: Useable only with
ShadingType = SwitchableGlazing. In this case, the transmittance of the glazing is
adjusted to just meet the daylight illuminance set point assinged with the
"Honeybee_Set ZoneThresholds" component. If no setpoint is assigned with this
component, this component will assume a default illuminace setpoint of 300 lux. As
such, there is no need to specify a setpoint below unless you also want the EC glazing
to be further dimmed when there is glare in the zone, in which case the setpoint below
should be a DGI value and vector representing a view as states in option 15
(OnIfHighGlare).
shadeSetpoint [Optional]
A number that corresponds to the shadeCntrlType_ specified above. This can be a

value in (W/m2), (W), (C), or (DGI) 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]
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.
depth [Required]
A number representing the depth of the shade to be generated on each window. You
can also input lists of depths, which will assign different depths based on cardinal
direction. For example, inputing 4 values for depths will assign each value of the list as
follows: item 0 = north depth, item 1 = west depth, item 2 = south depth, item 3 = east
depth. Lists of vectors to be shaded can also be input and shades can be joined
together with the mergeVectors_ input.
numOfShds [Required]
The number of shades to generated for each glazed surface.
distBetween [Required]
An alternate option to _numOfShds where the input here is the distance in Rhino units
between each shade.
396
horOrVertical [Optional]
Set to 'True' to generate horizontal shades or 'False' to generate vertical shades. You
can also input lists of horOrVertical_ input, which will assign different orientations based
on cardinal direction.
shdAngle [Optional]
A number between -90 and 90 that represents an angle in degrees to rotate the shades.
The default is set to '0' for no rotation. If you have vertical shades, use this to rotate
them towards the South by a certain value in degrees. If applied to windows facing East
or West, tilting the shades like this will let in more winter sun than summer sun. If you
have horizontal shades, use this input to angle shades downward. You can also put in
lists of angles to assign different shade angles to different cardinal directions.
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.
writeEPObjs [Optional]
Set boolean to "True" to generate EP Objectes that have shades and shade control
assigned to them.
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
397
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.
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.
shadeMatName
The name of the shade material that has been assigned to the EPObjects. This can be
used to create EP constructions with the shade in between panes of glass.
shadeMatIDFStr
Text strings that represent the shade material that has been assigned to the EP Objects.
shadeCntrlIDFStr
Text strings that represent the shade control object that has been assigned to the EP
Objects.
zoneData1Tree
Data trees of zoneData1Tree, which align with the branches for each window above.
Check Hydra Example Files for EnergyPlus Window Shade Generator
398
Honeybee_EP_context_Surfaces
Honeybee EP context Surfaces - [source

code]
prepare shading/context geometries
Inputs
shdSurfaces [Required]
EPTransSchedule [Optional]
399
Honeybee_EP_context_Surfaces
Script variable HB_EPContextSrf
RADMaterial []
Script variable HB_EPContextSrf
meshingSettings [Optional]
Script variable HB_ShdSrf
justBoundingBox [Optional]
Script variable HB_ShdSrf
Outputs
HBContext
Check Hydra Example Files for Honeybee EP context Surfaces
400
Make Adiabatic By Type - [source code]
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
401
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]
windows [Optional]
interiorWindows [Optional]
roofs [Optional]
ceilings [Optional]
floors [Optional]
exposedFloors [Optional]
groundFloors [Optional]
undergroundWalls [Optional]
undergroundSlabs [Optional]
undergroundCeilings [Optional]
402
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
403
Energy Simulation Par - [source code]
EnergyPlus Shadow Parameters -
Inputs
timestep [Optional]
It is the number of times simulation will be performed in an hour. - You can choose any
number from 1,2,3,4,5,6,10,12,15,20,30, and 60 as the timestep. Generally speaking,
the shorter the time step, the longer it takes to finish the simulation. The biggest
timestep is 60 minutes. That will mean that the simulation will for every one hour for the
404
year. - It is advisable to use the timestep of 60 minutes only in a case when no HVAC
system is envisaged, accuracy not a primary concern, and simulation run time is critical.
- In summary, shorter timesteps improve how calculation models for surface
temperature and zone air temperature are coupled together and therefore, shorter
timesteps are recommended. On the other side, longer timesteps introduce more lag in
temperature distribution and as a result, offers a less dynamic behavior. - The default is
set to 6 timesteps per hour, which means that the energy balance calculation is run
every 10 minutes of the year. This is a recommended default for simulations with HVAC.
- Other suggested defaults are 4 for non-HVAC simulations. Simulating green roofs
require more timesteps per hour.
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 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. 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
405
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.
holidays [Optional]
A list of integers, each between 1 and 365, that represent the days of the year on which
a holiday occurs. Alternatively, this can be a list of text strings (example: DEC 25).
Finally, this input can accept the "holidays" output from the "Honeybee_Convert
EnergyPlus Schedule to Values" component.
startDayOfWeek [Optional]
An integer or text descriptor to set the ssimulation start day of the week. The default is
set to 0 - sun - sunday. - Choose from one of the following: 0 - sun - sunday 1 - mon -
monday 2 - tue - tuesday 3 - wed - wednesday 4 - thu - thursday 5 - fri - friday 6 - sat -
saturday
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.
heatingSizingFactor [Optional]
An optional number that represents the 'saftey factor' to which the heating system will
be sized. A sizing factor of 1 means that the system is sized to perfectly meet the design
day conditions. The default is set to 1.25 as it is usually appropriate to oversize the
system slightly to ensure that there are no unmet hours. Specifying a factor here that is
below 1.25 can result in more hours that do not meet the heating setpoint.
coolingSizingFactor [Optional]
An optional number that represents the 'saftey factor' to which the cooling system will be
sized. A sizing factor of 1 means that the system is sized to perfectly meet the design
day conditions. The default is set to 1.15 as it is usually appropriate to oversize the
system slightly to ensure that there are no unmet hours. Specifying a factor here that is
below 1.15 can result in more hours that do not meet the cooling setpoint.
terrain [Optional]
406
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 2000m
upwind. 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 no
values 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
407
Generate_EP_Output
Generate EP Output - [source code]
This component helps select simulation outputs that can be hooked into the
"HonyebeeExport to OpenStudio" component. Outputs are taken from here:
http://bigladdersoftware.com/epx/docs/8-3/input-output-reference/ You can also use the
"Honeybee_Read Result Dictionary" component after running a simulation to get a list of all
possible outputs that you can request from a given simulation. -
Inputs
zoneEnergyUse [Optional]
408
Generate_EP_Output
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.
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 needed
for Energy Shade Benefit Analysis.
loadType [Default]
An integer or text value to set the type of load outputs requested (sensible, latent, total).
The default is set to "0 = Total" but you may want to change this to "1 = Sensible" for
zone HVAC sizing, etc. Choose from the following options: 0 = Total 1 = Sensible 2 =
Latent
409
Generate_EP_Output
timestep [Optional]
Specify a timestep by inputing the words 'timestep', 'hourly', 'daily', 'monthly' or 'annual'.
The default is set to hourly.
Outputs
report
Report!
simulationOutputs
EnergyPlus code that should be plugged into the "simulationOutputs" parameter of the
"Honeybee_Export to OpenStudio" component.
Check Hydra Example Files for Generate EP Output
410
Lookup EnergyPlus Folder - [source code]
Search Energy Simulation Folder -
Inputs
studyFolder [Required]
Path to base study folder. It can be a single simulation folder or a folder containing
subfolders produced by parametric simulations
studyType [Optional]
411
Input for Honeybee EnergyPlus study type: 1 > Energy Plus 2 > OpenStudio
refresh [Optional]
Refresh
Outputs
readMe!
idfFiles
The file path of the Input Data File (idf) file that has been generated on your machine.
osmFiles
The file path of the OpenStudio Model (osm) file that has been generated on your
machine.
resultFileAddress
The file path of the Comma-Separated Values file (csv) result file that has been
generated on your machine.
scheduleCsvFiles
The file paths to any CSV schedules in the study folder.
rddFiles
The file path of the Report Data Dictionary (rdd) file that has been generated on your
machine.
errFiles
The file path of the Error (err) file that has been generated on your machine.
eioFiles
The file path of the EnergyPlus Invariant Output (eio) file that has been generated on
your machine.
esoFiles
The file path of the EnergyPlus Simulation Output (eso) result file that has been
412
generated on your machine.
sqlFiles
The file path of the Structured Query Language (sql) result file that has been generated
on your machine.
Check Hydra Example Files for Lookup EnergyPlus Folder
413
Read EP Custom Result - [source code]
This component reads the results of an EnergyPlus simulation from the "Export to
OpenStudio" Component or any EnergyPlus result .csv file address. _ The component is
built to bring in any result that you desire from the csv using _keywords to search through all
of the results in the file. As such, this is particularly useful when you have requested atypical
E+ outputs using the "Honeybee_Read Result Dictionary" component. -
Inputs
resultFileAddress [Required]
414
The result file address that comes out of the "Export to OpenStudio" component.
keywords [Required]
keywords that will be used to bring in the results that you are interested in. These words
should be the name of the output that you are requesting or should correspond to words
in the top row of the csv file.
Outputs
results
The result data from the csv file (formatted with a Ladybug header on it).
Check Hydra Example Files for Read EP Custom Result
415
Read_EP_Result
Read EP Result - [source code]
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
416
Read_EP_Result
The result file address that comes out of the WriteIDF component.
Outputs
totalThermalLoad
The total thermal energy used by each zone in kWh. This includes cooling and heating.
thermalLoadBalance
The thermal energy used by each zone in kWh. Heating values are positive while
cooling values are negative. This is useful for computing balance points.
cooling
The cooling energy needed in kWh. For Ideal Air loads, this output is the sum of
sensible and latent heat that must be removed from each zone. For detailed HVAC
systems (other than ideal air), this output will be electric energy needed to power each
chiller/cooling coil.
heating
The heating energy needed in kWh. For Ideal Air loads, this is the heat that must be
added to each zone. For detailed HVAC systems (other than ideal air), this will be fuel
energy or electric energy needed for each boiler/heating element.
electricLight
The electric lighting energy needed for each zone in kWh.
electricEquip
The electric equipment energy needed for each zone in kWh.
fanElectric
The fan electric energy in kWh for either a natural ventilation fan or a heating or cooling
system fan. This ouput will not appear when there is no fan in the model.
pumpElectric
The water pump electric energy in kWh for a heating or cooling system. This ouput will
not appear when there is no water pump in the model.
peopleGains
417
Read_EP_Result
The internal heat gains in each zone resulting from people (kWh).
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).
mechVentilationEnergy
The heat loss (negative) or heat gain (positive) in each zone resulting from the outdoor
air coming through the HVAC System (kWh).
natVentEnergy
The heat loss (negative) or heat gain (positive) in each zone resulting from natural
ventilation (kWh).
operativeTemperature
The mean operative temperature of each zone (degrees Celcius).
airTemperature
The mean air temperature of each zone (degrees Celcius).
meanRadTemperature
The mean radiant temperature of each zone (degrees Celcius).
relativeHumidity
The relative humidity of each zone (%).
airFlowVolume
The total volume of air flowing into the room through both the windows and infiltration
(m3/s). This is voulme of air is at standard density (20 C and adjusted for the elevation
above sea level of the weather file).
airHeatGainRate
The total heat transfer rate to the air from lighting, equipment(appliances/pulg loads),
people, the surfaces of the zone, and gains through the heating system. This output is
418
Read_EP_Result
useful for the estimation of air stratification in the Comfort Analysis workflow.
Check Hydra Example Files for Read EP Result
419
Read EP Surface Result - [source code]
results related to surfaces. For results related to zones, you should use the
"Honeybee_Read EP Result" component. -
Inputs
420
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 the
zone (kWh).
421
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.
Check Hydra Example Files for Read EP Surface Result
422
Read_HVAC_Sizing
Read HVAC Sizing - [source code]
This component parses an .eio file from an energy simulation and brings in the sizes of all of
the HVAC equipment. -
Inputs
eioFile [Required]
The file address of the eio file that comes out of the "Honeybee_Lookup EnergyPlus
Folder" component.
423
Read_HVAC_Sizing
keywords [Optional]
Optional keywords that will be used to search through the outputs.
Outputs
zonePeakLoadObjs
Text describing the meaning of the zonePeakLoadVals below.
zonePeakLoadVals
The sum of the zone's peak sensible loads on the design days. These are eventually
used to size the HVAC equipment that delivers heating/cooling to the zones.
zoneSizingObjs
Text describing the meaning of the zoneSizingValues below.
zoneSizingValues
The zone's peak sensible loads multiplied by their respective design "safety" factors (set
on the "Energy Simulation Par" component). These safety factors are used to slightly
oversize zone heating/cooling equipment and is standard ASHRAE practice.
systemSizingObjs
Text describing the meaning of the systemSizingVals below.
systemSizingVals
Values denoting the size of various central HVAC system elemts (like the primary air
loop flow rates).
componentSizObjs
Text describing the meaning of the componentSizVals below.
componentSizVals
Values denoting the size of various zone HVAC components (like zone terminal sizes,
heating/cooling coil sizes, lengths of chilled beams, etc.).
coolDesignDayLoad
The sum of the load that must be reomved from the space at every timestep of the
cooling design day.
424
Read_HVAC_Sizing
heatDesignDayLoad
The sum of the load that must be added to the space at every timestep of the heating
design day.
Check Hydra Example Files for Read HVAC Sizing
425
Read Result Dictionary - [source code]
This component parses an .rdd file from an energy simulation to show all possible outputs
that could be requested. -
Inputs
rddFile [Required]
The file address of the rdd file that comes out of the "Honeybee_Lookup EnergyPlus
Folder" component.
426
keywords [Optional]
Optional keywords that will be used to search through the outputs.
timestep [Default]
Specify a timestep by inputing the words 'hourly', 'daily', 'monthly' or 'annual'. The
default is set to hourly.
Outputs
simOutputs
EnergyPlus code that should be plugged into the "simulationOutputs" parameter of the
"Honeybee_Export to OpenStudio" component.
Check Hydra Example Files for Read Result Dictionary
427
Color Surfaces by EP Result - [source code]
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
428
srfData [Required]
A list surface data out of the 'Honeybee_Read EP Surface Result' component.
HBZones [Required]
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.
normalizeBySrfArea [Optional]
Set boolean to 'True' in order to normalize results by the area of the surface and set to
'False' to color zones based on total values for each surface. The default is set to 'True'
such that colored surface communicate energy intensity rather than total energy. Note
that this input will be ignored if connected data is Temperature or values that are already
normalized.
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.
runIt [Required]
Set boolean to 'True' to run the component and color the zone surfaces.
Outputs
readMe!
...
srfColoredMesh
429
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.
relevantSrfData
The input data used to color the zones.
Check Hydra Example Files for Color Surfaces by EP Result
430
Color Zones by EP Result - [source code]
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
431
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]
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).
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.
Optional interger for the hour of simulation to color the zones with. Connecting a value
here will override the analysisPeriod_ input.
runIt [Required]
Set boolean to 'True' to run the component and color the zones.
Outputs
readMe!
...
432
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
The values of the input data that are being used to color the zones.
relevantZoneData
The input data used to color the zones.
Check Hydra Example Files for Color Zones by EP Result
433
434
Construct Energy Balance - [source code]
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]
435
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.
fanElectric [Optional]
The electric fan 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.
mechVentilationEnergy [Optional]
The outdoor air heat loss (negative) or heat gain (positive) from the "Honeybee_Read
EP Result" component.
natVentEnergy [Optional]
The natural ventilation heat loss (negative) or heat gain (positive) from the
"Honeybee_Read EP Result" component.
surfaceEnergyFlow [Optional]
436
The surface heat loss (negative) or heat gain (positive) from the "Honeybee_Read EP
Surface Result" component.
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
437
438
Energy Shade Benefit Evaluator - [source

code]
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 saturation
439
of 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
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://web.mit.edu/tito/www/Publications/BS2011_Shaderade.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.
440
context [Optional]
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]
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.
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!
441
...
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
442
Adaptive Comfort Analysis Recipe - [source

code]
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".
443
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.
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]
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
444
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
absorbed by the human body. The default is set to 0.7 for (average/brown) skin and
average clothing. You may want to increase this value for darker skin or darker clothing.
windSpeed [Optional]
A value in m/s to set the wind speed of the comfort calculation. Use this input to account
for objects like ceiling fans that might increase the interior wind speed or input custom
wind speed values from a CFD simulation. This input can also be a list of 8760
additional wind speed values that represent the hours of the year. Alternatively, 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 can also be a data tree of
values with one branch for each point in the input viewFactorMesh. Finally, this input
can be the file path to a .csv file that is organized with 8760 values in each column and
a number of columns that correspond to the number of test points. This last option is
recommended if trying to synchronize CFD results with the microclimate maps. If no
value is input here, the comfort map components will compute a minimum indoor air
speed from the zone volume and hourly flow volume and will use the EPW wind speed
for outdoor conditions.
445
outdoorTerrain [Optional]
An interger or text string that sets the terrain class associated with the wind speed used
in outdoor wind calculations. Interger values represent the following terrain classes: 0 =
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).
north [Optional]
Input a vector to be used as a true North direction for the comfort analysis or a number
Outputs
comfRecipe
An analysis recipe for the "Honeybee_Annual Indoor Comfort Analysis" component.
Check Hydra Example Files for Adaptive Comfort Analysis Recipe
446
Indoor View Factor Calculator - [source

code]
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]
447
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 floor
of the zones. Alternatively, this can be a surface or list of surfaces on which you are
interested in studying thermal comfort. Lastly, it can be a list of points at which you want
to evaluate microclimate conditions.
additionalShading [Optional]
Add additional shading breps or meshes to account for geometry that is not a part of the
zone but can still block direct sunlight to occupants. Examples include outdoor context
shading and indoor 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 additionalShading
input 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 are
outdoors 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]
448
An interger between 0 and 4 to set the number of times that the tergenza skyview
patches are split. A higher number will ensure a greater accuracy but will take longer.
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.
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
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.
449
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
450
Matrix_to_Data_Tree
Matrix to Data Tree - [source code]
This component converts a comfort result matrix into a Grasshopper Data Tree with
numerical values. -
Inputs
comfResultsMtx [Required]
A matrix of comfort data that
Outputs
451
Matrix_to_Data_Tree
comfResultsTree
A Grasshopper Data Tree of comfort data with numerical float values.
Check Hydra Example Files for Matrix to Data Tree
452
Microclimate Map Analysis - [source code]
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.
453
fileName [Optional]
An optional file name for the result files as a string.
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 into
the 'Honeybee_Visualize Annual Comfort Results' component.
454
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
455
456
Outdoor Comfort Analysis Recipe - [source

code]
Inputs
Factor Calculator".
457
epwFile [Required]
occupants.
srfIndoorTemp [Optional]

component.
srfOutdoorTemp [Required]

component.
zoneAirTemp [Optional]
zoneRelHumid [Optional]
The relativeHumidity output of the "Honeybee_Read EP Result" component.
zoneAirFlowVol [Optional]
zoneAirHeatGain [Optional]
458
459
north [Optional]
Outputs
comfRecipe
Check Hydra Example Files for Outdoor Comfort Analysis Recipe
460
PET_Analysis_Recipe
PET Analysis Recipe - [source code]
Inputs
Factor Calculator".
461
PET_Analysis_Recipe
epwFile [Required]
occupants.
srfIndoorTemp [Optional]

component.
srfOutdoorTemp [Required]

component.
zoneAirTemp [Optional]
zoneRelHumid [Optional]
zoneAirFlowVol [Optional]
zoneAirHeatGain [Optional]
bodyCharacteristics [Optional]
A list of body characteristics in the following order: age, sex, height, weight,
bodyPosition, clothingInsulation, acclimated, metabolicRate, activityDuration. Use
Ladybug's "Body Characteristics" component to generate it. -
If not supplied, the following default values

will be used:
462
PET_Analysis_Recipe
30 - age "male" - sex 175 - height in centimeters 75 - weight in kilograms "standing" -

bodyPosition None (clothingInsulation - "None" means that it will be calculated based on
air temperature) 37 - clothingAlbedo in % (for medium colored clothes) "unacclimated" -
acclimated 2.32 - metabolicRate in mets (2.32 corresponds to walking 4km/h) 480 -
activityDuration in minutes
temperateOrTropical [Optional]
Set to "True" to have the component use the tropical/subtropical/humid categories to

determine whether the conditions are cold, hot, or comfortable. Set to "False" to use
categories for a temperate climate. The tropical categories were determined by Lin and
Matzarakis (2008) and the temperate categories were determined by Matzarakis and
Mayer (1996). The default is set to "True" for tropical/subtropical categories.
463
PET_Analysis_Recipe
north [Optional]
Outputs
comfRecipe
Check Hydra Example Files for PET Analysis Recipe
464
PET_Analysis_Recipe
465
PMV Comfort Analysis Recipe - [source

code]
Inputs
Factor Calculator".
466
epwFile [Required]
occupants.
srfIndoorTemp [Required]

component.
srfOutdoorTemp [Optional]

component.
zoneAirTemp [Required]
zoneRelHumid [Required]
zoneAirFlowVol [Required]
zoneAirHeatGain [Required]
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
467
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.
468
north [Optional]
Outputs
comfRecipe
Check Hydra Example Files for PMV Comfort Analysis Recipe
469
470
Read Microclimate Matrix - [source code]
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.
471
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
472
Thermal Autonomy Analysis - [source code]
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 thermal
comfort 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
473
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
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
The list of view factor meshes that comes out of the "Honeybee_Indoor View Factor
Calculator".
HBZones [Required]
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
474
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.
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 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 for the TCPocc
and TCA matrices.
runIt [Required]
Set boolean to "True" to run the component and calculate comfort autonomy.
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
475
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.
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.
476
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
477
Visualize Microclimate Map - [source code]
Use this component to produce a colored mesh from a comfResultsMtx. -
Inputs
Any matrix output from the 'Honeybee_Microclimate Map Analysis' component, the
'Honeybee_Thermal Comfort Autonomy Analysis' component, or the 'Honeybee_Read
478
The list of view factor meshes that comes out of the 'Honeybee_Indoor View Factor
Calculator'. These will be colored with result data.
Optional analysisPeriod to take a slice out of the data stream. Note that that connecting
a value to 'stepOfSimulation' will override this input.
Optional interger to select out a step of the simulation to color the mesh with.
Connecting a value here will override the analysisPeriod_ input.
percentOrTotal [Optional]
Set to 'True' to have the component compute comfort values as a percent of occupied
hours or all hours. Set to 'False' to have the component compute comfort values as a
total number of hours. The default is set to 'True' to calculate comfort as a percent. Note
that this input only works for comfort matrices and not temperature ones.
runIt [Optional]
Set boolean to "True" to run the component and produce a colored mesh from a
comfResultsMtx.
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" component
in order to preview the legend spearately in the Rhino scene.
479
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
480
Apply OpenStudio Measure - [source code]
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
481
osmFilePath [Required]
A file path of the an OpemStdio file
OSMeasures [Required]
Any number of OpenStudio measures that you want to apply to your OepnStudio model.
Use the "Honeybee_Load OpenStudio Measure" component to load a measure into
Grasshopper
runIt [Required]
Generate an IDF from the OSM file but do not run it through EnergyPlus 4 = Run the
OSM and IDF through EnergyPlus using only OpenStudio CLI (note that there will be no
resultFileAddress produced in this case).
Outputs
readMe!
...
osmFileAddress
The file path of the OSM file that has been generated on your machine.
idfFileAddress
resultFileAddress
The file path of the CSV result file that has been generated on your machine.
eioFileAddress
482
rddFileAddress
htmlReport
Tthe file path to the HTML report that was generated after running the file through
EnergyPlus. Open this in a web browser for an overview of the energy model results.
studyFolder
Grasshopper.
Check Hydra Example Files for Apply OpenStudio Measure
483
Balance Temperature Calculator - [source

code]
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
484
schedule. This component works by taking the average combined heating/cooling

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
thermalLoadBal [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 weekend
schedule 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
485
Make_Adiabatic
Make Adiabatic - [source code]
Make Adiabatic -
Inputs
HBSrfs [Optional]
A list of valid Honeybee surfaces
Outputs
486
Make_Adiabatic
HBSrfs
Modified list of Honeybee surfaces with
Check Hydra Example Files for Make Adiabatic
487
Make Adiabatic by Name - [source code]
Make Adiabatic -
Inputs
HBObjs [Optional]
A list of valid Honeybee surfaces
byName [Optional]
A list of valid surface names
488
Outputs
HBObjs
Modified list of Honeybee surfaces with
Check Hydra Example Files for Make Adiabatic by Name
489
Normalize Data by Floor Area - [source code]
This component takes data that has been output from a simulation and normalizes the
results by the floor area of the HBZones. -
Inputs
simData [Required]
Results from one of the Read Result components.
HBZones [Required]
490
Outputs
totNormData
The results normalized by the floor area of all connected HBZones.
zoneNormData
The results normalized by the floor area of each of the connected HBZones. Note that
this will not be output is the connected data is not for the individual zones.
Check Hydra Example Files for Normalize Data by Floor Area
491
OpenStudio_to_gbXML
OpenStudio to gbXML - [source code]
Use this component to export OpenStudio model to gbXML file. -
Inputs
model [Required]
An OpenStudio model.
filepath [Required]
Full filepath to xml file.
492
OpenStudio_to_gbXML
export [Required]
Set to True to export the model.
Outputs
readMe!
success
True on success.
Check Hydra Example Files for OpenStudio to gbXML
493
Re-run_IDF
Re-run IDF - [source code]
This is a component for running a previoulsy-generated .idf file through EnergyPlus. -
Inputs
idfFilePath [Required]
The full file path to the idf file on your system that you would like to run (e.g.
C:\ladybug\sample1.idf).
epwFileAddress [Required]
494
Re-run_IDF
The full file path to epw weather file that you would like the simulation to run with.
parallel [Optional]
Set to "True" to run multiple IDFs using multiple CPUs. Note that this input is only
relevant when you have plugged in a list of IDF file addresses.
runIt [Required]
Set to 'True' to run the simulation.
Outputs
report
Report!
resultFileAddress
The address of the EnergyPlus result file.
eioFileAddress
rddFileAddress
Check Hydra Example Files for Re-run IDF
495
Re-run_OSM
Re-run OSM - [source code]
This is a component for running a previoulsy-generated .osm file through EnergyPlus. -
Inputs
osmFilePath [Required]
A full file path to an OpenStdio Model (.osm) file.
epwFileAddress [Required]
A full file path to an epw weather file.
496
Re-run_OSM
parallel [Optional]
Set to "True" to run multiple IDFs using multiple CPUs. Note that this input is only
relevant when you have plugged in a list of OSM file addresses.
runIt [Required]
Generate an IDF from the OSM file but do not run it through EnergyPlus
Outputs
readMe!
Report!
idfFileAddress
resultFileAddress
The address of the EnergyPlus result file.
eioFileAddress
rddFileAddress
Check Hydra Example Files for Re-run OSM
497
Re-run_OSM
498
Read_EP_HVAC_Result
Read EP HVAC Result - [source code]
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
499
Read_EP_HVAC_Result
Outputs
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 (%).
unmetHoursCooling
Time Zone Cooling Setpoint Not Met Time
unmetHoursHeating
Time Zone Heating Setpoint Not Met Time
Check Hydra Example Files for Read EP HVAC Result
500
Read_generation_system_results - [source
code]
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. -
501
Inputs
idfFileAddress [Required]
The IDF file address that comes out of the WriteIDF component.
Outputs
Readme!
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
502
ShadowPar
ShadowPar - [source code]
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
503
ShadowPar
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
504
Simulation_Control
Simulation Control - [source code]
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."
505
Simulation_Control
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
506
Surface Data Based On Type - [source code]
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
507
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
508
Surface Data Based On Type Detailed -

[source code]
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
509
HBZones [Required]
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
510
A grafted list of surface data for exposed floors.
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
511
gbXML_to_Honeybee
gbXML to Honeybee - [source code]
Import gbXML files as Honeybee zones. This component uses OpenStudio libraries to
import all geometry, constrcuctions, and boundary conditions (including adjacencies). Loads,
schedules, and HVAC systems are not currently imported by this component and must be
reassigned using Honeybee components. -
Inputs
filepath [Required]
Full filepath to xml file.
512
gbXML_to_Honeybee
zoneNames [Required]
The list of names for thermal zones that you want to be loaded from the file. By default
the component will import all the zones.
import [Required]
Set to True to import the model.
Outputs
readMe!
model
OpenStudio model which is created from the gbXML file. This output will only be useful
for advanced users to develop custom scipts.
HBZones
List of honeybee zones.
shadings
List of shading surfaces if any.
Check Hydra Example Files for gbXML to Honeybee
513
11 | THERM
Component list:
Import_WINDOW_Glz_System
Write_THERM_File
Create_Therm_Boundaries
Create_Therm_Polygons
Assembly_Uvalue
Import_WINDOW_IDF_Report
Import_THERM_XML
Read_THERM_Result
Custom_Radiant_Environment
Therm_Material
Therm_Material_to_EnergyPlus_Material
Thermally_Bridged_EP_Construction
514
Import WINDOW Glz System - [source code]
Use this component to import the content of a LBNL WINDOW text file report as a series of
polygons and boundary conditions that can be plugged into the "Write THERM File'
component. -
Inputs
windowGlzSysReport [Required]
A filepath to a detailed galzing system text file report exportedby WINDOW.
515
location [Default]
An optional plane or point to set the location of the glazing system in the Rhino scene.
The default is set to the Rhino origin and in the XY plane.
orientation [Default]
An integer that sets the orientation of the window in the Rhino scene. Choose from the
following options that correspond with THERM's options: 0 = Up 1 = Down 2 = Left 3 =
Right
sightLineToGlzBottom [Default]
A number in Rhino model units that represents the distance from the bottom of the glass
pane to the end of the frame (where the 'edge of glass' starts). The default is set to 12.7
mm.
spacerHeight [Default]
A number in Rhino model units that represents the distance from the bottom of the glass
pane to the end of the spacer. The default is set to 12.7 mm.
edgeOfGlassDim [Default]
A number in Rhino model units that represents the distance from the start of the frame
to the start of the 'center of glass' zone. This 'edge of glass' zone typically has a U-
Value that is higher than the rest of the glass. The default is set to 63.5 mm.
glzSystemHeight [Default]
A number in Rhino model units that represents the height to make the glazing system in
the Rhino scene. The default is set to 150 mm.
spacerMaterial [Optional]
An optional material that will be used to create a spacer for the glazing system. If no
material is input here, no psacer will be created.
Outputs
readMe!
...
thermPolygons
516
The therm polygons for the glazing system.
indoorBCs
The thermBCs that represent the interior side of the glazing system, including separate
boundary conditions for the edge of frame and center of glass. Note that a boundary
condition for with the 'Frame' UFactorTag must be made separately.
outdoorBC
A single thermBC that represents the exterior side of the glazing system. This includes
the exterior conditions taken from the report.
indoorProperties
A list of properties for the interior boundary condition in the following order: Name,
temperature, film coefficient. These can be used to create a boundary condition for the
'Frame.'
outdoorProperties
A list of properties for the exterior boundary condition in the following order: Name,
temperature, film coefficient. These can be used to create a boundary condition that
includes the frame of the window.
cogUValue
A value representing the "center of glass" U-value for the imported WINDOW glazing
construction in SI units (W/m2-K). This output can be used in conjunction with the
"Honeybee_Assembly Uvalue" component to calculate the full U-value of a window
assembly.
SHGC
The solar heat gain coefficient of the WINDOW glazing construction.
VT
The visible transmittance of the WINDOW glazing construction.
Check Hydra Example Files for Import WINDOW Glz System
517
Write_THERM_File
Write THERM File - [source code]
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.
518
Write_THERM_File
boundaries [Optional]
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 8, which is the highest level available. If your model is not too
complex, you may want to lower this to decrease the runtime.
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]
Set to "True" to have the component take your connected UWGParemeters and write
them into an XML file. The file path of the resulting XML file will appear in the
xmlFileAddress output of this component. Note that only setting this to "True" and not
setting the output below to "True" will not automatically run the XML through the Urban
Weather Generator for you.
runTHERM [Optional]
Script variable writeTHERM
Outputs
readMe!
...
thermFile
The file path of the therm XML file that has been generated on your machine. Open this
file in THERM to see your exported therm model.
519
Write_THERM_File
resultFile
The file path of the THERM results including the mesh of the therm geometry and the
values of temperature / heat flow at each point of the mesh. Note that this file will not be
generated unless runTHERM_ is set to "True" and your calculation is successful.
uFactorFile
The file path to a therm XML file that is written after the simulation is run. This file
contains all results or U-factors accross their respective tags as well as information that
helps place the result mesh in the file above correctly in the Rhino scene. Note that this
file will not be generated unless runTHERM_ is set to "True" and your calculation is
successful.
probRegion
Check this output for the problematic regions of your model (where holes in the model
are).
Check Hydra Example Files for Write THERM File
520
Create Therm Boundaries - [source code]
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]
521
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.
For NFRC conditions, this temperature should be 21 C for interior boundary conditions
and -18 C for exterior boundary conditions.
filmCoefficient [Required]
A numerical value in W/m2-K that represents the convective resistance of the air film at
the boundary condition. Alternatively, you can 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 36 W/m2-K (for an
exterior condition where outdoor wind strips away most convective resistance) to 2.5
W/m2-K (for a vertically-oriented interior wood/vinyl surface). Note that, when inputting
'outdoor', the component will assume an outdoor wind speed of ~4.5 m/s (and a
corresponding film coefficient of 26 W/m2-K). You may want to simulate with a lower
wind speed of 3.4 m/s (filmCoefficient = 22.7 W/m2-K) or a higher wind speed of 6.7 m/s
(filmCoefficient = 34.0 W/m2-K).
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.
customRadEnv [Optional]
A list of radiant environmental properties from the 'Honeybee_Custom Radiant

Environment' component. Inputting values here will create a radiant environment that is
different than typical NFRC conditions.
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]
522
An optional color to set the color of the boundary condition when you import it into
THERM.
Outputs
readMe!
...
thermBoundary
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
523
Create Therm Polygons - [source code]
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!
524
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
525
Assembly_Uvalue
Assembly Uvalue - [source code]
Use this component to calculate the assembly U-Value for a window given an input window
geometry, center of glass U-value, and frame+edge U-value. This component can also add a
frame to a EnergyPlus window construction that has the glass and spacing information. -
Inputs
glazingSrf [Required]
A surface representing the window geomtry for which an assebly U-value is being
calculated. This should be the region of glass only (not frame) and it can be the same
526
Assembly_Uvalue
glazing geometry that is assigned to a Honeybee Zone for an energy simulation.
frameThickness [Required]
A number in Rhino model units representing the thickness of the window frame around
the glazing surface. Specifically, this is the distance from where the glass starts to
where the frame ends, projected into the plane of the glazing surface.
edgeThickness [Default]
A number in Rhino model units that represents the distance from the start of the frame
to the start of the 'center of glass' region of the window. This 'edge of glass' zone
typically has a U-Value that is higher than the rest of the glass. The default is set to 63.5
mm.
cogUvalue [Required]
A number representing the center of glass U-value for the glazing construction in SI
units (W/m2-K).
jambUvalue [Required]
A number representing the U-value of the window frame+edge in SI units (W/m2-K). If

no value is input for the sillUvalue or headUvalue below, this input here will refer to all
window frames of the calculated assembly. Otherwise, it will refer to just the U-value of
the jamb (sides of the window).
sillUvalue [Optional]
A number representing the U-value of the window sill frame+edge in SI units (W/m2-K).
If no value is input here, this component will assume that the sill U-value is the same as
the jamb above.
headUvalue [Optional]
A number representing the U-value of the window head (top) frame+edge in SI units
(W/m2-K). If no value is input here, this component will assume that the head U-value is
the same as the jamb above.
glzConstruction [Optional]
An optional EnergyPlus window construction to which an EnergyPlus frame object will

be added (matching the specification above). It is recommended that this be a
construction from LBNL WINDOW that is imported with the "Honeybee_Import
WINDOW IDF Report." If no construction is input here, no glzConstrWFrame will be
527
Assembly_Uvalue
output from this component.
Outputs
readMe!
...
assemblyUvalue
The U-Value of the entire window assembly in SI units (W/m2-K). This U-value is per
unit area of glass + frame, which is how assembly U-value is defined by ASHRAE and
the building code.
glzSrfUvalue
The assembly U-value normalized by the area of the input _glzSrf (W/m2-K). In other
words, this U-value is per unit area of glass only (not glass + frame). This output is what
should be plugged into the "Honeybee_EnergyPlus Window Material" component if
using the assembly U-value in a Honeybee energy simulation.
glzConstrWFrame
An EnergyPlus window construction that can be assigned to Honeybee Window

Surfaces for EnergyPlus simulations.
cogSrf
A surface showing the region of the _glazingSrf that is interpreted as the Center of
Glass.
jambSrf
A surface showing the region of the _glazingSrf that is interpreted as the Jamb (or sides
of the window).
sillSrf
A surface showing the region of the _glazingSrf that is interpreted as the Sill.
headSrf
A surface showing the region of the _glazingSrf that is interpreted as the Head (or top of
the window).
Check Hydra Example Files for Assembly Uvalue
528
Assembly_Uvalue
529
Import WINDOW IDF Report - [source code]
Use this component to import an EnergyPlus window construction from LBNL WINDOW.
This construction can then be assigned to any Honebee window for an EnergyPlus model. -
Inputs
windowIDFReport [Required]
A filepath to a 'EnergyPlus IDF' report exported by LBNL WINDOW.
Outputs
530
EPConstruction
An EnergyPlus construction that can be assigned to any window in Honeybee using

components like 'Honeybee_addHBGlz', 'Honeybee_Glazing based on ratio', or
'Honeybee_Set EP Zone Construction'.
Check Hydra Example Files for Import WINDOW IDF Report
531
Import_THERM_XML
Import THERM XML - [source code]
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. _ At this point in time, U-Factor tags are not supported but all other features
should be imported. -
Inputs
thermXMLFile [Required]
A filepath to a therm XML file on your machine.
532
Import_THERM_XML
basePlane [Optional]
An optional plane or point to set the location and orientation of the THERM file geometry
in the Rhino scene. The default will seatch for location information within the THERM
file and, if none is found, geomtry is brought into the World XY plane.
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
533
Read_THERM_Result
Read THERM Result - [source code]
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
534
Read_THERM_Result
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 simulation
writes this file.
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.
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, the
THERM results are imported with their THERM canvass coordinates.
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 W/m2)
SIorIP [Optional]
Set to 'True' to have all data imported with SI units (Celcius and W/m2) and set to
'False' to have all data imported with IP Units (Farenheit and BTU/ft2). The default is set
to 'True' for SI.
Optional legend parameters from the Ladybug "Legend Parameters" component.
runIt [Required]
535
Read_THERM_Result
Outputs
uFactorTags
The names of each of the uFactor tags (including information about projections for each
of the tags).
uFactors
The U-Factors accross each boundary condition that has been definted with a
uFactorTag. This will be in W/m2-K if SIorIP is set to 'True' or in BTU/h-ft2-F if set to
'False.'
uFactorLength
The lengths of the boundary condition defined by the U-Factor tags. This will be in mm if
SIorIP is set to 'True' or in inches if set to 'False.'
deltaT
The temperature delta across each of the uFactor tags.
meshValues
The numerical meshValues of the results in either degrees C or W/m2 (depending on

the dataType_ 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
536
Read_THERM_Result
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
537
Custom Radiant Environment - [source

code]
Use this component to create a custon radiant environment for THERM boundary condition.
Assigning values here will create radiant conditions that are different from normal NFRC
conditions (where radiant temperature equals air temperature, the emissivity of the
environment is assumed to be 1, and viewFactor between the boundary and the
envrionment is calculated using the geometry of the boundary). -
Inputs
538
radiantTemp [Optional]
A value in degrees Celcius that represents the radiant temperature of the environment.
If no value is plugged in here, the radiant environment will be assumed to have the
same temperature as the air.
envEmissivity [Optional]
A value between 0 and 1 that represents the emissivity of the environment. Use this ti
account for environments made of atypical materials like metals. If no value is plugged
in here, it will be assumed that the envrionment has an emissivity of 1.
viewFactor [Optional]
An optional value between 0 and 1 that sets the view factor of the boundary to the
surrounding exterior/interior environment. Alternatively, you can simply input the word
'auto' and the view factor will be calculated using THERM's 'Automatic Enclosure'
model, which will check the geometry of the boundary condition to see if the boundary is
concave (meaning that the boundary blocks some of the view of itself to the
environment). If a view factor number is connected here, THERM's 'Blackbody
Radiation' model will be used and the view factor specified will determine the radiative
heat transfer. A view factor of 1 implies that all edges of the boundary can see 100% of
the exterior environment. _ If this is left blank, the 'Automatic Enclosure' model will be
used any time an indoor film coefficient is specified (< 10 W/m2K). A 'Blackbody
Radiation' model with a view factor of 1 will be used for all outdoor film coefficients (> 10
W/m2K). These default boundary conditions assume compliance with the NFRC
standard.
heatFlux [Optional]
An optional numerical value in W/m2 that represents additional energy flux across the
boundary condition. You can use this to account for solar flux across the exterior
boundary condition.
Outputs
customRadEnv
A list of radiant environmental properties that can be plugged into the

'Honeybee_Create Therm Boundaries' component in order to run a THERM simulation
with a atypical radiant environment.
Check Hydra Example Files for Custom Radiant Environment
539
540
Therm_Material
Therm Material - [source code]
Use this component to create a custom THERM material, which can be plugged into the
"Honeybee_Create Therm Polygons" component. -
Inputs
A text name for your THERM Material.
conductivity [Required]
541
Therm_Material
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.
A number between 0 and 1 that represents the emissivity of the material. The default is
set to 0.9.
cavityModel [Optional]
An integer that represents the cavity model to use for the material (if it is a gas). If you
are creating a solid material, just leave this input blank. Cavity models (4 - ISO 15099)
and (5 - ISO 15099 ventilated) are used for most situations. Choose from the following
options: 0 - NFRC 1 - CEN 2 - CEN (slightly ventilated) 3 - NFRC with user dimensions
4 - ISO 15099 5 - ISO 15099 ventilated
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
542
Therm Material to EnergyPlus Material -

[source code]
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." -
543
Inputs
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 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
EPMaterialStr
An opaque material that can be plugged into the "Honeybee_EnergyPlus Construction"

component.
matName
The name of the generated EP Material.
Check Hydra Example Files for Therm Material to EnergyPlus Material
544
Thermally Bridged EP Construction - [source

code]
Use this component to adjust the U-value an EP construction without any thermal bridges to
account for birdges by adjusting the condutivity of one of the materials. -
Inputs
originalEPConstruction [Required]
An EP construction that does not have any thermal bridges associated with it.
545
thermBridgedUValue [Required]
The U-value in SI units (W/m2-K) that you would like the whole construction assembly
to be adjusted to. This U-value should include the resistance of air films on either side of
the construction assembly, which is included by default in the output from THERM
simulations.
materialToAdjust [Required]
The name of a material within the _originalEPConstruction that you would like to have
the conductivity adjusted to meet the _thermBridgedUValue.
customName [Default]
An optional custom name to be added to the new thermally bridged material and
construction.
Outputs
readMe!
...
bridgedConstruction
A thermally bridged construction that can be applied to HBZones and HBSurfaces for
energy simulations.
bridgedConstrText
The IDF text that defines the thermally bridged construction that has been written to the
memory of the document.
bridgedMaterialText
The IDF text that defines the thermally bridged material within the construction.
bridgedMatRValue
The R-value of the newly created thermally bridged material.
Check Hydra Example Files for Thermally Bridged EP Construction
546
12 | Developers
Component list:
Update_Honeybee
547
Update_Honeybee
Update Honeybee - [source code]
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.
548
Update_Honeybee
updateAllUObjects [Required]
Set to True to sync all the Ladybug and Honeybee userObjects
Outputs
readMe!
...
Check Hydra Example Files for Update Honeybee
549
13 | WIP
Component list:
Condensation_calculator
Import_idf
Customize_EnergyPlus_Objects
ExportEPC
Visualise_Honeybeegeneration_cashflow
550
Condensation calculator - [source code]
Use this component to calculate the Dew Point, Relative Humidity and Condensation on
each layer of a wall. It accounts the air films (internal and external). Sources:
http://andrew.rsmas.miami.edu/bmcnoldy/Humidity.html
http://www.ajdesigner.com/phphumidity/dewpoint_equation_dewpoint_temperature.php#ajsc
roll http://forums.finehomebuilding.com/breaktime/energy-heating-insulation/dewpoint-
spreadsheet -
Inputs
cnstrName [Required]
551
EnergyPlus construction name
An integer value from 0 to 3 that represents one of the following surface types: 0 -
Exterior Wall/Window 1 - Exterior Roof 2 - Exposed Floor
internalTemp [Required]
Indoors temperature of room
outTemp [Required]
Outdoors temperature of room
internalRelativeHumidity [Required]
Indoors relative humidity
basePoint [Default]
An optional point with which to locate the 3D chart in the Rhino Model. The default is set
to the Rhino origin at (0,0,0).
scale [Default]
The scale of the surface type section. The default is set to 1.
bakeIt [Optional]
An integer that tells the component if/how to bake the bojects in the Rhino scene. The
default is set to 0. Choose from the following options: 0 (or False) - No geometry will be
baked into the Rhino scene (this is the default). 1 (or True) - The geometry will be baked
into the Rhino scene as a colored hatch and Rhino text objects, which facilitates easy
export to PDF or vector-editing programs. 2 - The geometry will be baked into the Rhino
scene as colored meshes, which is useful for recording the results of paramteric runs as
light Rhino geometry.
Outputs
readMe!
...
materials
552
List of materials (from outside to inside). Includes film Air layers. Ordered from Inside to
Outside layers. They include Air Films.
comments
Comments for each layer of materials if any. Ordered from Inside to Outside layers
rWall
rWall
tempWall
temperature for each layer in wall (outter edge of layer). Ordered from Inside to Outside
layers
rhWall
relative humdity for each layer in wall (outter edge of layer). Ordered from Inside to
Outside layers
dewPointWall
Dew Point for each layer in wall (outter edge of layer). Ordered from Inside to Outside
layers
condensationWall
State the status of condensation on wall (Yes or No). Ordered from Inside to Outside
layers
layersWallGeo
layersWallGeo
resultLines
resultLines
resultLinesColors
resultLinesColors
scaleRH_TempGeo
scaleRH_TempGeo
allLabels
553
allLabels
finalJoinedMesh
finalJoinedMesh
legend
legend
allLabels
Script variable HB_CondensationCalculator
wallLegendCoord
wallLegendCoord
allDataCurves
allDataCurves
textSize
textSize
decimalPlaces
decimalPlaces
Check Hydra Example Files for Condensation calculator
554
Import_idf
Import idf - [source code]
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]
555
Import_idf
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
556
Customize EnergyPlus Objects - [source

code]
Customize EnergyPlus Objects [NOT READY YET!] -
Inputs
EPObjectName [Required]
indexes [Optional]
557
values [Optional]
Outputs
originalObj
modifiedObj
Check Hydra Example Files for Customize EnergyPlus Objects
558
ExportEPC
ExportEPC - [source code]
Export to Energy Performace Calculator (EPC) ... Add more description here -
Inputs
HBZones [Required]
Honeybee Zones
Outputs
559
ExportEPC
readMe!
Check Hydra Example Files for ExportEPC
560
Visualise_Honeybeegeneration_cashflow -
[source code]
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
561
consume the electricity generated. This will generate a revenue as the facility did not have to
purchase 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. -
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
rate just specify one value this will be used across all the hours of the year. Otherwise
specify the grid electricity cost for 288 hours of the year that is for each hour of the day
for one day in every month of the year. Use a list with 288 values to do this.
feedInTariffSchedule [Required]
The price that the utility will pay per Kwh in US dollars for power fed back into the grid. If
you want to specify a flat rate just specify one value this will be used across all the
hours of the year. Otherwise specify the grid electricity cost for 288 hours of the year
that is for each hour of the day for one day in every month of the year. Use a list with
288 values to do this.
graphDataByHBSystem [Optional]
Set to True to visualise the the financial value of each Honeybee generation system.
graphDataByCost [Optional]
Set to True to sum each Honeybee generation system's costs and revenues together
and then to visualise these figures by type e.g replacement costs, capital costs etc. to
visualise each generator system by cost run mutliple Energy Plus simulations and
visualise results seperately.
562
xScale [Default]
The scale of the X axis of the graph. The default will plot the X axis with a length of 215
Rhino model units
zScale [Default]
The scale of the Y axis of the graph. The default will plot the Z axis with a length of 85
Rhino model units
fontSize [Default]
An optional input, use a float to change the size of the font on the graph.
basePoint [Default]
An optional input, use a 3D point to locate the 3D chart in the Rhino Model. The default
is set to the Rhino origin at (0,0,0).
Outputs
Readme!
gensystem_value
The net present cost of each Honeybee generation system. The net present cost is the
present value of all the costs of installing and operating that Honeybee generation
system over 25 years minus the present value of the all the revenues that the system
earns over 25 years. Thus a positive value means that compared to just buying
electricity from the grid the Honeybee generation system will save money while a
negative value means that it will be more cost effective to simply buy electricity from the
grid.
dataMeshes
Script output dataMeshes.
axisMeshes
Script variable HB_GeneratorCashflow
textSrfs
Script output textSrfs.
563
Check Hydra Example Files for Visualise_Honeybeegeneration_cashflow
564

Honeybee Primer Components

Caricato da

Informazioni sul documento

Titolo originale

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

Honeybee Primer Components

Caricato da

Copyright:

Formati disponibili

Table

Honeybee for Grasshopper

You need to have Ladybug installed in order to use Honeybee.

Honeybee group page on Grasshopper

AskMe - [source code]

Any valid Honeybee object.

Information about the Honeybee object. Connect to a panel to visualize.

Check Hydra Example Files for AskMe

Honeybee - [source code]

Current Honeybee mood!!!

Check Hydra Example Files for Honeybee

Find Non-Convex - [source code]

A list of breps that you wish to scan for non-convex surfaces

A list of non-convex surfaces, if found in breps provided.

Check Hydra Example Files for Find Non-Convex

IntersectMasses - [source code]

Script input bldgMassesBefore.

Check Hydra Example Files for IntersectMasses

SplitBuildingMass2Floors - [source code]

Use this component to divide up a brep (polysurface) representative of a complete building

A Closed brep or list of closed breps representing a building massing.

Script input _runIt.

Check Hydra Example Files for SplitBuildingMass2Floors

SplitFloor2ThermalZones - [source code]

Script input _runIt.

A series of breps that correspond to the recommended means of breaking up building

Check Hydra Example Files for SplitFloor2ThermalZones

Glazing based on ratio - [source code]

Honeybee thermal zones or surfaces for which glazing should be generated.

will be over-ridden at high glazing ratios. The default is set to 2 meters.

set runIt to True to generate the glazing

Check Hydra Example Files for Glazing based on ratio

Masses2Zones - [source code]

A list of zone programs from the Honeybee_ListZonePrograms component that matches

assigned to them. Connect these to a "Honeybee_Label Zones" component to see

Check Hydra Example Files for Masses2Zones

Solve Adjacencies - [source code]

An optional alternate EP construction to assign to all adjacent surfaces. The default is

An optional alternate EP window construction to assign to all adjacent surfaces. The

An optional alternate boundary condition such as "Adiabatic". The default will be

Set to "True" to solve adjacencies between zones.

A report of the found adjacencies.

A list of Honeybee zones with adjacencies solved.

Check Hydra Example Files for Solve Adjacencies

addHBGlz - [source code]

Use this component to add a custom glazing surface to a HBSurface or HBZone. -

An optional list of EnergyPlus constructions to set the material construction of the

Check Hydra Example Files for addHBGlz

createHBSrfs - [source code]

Optional name for surface

'Ground', 'Adiabatic', 'Outdoors'

Optional EnergyPlus construction

Optional Radiance Material

Honeybee zone as the result

Check Hydra Example Files for createHBSrfs

createHBZones - [source code]

Create an HBZone from HB Surfaces

The name of the zone as a string

Optional input for the program of this zone

A list of Honeybee Surfaces

Honeybee zone as the result

Check Hydra Example Files for createHBZones

Decompose Based On Boundary Condition -