Grasshopper Docs

Community documentation for Grasshopper add-ons & plugins

00 | Honeybee
01 | Daylight | Material
02 | Daylight | Light Source
03 | Daylight | Recipes
04 | Daylight | Daylight
05 | Energy | Building Program
06 | Energy | Material | Construction
07 | Energy | Schedule
08 | Energy | Set Zone Properties
09 | Energy | HVACSystems
10 | Energy | Energy
11 | THERM
12 | Developers
13 | WIP

Use this component to color zones based on EnergyPlus data out of the "Honeybee_Read EP Result" component or zone comfort analyses out of the comfort calculator components.
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.


Zone Data_zoneDataA list zone data out of the Read EP Result component or the comfort calculator components that have zone data hooked up to them.Goo
HBZones_HBZonesThe HBZones out of any of the HB components that generate or alter zones. Note that these should ideally be the zones that are fed into the Run Energy Simulation component or zones read back into Grasshopper from the Import idf component in order to ensure alignment with the EP Result data.Goo
Normalize By Floor AreanormalizeByFloorArea_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).Goo
Analysis PeriodanalysisPeriod_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.Goo
Step Of SimulationstepOfSimulation_Optional interger for the hour of simulation to color the zones with. Connecting a value here will override the analysisPeriod_ input.Goo
Legend ParlegendPar_Optional legend parameters from the Ladybug Legend Parameters component.Goo
Run It_runItSet boolean to 'True' to run the component and color the zones.Goo


Read Me!readMe!...String
Zone Colored MeshzoneColoredMeshA list of meshes for each zone, each of which is colored based on the input _zoneData.Goo
Zone Wire FramezoneWireFrameA 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.Goo
LegendlegendA legend of the zone colors. Connect this output to a grasshopper 'Geo' component in order to preview the legend spearately in the Rhino scene.Goo
Legend Base PtlegendBasePtThe legend base point, which can be used to move the legend in relation to the building with the grasshopper 'move' component.Goo
Analysis TitleanalysisTitleThe title of the analysis stating what the zones are being colored with.Goo
Zone BrepszoneBrepsA 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.Goo
Zone ColorszoneColorsA 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.Goo
Zone ValueszoneValuesThe values of the input data that are being used to color the zones.Goo
Relevant Zone DatarelevantZoneDataThe input data used to color the zones.Goo

Video Tutorials

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

Report an Issue  |  Terms of Service