Grasshopper Docs

Community documentation for Grasshopper add-ons & plugins

Ladybug

ADDON. Version 0.0.68. Released on 2020-Jan-01. Provides 153 components. Created by Ladybug Tools. Features 34 video tutorials.
Ladybug allows you to import and analyze standard weather data in Grasshopper; draw diagrams like Sun-path, wind-rose, radiation-rose, etc; customize the diagrams in several ways; run radiation analysis, shadow studies, and view analysis.
0 | Ladybug
1 | AnalyzeWeatherData
2 | VisualizeWeatherData
3 | EnvironmentalAnalysis
4 | Renewables
5 | Extra
6 | Developers
7 | WIP

5 | Extra

Body Characteristics
Use this component to calculate the Basal Metabolic Rate, Body Mass Index indices and to create the "bodyCharacterstics_" input for the "Thermal comfort indices" component
BTU2Wh
Use this component to convert energy values in BTU to Wh or kBTU to kWh
True North
Use this component to calculate Earth's true north from magnetic north
DOY HOY
Use this component to calculate the day of the year and hour of the year from an input date with a day of the month, month of the year and hour of the day
Set the View
Use this component to set the camera location and direction for the Rhino "Perspective" viewport
Cfm2M3s
Use this component to convert volume flow rate from U
Orientation Study Parameters
Use this component with the Ladybug "Radiation Analysis", "Sunlight Hours Analysis", or "View Analysis" component to set up the parameters for an Orientation Study
ms2mph
Convert from m/s to mile/h
Activities Met List (ActivitiesList)
Provides a list of available activites and outputs the metabolic rate of that activity for use in the Ladybug PMV comfort calculator
Passive Strategy List (StrategyList)
Provides a list of passive thermal strategies to be plugged into the Ladybug_Psychrometric Chart
L2G
Use this component to convert the liquid volume from Liters to U
Render View
Use this component to render Rhino views and save them to your hard drive
North
Use this component to create a compass sign that indicates the direction of North in the Rhino scene
fly (FLY!)
Use Fly to cycle through all connected sliders
Separate By Normal
Select surfaces based on orientation
Texture Maker
Use this component to generate textures from colored meshes
Construct Time
Use this component to construct a specific hour from corresponding time in hours, minutes and seconds
Orient to Camera
Use this component to generate a plane that is oriented perpendicular to the active Rhino viewport camera direction and centered at an input _initPosition point
Combine Solar Envelopes
Use this component to combine two or more solar envelopes from Ladybug_SolarEnvelope component
Generate Mesh
Use this component to genrate a mesh with corresponding test points
Beaufort Ranges
This component outputs conditional statements as per beaufort scale that you can plug in conditionaStatement_ input of wind rose component
Clothing List (Ladybug_Clothing List)
Provides a list of various clothes and values
F2C
Use this component to convert temperatures from Fahrenheit to Celcius
Shading Parameters List
Use this component to generate shading depths, numbers of shades, horizontal or vertical boolean values, and shade angles for different cardinal directions to be plugged into the "Ladybug_Shading Designer" component or the "Honeybee_EnergyPlus Window Shade Generator"
u IP2u SI
Use this component to convert U-Values in IP (BTU/h·ft2·°F) to U-Values in SI (W/K·m2) to plug into any of the Honeybee material components
C2F
Use this component to convert temperatures from Celcius to Fahrenheit
Real Time Radiation Analysis
Use this component to scroll through the results of a Ladybug Radiation Analysis on an hour-by-hour, day-by-day, or month-by-month basis in real time!
The component uses a sky matrix (SkyMxt) from the selectSkyMxt component and the intersection matrix (intersectionMxt) from the Radiation Analysis component to calculate real time radiation results
Create Legend
Use this component to create a custom legend for any set of data or to create a more flexible legend for any ladybug component with a legend
lux2ft-cd
Use this component to convert illuminance from lux to foot-candles
Capture View
Use this component to capture Rhino views and save them to your hard drive as as a
Passive Strategy Parameters
Use this component to adjust the assumptions of the passive strategies that can be overalid on the Ladybug the Psychrometric Chart
Mesh-To-Hatch
Use this component to bake a clored mesh into the Rhino scene as a series of colored hatches
Image Viewer (Viewer)
Preview image files
Please find the source code from:
https://github
Day Month Hour
Use this component to calculate date information from an hour of the year
Recolor Mesh
Use this component to re-color a mesh with new a numerical data set whose length corresponds to the number of faces in the _inputMesh
BTUft2Whm
Use this component to convert energy values in BTU/ft2 to Wh/m2 (or kBTU/ft2 to kWh/m2)
Mesh Threshold Selector
Use this component to select out the part of a colored mesh that meets a certain conditional statement
Comfort Mannequin
Use this component to color a mannequin based on their relation to a comfort temperature
Adaptive Comfort Parameters
Use this component to set Adaptive comfort parameters for the Adaptive Comfort Calculator or the Adaptive Comfort Chart
False Start Toggle (Toggle)
Just like a normal Boolean Toggle, except it always reverts to "False" on file open
Legend Parameters
Use this component to change the colors, numerical range, and/or number of divisions of any Ladybug legend along with the corresponding colored mesh that the legend refers to
Wh2BTU
Use this component to convert energy values in Wh to BTU (or kWh to kBTU)
MRT Calculator
Use this component calculate Mean Radiant Temperature (MRT) given a set of temperatures and corresponding view factors
M3s2Cfm
Use this component to convert volume flow rate from S
r IP2r SI
Use this component to convert R-Values in IP (h·ft2·°F/BTU) to R-Values in SI (K·m2/W) to plug into any of the Honeybee material components
Whm2BTUft
Use this component to convert energy values in Wh/m2 to BTU/ft2 (or kWh/m2 to kBTU/ft2)
Gradient Library
Use this component to access a library of typical gradients useful throughout Ladybug
PMV Comfort Parameters
Use this component to set PMV comfort parameters for the PMV comfort calculator or the Psychrometric Chart
u SI2u IP
Use this component to convert U-Values in SI (W/K·m2) to U-Values in IP (BTU/h·ft2·°F)

3 | EnvironmentalAnalysis

Steady State Surface Temperature
Use this component to calculate a steady state interior/exterior surface temperature from given given indoor/outdoor air temperatures and surface U-Values
Solar Fan Basic
Use this component to generate a solar fan with minimumal input data
Sun Shades Calculator
Use this component to generate shading devices, either surface or pergola, for any glazed surfmyPlaneace or list of glazed surfaces
Cone Of Vision
Use this component to generate and visualize cones of vision
Radiation Analysis
This component allows you to calculate the radiation fallin on input _geometry using a sky matrix from the selectSkyMxt component
Solar Envelope Basic
Use this component to generate a solar envelope for a closed boundary curve with minimum inputs
Window Downdraft
Use this component to compute the floor-level downdraft air temperature and velocity at a given set of points that are located close to a cold surface such as a window
Solar Envelope
Use this component to generate a solar envelope for a given test surface, set of solar vectors,
and context geometry that you want to ensure solar access to
Shading Mask
Use this component to see the portion of the sky dome that is masked by context geometry around a given point
Surface View Analysis
Use this component to calculate view factors from a point or plane to a set of surfaces
View Analysis
Use this component to evaluate the visibility of input _geometry from a set of key viewing points
view Rose
Use this component to see the area visible from a given viewpoint across a 2D plane of vision
View From Sun
Use this component to open a new viewport in Rhino that shows the view from the sun
Solar Fan
Use this component to generate a solar fan for a given test surface and set of solar vectors
Shading Designer
Use this component to generate shading breps for any glazed surface or list of glazed surfaces
Set Rhino Sun
Use this component to set the Rhino sun from grasshopper and coordinate your Rhino visualizations with the Ladybug weatherfile and other solar parameters
Forward Raytracing
Use this component to get a sense of how sunlight is reflected by a set of context geometries by tracing sun rays forwards through this geometry
Sunlight Hours Analysis
This component calculates the number of hours of direct sunlight received by input geometry using sun vectors from the sunPath component
Comfort Shade Benefit Evaluator
This is a component for visualizing the desirability of shade in terms of thermal comfort by using solar vectors, a series of hourly temperatures (usually outdoor temperatures), and an assumed "balance" temperature (or comfort temperature)
Bounce from Surface
Use this component to get a sense of how direct sunlight is reflected off of an initial _sourceSrf and subsequently to a set of context_ geometries by tracing sun rays forwards through this geometry

2 | VisualizeWeatherData

Gen Cumulative Sky Mtx
This component uses Radiance's gendaymtx function to calculate the sky's radiation for each hour of the year
Design Day Sky Model
Use this component to generate a clear sky for a cooling design day, which can then be used to size a HVAC system
select Sky Mtx
Use this component to select a specific sky matrix (skyMxt) for an hour of the year or for an analysis period
3D Chart
Use this component to make a 3D chart in the Rhino scene of any climate data or hourly simulation data
Colored Sky Visualizer
Use this component to visualize a Perez sky as a colored mesh in the Rhino scene using the weather file location, a time and date, and an estimate of turbidity (or amount of particulates in the atmosphere
Sky Dome
This component allows you to visualize a selected sky matrix from the selectSkyMxt component in order to see the patches of the sky dome where radiation is coming from
Psychrometric Chart
Use this component to draw a psychrometric chart in the Rhino scene and evaluate a set of temperatures and humidity ratios in terms of indoor comfort
Outdoor Solar Temperature Adjustor
Use this component to adjust an existing Mean Radiant Temperature for shortwave solar radiation
Wind Boundary Profile
Use this component to visualize a wind profile curve for a given terrain type
Line Chart
Use this component to make a line chart in the Rhino scene of any data with a ladybug header on it
Import Ground Temp
Use this component to visualise ground temperatures throughout the year at specific depths
Surface Hourly Solar
Use this component to quickly compute the hourly solar radiation or illuminance falling on an unobstructed surface that faces any direction from EPW inputs
Monthly Bar Chart
Use this component to make a bar chart in the Rhino scene of any monhtly or avrMonthyPerHour climate data or simulation data
Radiation Rose
Use this component to make a radiation rose in the Rhino scene
Bioclimatic Chart
This is the Bioclimactic Chart
Radiation Calla Dome
Use this component to draw Radiation Calla Dome, which shows you how radiation would fall on an object from all directions for a given sky
Sun Path
Use this component to make a 3D sun-path (aka
Wind Rose
Use this component to make a windRose in the Rhino scene
Adaptive Comfort Chart
Use this component to calculate the adaptive comfort for a given set of input conditions

1 | AnalyzeWeatherData

CDH HDH
Calculates heating and cooling degree-hours
PMV Comfort Calculator
Use this component to calculate comfort metrics of Predicted Mean Vote (PMV), the Percent of People Dissatisfied (PPD), and the Standard Effective Temperature (SET) for a set of climate conditions and occupant behavior/clothing
Thermal Comfort Indices
Use this component to calculate various thermal comfort indices:
Wind Speed Calculator
Use this component to calculate wind speed at a specific height for a given terrain type
Outdoor Comfort Calculator
Use this component to calculate the Universal Thermal Climate Index (UTCI) for a set of input climate conditions
Wet Bulb Temp
Use this component to calculate Wet Bulb Temperature and Dew Point Temperature
Sunrise Sunset
Use this component to get information about the sun
Clothing Function
Use this component to generate a list of values representing a clothing schedule based on outdoor air temperature
Average Data
Use this component to select the data out of an annual hourly data stream (from the importEPW component) using the "Analysis Period" component
Branch Data
Use this component to convert any list of annual data into a data tree branched by day of the year, month of the year, or hour of the day
Separate data
Use this component to separate the text strings from the numbers in the climate data streams output from the Import EPW component
Adaptive Comfort Calculator
Use this component to calculate the adaptive comfort for a given set of input conditions
Ankle Draft Discomfort
Use this component to calculate discomfort from cold drafts at ankle-level
Analysis Period
Use this component to set an analysis period, which can be used as input for a variety of other Ladybug and Honeybee components
CDD HDD
Calculates heating and cooling degree-days
Radiant Asymmetry Discomfort
Use this component to calculate discomfort from radiant assymetry
Draft Discomfort
Use this component to calculate discomfort from cold drafts on the back of the neck (arguably the most sensitive part of the human body to cold drafts)
Humidity Ratio Calculator
Calculates the humidity ratio from the ladybug weather file import parameters
Conversion formulas are taken from the following publications:
Vaisala

7 | WIP

ENVI-Met Grid
Use this component to visualize ENVI-Met v4
ENVI-Met Find Output Folder
This component let you select output folders from Workspace folder
Terrain Generator
This component uses Google Maps API to achieve elevation data and satellite images of the terrain generated
Countour Mesh
Use this component to create contoured visualizations of any analysis mesh and corresponding numerical dataset in Ladybug + Honeybee
Location Finder
This component uses Google Maps API to generate locations
Shading Mask II
Use this component to see the portion of the sky dome that is masked by context geometry around a given viewpoint
Kmz Generator
Use this component to export geometries into an Google Earth file
ENVI-Met Soil Plant Source
Use this component to generate ENVI-Met inputs for "LB ENVI-Met Spaces"
ENVI-Met Building Terrain
Use this component to generate inputs for "LB ENVI-Met Spaces"
Shadow Study
Use this component to generate outline curves representing shadows cast by input _geometry for a given _sunVector
ENVI-Met Display
Use this component to visualize ENVI-Met v4
Pedestrian Wind Comfort
Use this component to analyse pedestrian wind comfort and safety for the present and potential (newly built) urban environments
ENVI-Met Manage Workspace
Use this component to create a Workspace folder
ENVI-Met Results Reader
This component generate readable output files of ENVI-Met v4
ENVI-Met Spaces
Use this component to generate ENVI-Met v4
Search
Use this to look for the components in the Ladybug suite of tools that are most relevant to your query
ENVI-Met Read Library
This component let you select materials from ENVI-Met library

4 | Renewables

Import Sandia Photovoltaics Module
Use this component to import Photovoltaics module settings for particular module from "Sandia National Laboratories Modules" library
Solar Water Heating System
Use this component to define Solar water heating system settings
Sunpath Shading
This component calculates the shading of:
- Photovoltaic modules
- Solar Water Heating collectors
- any other purpose (shading of points)
Photovoltaics Performance Metrics
Use this component to calculate various Photovoltaics performance metrics
Solar Water Heating Surface
Use this component to calculate amount of thermal energy that can be produced by a surface
if a certain percentage of it is covered with Solar water heating liquid collectors
Solar Water Heating System Detailed
Use this component to define a detailed Solar water heating system settings
Solar Water Heating Performance Metrics
Use this component to calculate various Solar water heating performance metrics
Residential Hot Water
Use this component to calculate domestic hot water consumption for each hour during a year, for a single family household (house)
Photovoltaics Surface
Use this component to calculate amount of electrical energy that can be produced by a surface
if a certain percentage of it is covered with Photovoltaics
Simplified Photovoltaics Module
Use this component to define simplified Photovoltaics crystalline silicon (c-Si) module settings
Cold Water Temperature
Use this component to calculate the cold (inlet, mains) water temperature, if water pipes are burried undeground
Commercial Public Apartment Hot Water
Use this component to calculate domestic hot water consumption for each hour during a year, for Commercial, Public and Apartment buildings
PV SWH System Size
Use this component to generate the PVsurface or SWHsurface for "Photovoltaics surface" or "Solar Water Heating surface" components, based on initial PV or SWH system sizes
Import CEC Photovoltaics Module
Use this component to import Photovoltaics module settings for particular module from "California Energy Commission (CEC) Modules" library
Tilt And Orientation Factor
This component calculates the Optimal Tilt, Optimal Orientation and TOF (Tilt and Orientation Factor) for PV modules or Solar water heating collectors
DC to AC derate factor
Use this component to calculate overall DC to AC derate factor for Photovoltaics Surface's "DCtoACderateFactor_" input

0 | Ladybug

download EPW Weather File
Use this component to open the epwmap page in your default web browser and download an
Construct Location
Use this component if you do not have an
Update File
Use this component to update ladybug tools components in an old file
Open STAT File
Use this component to open a
Import Location
Use this component to import location data from a standard
Decompose Location
Use this component to separate and exctract the information in the 'location' output of the importEPW or constructLocation component
Create LB Header
Use this component to generates a Ladybug Header that can be combined with any raw data in order to format it for use with the Ladybug/Honeybee components
Import stat
Use this component to import climate data found in the
Open EPW And STAT Weather Files
Use this component to automatically download a
Import epw
Use this component to import lists of weather data into Grasshopper from a standard
Ladybug
This component carries all of Ladybug's main classes
Open EPW Weather File
Use this component to open an

6 | Developers

Update Ladybug
Code Developers and Beta Testers of new Ladybug components can use this component to remove old Ladybug components, add new Ladybug components, and update existing Ladybug components from a synced Github folder on their computer
Export Ladybug
Code Developers of Ladybug and Honeybee can use this component to export Ladybug/Honeybee user objects and source code that they create to the Github folder on their computer

Video Tutorials

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

Report an Issue  |  Terms of Service