Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Draw an adaptive comfort chart in the Rhino scene and plot a set of prevailing and indoor operative temperature values on it.
Connected data can include outdoor temperatures from imported EPW weather data as well as indoor temperatures from an energy simulation.
out_temp [Required]
Outdoor temperatures in one of the following formats:
air_temp [Required]
A hourly, daily, or sub-hourly data collection of temperature values for indoor air temperature (or operative temperature). If this input data collection is in in Farenheit, the entire chart will be drawn using IP units.
mrt
A hourly, daily, or sub-hourly data collection for mean radiant temperature (MRT) in C. Default is the same as the air_temp, effectively interpreting the _air_temp as operative tempreature.
air_speed
A number for the air speed values in m/s. Note that higher air speeds in the adaptive model only widen the upper boundary of the comfort range at temperatures above 24 C and will not affect the lower temperature of the comfort range. Default is a very low speed of 0.1 m/s.
adapt_par
Optional comfort parameters from the "LB Adaptive Comfort Parameters" component to specify the criteria under which conditions are considered acceptable/comfortable. The default will use ASHRAE-55 adaptive comfort criteria.
base_pt
A point to be used as the bottom-left-most point from which all geometry of the plot will be generated. (Default: (0, 0, 0)).
scale
A number to set the dimensions of the chart. (Default: 1).
prevail_range
An optional domain (or number for the upper temperature), which will be used to set the lower and upper boundaries of prevailing outdoor temperature on the chart. These should be in Celsius if the chart is plotted in Celsius and and Fahrenheit if it is in Fahrenheit. The default is 10C to 33C when ASHRAE-55 is used and 10C to 30C when the EN standard is used. This translates to 50F to 92F for ASHRAE-55 and 50F to 86F for the EN standard.
operat_range
An optional domain (or number for the upper temperature), which will be used to set the lower and upper boundaries of indoor operative temperature on the chart. These should be in Celsius if the chart is plotted in Celsius and and Fahrenheit if it is in Fahrenheit. The default is 14C to 40C, which translates to 58F to 104F.
legend_par
An optional LegendParameter object from the "LB Legend Parameters" component to change the display of the Adaptive Chart.
data
Optional data collections, which are aligned with the input air_temp, which will be output from the data of this component and can be used to color points with data. This data can also be used along with the statement below to select out data that meets certain conditions.
statement
A conditional statement as a string (e.g. a > 25). The variable of the first data collection should always be named 'a' (without quotations), the variable of the second list should be named 'b', and so on. For example, if three data collections are connected to _data and the following statement is applied: '10 < a < 30 and b < 33 and c > 2' The resulting collections will only include values where the first data collection is between 10 and 30, the second collection is less than 33 and the third collection is greater than 2. For this component, the input indoor air temperature will always be the last (or seconf-to-last) letter and this will be followed by the input mrt (if it is present).
period
A Ladybug analysis period to be applied to the _out_temp and air_temp of the input data.
report
...
total_comfort
The percent of the data on the adaptive chart that is inside the comfort polygon.
comfort_data
Data collection or a 0/1 value noting whether each of the data points on the chart lies inside of the comfort polygon. This can be connected to the "LB Create Legend" component to generate a list of colors that can be used to color the points output from "LB Adaptive Chart" component to see exactly which points are comfortable and which are not. Values are one of the following: 0 = uncomfortable 1 = comfortable
condition_data
Data collection of integers noting the thermal status of the human subject according to the assigned comfort parameters. This can be connected to the "LB Create Legend" component to generate a list of colors that can be used to color the points output from "LB Adaptive Chart" component to see exactly which points are hot, cold, and neutral. Values are one of the following:
polygon
Brep representing the range of comfort for the input parameters.
title
Text objects for the chart title and axes titles as well as a polyline for the outer border of the chart.
prevail_lines
A list of line segments and text objects for the outdoor prevailing temperature labels on the chart.
operative_lines
A list of line segments and text objects for the indoor operative temperature labels on the chart.
mesh
A colored mesh showing the number of input hours that happen in each part of the adaptive chart.
legend
A colored legend showing the number of hours that correspond to each color.
points
Points representing each of the input prevailing and operative temperature values. By default, this ouput is hidden and it should be connected it to a native Grasshopper preview component to view it.
data
The input data_ with the input statements or the periods applied to it. These can be deconstructed with the "LB Deconstruct Data" component and the resulting values can be plugged into the "LB Create Legend" component to generate colors that can be used to color the points above using the native Grasshopper "Custom Preview" component.
vis_set
An object containing VisualizationSet arguments for drawing a detailed version of the Adaptive Chart in the Rhino scene. This can be connected to the "LB Preview Visualization Set" component to display this version of the Adaptive Chart in Rhino.
Get a matrix containing radiation values from each patch of a sky dome.
Creating this matrix is a necessary pre-step before doing incident radiation analysis with Rhino geometry or generating a radiation rose.
This component uses Radiance's gendaymtx function to calculate the radiation for each patch of the sky. Gendaymtx is written by Ian Ashdown and Greg Ward. Morere information can be found in Radiance manual at: http://www.radiance-online.org/learning/documentation/manual-pages/pdfs/gendaymtx.pdf
north
A number between -360 and 360 for the counterclockwise difference between the North and the positive Y-axis in degrees. 90 is West and 270 is East. This can also be Vector for the direction to North. (Default: 0)
location [Required]
A ladybug Location that has been output from the "LB Import EPW" component or the "LB Construct Location" component.
direct_rad [Required]
An annual hourly DataCollection of Direct Normal Radiation such as that which is output from the "LB Import EPW" component or the "LB Import STAT" component.
diffuse_rad [Required]
An annual hourly DataCollection of Diffuse Horizontal Radiation such as that which is output from the "LB Import EPW" component or the "LB Import STAT" component.
hoys
A number or list of numbers between 0 and 8760 that respresent the hour(s) of the year for which to generate the sky matrix. The "LB Calculate HOY" component can output this number given a month, day and hour. The "LB Analysis Period" component can output a list of HOYs within a certain hour or date range. By default, the matrix will be for the entire year.
high_density
A Boolean to indicate whether the higher-density Reinhart sky matrix should be generated (True), which has roughly 4 times the sky patches as the (default) original Tregenza sky (False). Note that, while the Reinhart sky has a higher resolution and is more accurate, it will result in considerably longer calculation time for incident radiation studies. The difference in sky resolution can be observed with the "LB Sky Dome" component. (Default: False).
ground_ref
A number between 0 and 1 to note the average ground reflectance that is associated with the sky matrix. (Default: 0.2).
folder
The folder in which the Radiance commands are executed to produce the sky matrix. If None, it will be written to Ladybug's default EPW folder.
report
...
sky_mtx
A sky matrix object containing the radiation coming from each patch of the sky. This can be used for a radiation study, a radition rose, or a sky dome visualization. It can also be deconstructed into its individual values with the "LB Deconstruct Matrix" component.
Create a chart in the Rhino scene with data organized by month.
Data will display as a bar chart if the input data is monthly or daily. If the data is hourly or sub-hourly, it will be plotted with lines and/or a colored mesh that shows the range of the data within specific percentiles.
data [Required]
Data collections (eg. HourlyCollection, MonthlyCollection, or DailyCollection), which will be used to generate the monthly chart.
base_pt
An optional Point3D to be used as a starting point to generate the geometry of the chart (Default: (0, 0, 0)).
x_dim
An optional number to set the X dimension of each month of the chart. (Default: 10 meters).
y_dim
An optional number to set the Y dimension of the entire chart (Default: 40 meters).
stack
Boolean to note whether multiple connected monthly or daily input _data with the same units should be stacked on top of each other. Otherwise, all bars for monthly/daily data will be placed next to each other. (Default: False).
percentile
An optional number between 0 and 50 to be used for the percentile difference from the mean that hourly data meshes display at. For example, using 34 will generate hourly data meshes with a range of one standard deviation from the mean. Note that this input only has significance when the input data collections are hourly. (Default: 34)
time_marks
Boolean to note whether the month labels should be replaced with marks for the time of day in each month. This is useful for displaying hourly data, particularly when the input data is only for a month and not the whole year.
global_title
A text string to label the entire entire chart. It will be displayed in the lower left of the output chart. The default will display the metadata of the input _data.
y_axis_title
A text string to label the Y-axis of the chart. This can also be a list of 2 Y-axis titles if there are two different types of data connected to _data and there are two axes labels on either side of the chart. The default will display the data type and units of the first (and possibly the second) data collection connected to _data.
legend_par
An optional LegendParameter object to change the display of the chart (Default: None).
report
...
data_mesh
A list of colored meshes that represent the different input data. These meshes will resemble a bar chart in the case of monthly or daily data and will resemble a band between two ranges for hourly and sub-hourly data. Multiple lists of meshes will be output for several input data streams.
data_lines
A list of polylines that represent the input data. These will represent the average or total at each hour whenever the input data is hourly or monthly-per-hour data.
col_lines
A list of colored polylines that represent the input data. These will only be output when the input data are monthly per hour.
legend
Geometry representing the legend for the chart, noting which colors correspond to which input data.
borders
A list of lines and polylines representing the axes and intervals of the chart.
labels
A list of text objects that label the borders with month name and the intervals of the Y-axis.
y_title
A text oject for the Y-axis title.
title
A text object for the global_title.
vis_set
An object containing VisualizationSet arguments for drawing a detailed version of the Monthly Chart in the Rhino scene. This can be connected to the "LB Preview Visualization Set" component to display this version of the Monthly Chart in Rhino.
-
Visualize a sky matrix from the "LB Cumulative Sky Matrix" component as a colored dome, subdivided into patches with a radiation value for each patch.
sky_mtx [Required]
A Sky Matrix from the "LB Cumulative Sky Matrix" component or the "LB Benefit Sky Matrix" component, which describes the radiation coming from the various patches of the sky.
center_pt
A point for the center of the dome. (Default: (0, 0, 0))
scale
A number to set the scale of the sky dome. The default is 1, which corresponds to a radius of 100 meters in the current Rhino model's unit system.
projection
Optional text for the name of a projection to use from the sky dome hemisphere to the 2D plane. If None, a 3D sky dome will be drawn instead of a 2D one. (Default: None) Choose from the following:
irradiance
Boolean to note whether the sky dome should be plotted with units of cumulative Radiation (kWh/m2) [False] or with units of average Irradiance (W/m2) [True]. (Default: False).
show_comp
Boolean to indicate whether only one dome with total radiation should be displayed (False) or three domes with the solar radiation components (total, direct, and diffuse) should be shown. (Default: False).
legend_par
An optional LegendParameter object to change the display of the sky dome (Default: None).
report
...
mesh
A colored mesh representing the intensity of radiation for each of the sky patches within the sky dome.
compass
A set of circles, lines and text objects that mark the cardinal directions in relation to the sky dome.
legend
A legend showing the kWh/m2 or W/m2 values that correspond to the colors of the mesh.
title
A text object for the title of the sky dome.
patch_vecs
A list of vectors for each of the patches of the sky dome. All vectors are unit vectors and point from the center towards each of the patches. They can be used to construct visualizations of the rays used to perform radiation analysis.
patch_values
Radiation values for each of the sky patches in kWh/m2 or W/m2. This will be one list if show_comp_ is "False" and a list of 3 lists (aka. a Data Tree) for total, direct, diffuse if show_comp_ is "True".
mesh_values
Radiation values for each face of the dome mesh in kWh/m2. This can be used to post-process the radiation data and then regenerate the dome visualization using the mesh output from this component and the "LB Spatial Heatmap" component. Examples of useful post- processing include converting the units to something other than kWh/m2, inverting the +/- sign of radiation values depending on whether radiation is helpful or harmful to building thermal loads, etc. This will be one list if show_comp_ is "False" and a list of 3 lists (aka. a Data Tree) for total, direct, diffuse if show_comp_ is "True".
vis_set
An object containing VisualizationSet arguments for drawing a detailed version of the Sky Dome in the Rhino scene. This can be connected to the "LB Preview Visualization Set" component to display this version of the Sky Dome in Rhino.
-
Create a colored plot of any hourly data collection.
data [Required]
A HourlyContinuousCollection or HourlyDiscontinuousCollection which will be used to generate the hourly plot.
base_pt
An optional Point3D to be used as a starting point to generate the geometry of the plot (Default: (0, 0, 0)).
x_dim
A number to set the X dimension of the mesh cells (Default: 1 meters).
y_dim
A number to set the Y dimension of the mesh cells (Default: 4 meters).
z_dim
A number to set the Z dimension of the entire chart. This will be used to make the colored_mesh3d of the chart vary in the Z dimension according to the data. The value input here should usually be several times larger than the x_dim or y_dim in order to be noticable (e.g. 100). If 0, the colored_mesh3d will simply be flat. (Default: 0).
reverse_y
Boolean to note whether the Y-axis of the chart is reversed If True, time over the course of the day will flow from the top of the chart to the bottom instead of the bottom to the top.
clock_24
Boolean to note whether the hour labels on the Y-Axis of the chart should be in 24-hour clock format (eg. 18:00) or they should be in 12-hour clock format (eg. 6PM).
legend_par
An optional LegendParameter object to change the display of the HourlyPlot. This can also be a list of legend parameters to be applied to the different connected _data.
statement
A conditional statement as a string (e.g. a > 25). The variable of the first data collection should always be named 'a' (without quotations), the variable of the second list should be named 'b', and so on. For example, if three data collections are connected to _data and the following statement is applied: '18 < a < 26 and b < 80 and c > 2' The resulting collections will only include values where the first data collection is between 18 and 26, the second collection is less than 80 and the third collection is greater than 2.
period
A Ladybug analysis period to be applied to all of the input _data.
report
...
mesh
A colored mesh derived from the input _data. Multiple meshes will be output for several data collections are input.
legend
Geometry representing the legend for each mesh.
borders
A list of lines and polylines representing different time intervals of the plot.
labels
A list of text objects that label the borders with the time intervals that they demarcate.
title
A text object for the global_title.
vis_set
An object containing VisualizationSet arguments for drawing a detailed version of the Hourly Plot in the Rhino scene. This can be connected to the "LB Preview Visualization Set" component to display this version of the Hourly Plot in Rhino.
-
Draw thermal comfort polygons on a Psychrometric Chart using the UTCI outdoor thermal comfort model.
psych_chart [Required]
A hourly, daily, or sub-hourly data collection of temperature values or a single temperature value in Celcius to be used for the whole analysis. If this input data collection is in in Farenheit, the entire chart will be drawn using IP units. Operative temperature should be used if it is available. Otherwise, air temperature (aka. dry bulb temperature) is suitable.
mrt
A number or list of numbers for the mean radiant temperature. These should be in Celsius if the Psychrometric Chart is in SI and Farenheit if the Psychrometric Chart is in IP. If None, a polygon for operative temperature will be plot, assuming that radiant temperature and air temperature are the same. (Default: None).
wind_speed
A number or list of numbers for for the meteorological wind speed values in m/s (measured 10 m above the ground). If None, this will default to a low wind speed of 0.5 m/s, which is the lowest input speed that is recommended for the UTCI model.
utci_par
Optional UTCIParameter object to specify parameters under which conditions are considered acceptable. If None, default will assume comfort thresholds consistent with those used by meteorologists to categorize outdoor conditions.
merge_poly
Boolean to note whether all comfort polygons should be merged into a single polygon instead of separate polygons for each set of input conditions. (Default: False).
plot_stress
Boolean to note whether polygons for heat/cold stress should be plotted in the output. This will include 3 polygons on either side of the comfort polygon(s) for...
report
...
total_comfort
The percent of the data on the psychrometric chart that are inside all comfort polygons.
total_comf_data
Data collection or a 0/1 value noting whether each of the data points on the psychrometric chart lies inside of a comfort polygon. This can be connected to the "LB Create Legend" component to generate a list of colors that can be used to color the points output from "LB Psychrometric Chart" component to see exactly which points are comfortable and which are not. Values are one of the following: 0 = uncomfortable 1 = comfortable
polygons
A list of Breps representing the range of comfort (or heat/cold stress) for the input mrt and air speed.
polygon_names
A list of names for each of the polygons which correspond with the polygons output above. This will include both the comfort polygons and the cold/heat stress polygons.
polygon_data
A list of data collections or 0/1 values indicating whether each of the data points on the psychrometric chart lies inside each of the comfort polygons. Each data collection or here corresponds to the names in the polygon_names output above. Values are one of the following: 0 = outside 1 = inside
-
Visualize the radiation falling on an object from different directions over a dome.
The Radiation Dome depicts the amount of solar energy received by all directions over a dome. This is useful for understanding the optimal orientation of solar panels and how the performance of the panel might change if it's orientation is off from the optimal position. It can also be used to identify the optimal wall orientation for passive solar heating when used with skies of radiation harm/benefit. When used with clear sky matrices, it can identify the orientations that result in the highest and lowest peak cooling load.
The Radiation Dome can be understood in different ways: 1) It's a 3D representation of the "LB Radiation Rose," depicting all tilt angles for that rose at once. 2) It's the reciprocal of the "LB Sky Dome," since it shows how the radiation from that sky falls onto a hemispherical object. 3) It's an radiation study of a hemisphere. The results here are effectively the same as running a hemisphere through the "LB Incident Radiation" component.
sky_mtx [Required]
A Sky Matrix from the "LB Cumulative Sky Matrix" component or the "LB Benefit Sky Matrix" component, which describes the radiation coming from the various patches of the sky.
context
Rhino Breps and/or Rhino Meshes representing context geometry that can block solar radiation to the center of the radiation dome.
az_count
An integer greater than or equal to 3, which notes the number of horizontal orientations to be evaluated on the dome. (Default: 72).
alt_count
An integer greater than or equal to 3, which notes the number of vertical orientations to be evaluated on the dome. (Default: 18).
center_pt
A point for the center of the radiation dome. (Default: (0, 0, 0))
scale
A number to set the scale of the Radiation Dome. The default is 1, which corresponds to a radius of 100 meters in the current Rhino model's unit system.
projection
Optional text for the name of a projection to use from the sky dome hemisphere to the 2D plane. If None, a 3D sky dome will be drawn instead of a 2D one. (Default: None) Choose from the following:
irradiance
Boolean to note whether the radiation dome should be plotted with units of cumulative Radiation (kWh/m2) [False] or with units of average Irradiance (W/m2) [True]. (Default: False).
show_comp
Boolean to indicate whether only one dome with total radiation should be displayed (False) or three domes with the solar radiation components (total, direct, and diffuse) should be shown. (Default: False).
legend_par
An optional LegendParameter object to change the display of the radiation dome (Default: None).
report
...
mesh
A colored mesh of a dome, representing the intensity of radiation/irradiance from different cardinal directions.
compass
A set of circles, lines and text objects that mark the cardinal directions in relation to the radiation dome.
legend
A legend showing the kWh/m2 or W/m2 values that correspond to the colors of the mesh.
title
A text object for the title of the radiation dome.
dir_vecs
A list of vectors for each of the directions the dome is facing. All vectors are unit vectors.
dir_values
Radiation values for each of the dome directions in kWh/m2 or W/m2. This will be one list if show_comp_ is "False" and a list of 3 lists (aka. a Data Tree) for total, direct, diffuse if show_comp_ is "True".
max_pt
A point on the radiation dome with the greatest amount of solar radiation/irradiance. For a radiation benefit sky, this is the orientation with the greatest benefit. This can be used to understand the optimalorientation of solar panels or the best direction to face for passive solar heating.
max_info
Information about the direction with the greates amount of radiation. This includes the altitude, azimuth, and radiation/irradiance value.
vis_set
An object containing VisualizationSet arguments for drawing a detailed version of the Radiation Dome in the Rhino scene. This can be connected to the "LB Preview Visualization Set" component to display this version of the Radiation Dome in Rhino.
-
Draw thermal comfort polygons on a Psychrometric Chart using the PMV model for indoor thermal comfort.
This component can also plot passive strategy polygons on the psychrometric chart and can compute the number of hours that lie inside each of the comfort / strategy polygons.
psych_chart [Required]
A hourly, daily, or sub-hourly data collection of temperature values or a single temperature value in Celcius to be used for the whole analysis. If this input data collection is in in Farenheit, the entire chart will be drawn using IP units. Operative temperature should be used if it is available. Otherwise, air temperature (aka. dry bulb temperature) is suitable.
mrt
A number or list of numbers for the mean radiant temperature. These should be in Celsius if the Psychrometric Chart is in SI and Farenheit if the Psychrometric Chart is in IP. If None, a polygon for operative temperature will be plot, assuming that radiant temperature and air temperature are the same. (Default: None).
air_speed
A number or list of numbers for the air speed values in m/s. If None, a low air speed of 0.1 m/s wil be used for all polygons. (Default: None).
met_rate
A number or list of numbers for the metabolic rate in met. If None, a met rate of 1.1 met will be used for all polygons, indicating a human subject who is seated, typing. (Default: None).
clothing
A number or list of numbers for the clothing level in clo. If None, a clo level of 0.7 clo will be used for all polygons, indicating a human subject with a long sleeve shirt and pants. (Default: None).
pmv_par
Optional PMVParameter object to specify parameters under which conditions are considered acceptable. If None, default will assume a PPD threshold of 10%, no absolute humidity constraints and a still air threshold of 0.1 m/s.
merge_poly
Boolean to note whether all comfort polygons should be merged into a single polygon instead of separate polygons for each set of input conditions. (Default: False).
strategies
An optional text input of passive strategies to be plot on the psychrometric chart as polygons. It is recommended that the "LB Passive Strategy" component be used to select which polygons to plot.
strategy_par
Optional passive strategy parameters from the "LB Passive Strategy Parameters" component. This can be used to adjust various inputs used to generate strategy polygons including the maximum comfortable air speed, the building balance temperature, and the temperature limits for thermal mass and night flushing.
solar_data
An annual hourly continuous data collection of irradiance (or radiation) in W/m2 (or Wh/m2) that aligns with the data points on the psychrometric chart. This is only required when plotting a "Passive Solar Heating" strategy polygon on the chart. The irradiance values should be incident on the orientation of the passive solar heated windows. So using global horizontal radiation assumes that all windows are skylights (like a greenhouse). The "LB Directional Irradiance" component can be used to get irradiance data for a specific surface orientation.
report
...
total_comfort
The percent of the data on the psychrometric chart that are inside all comfort and passive strategy polygons.
total_comf_data
Data collection or a 0/1 value noting whether each of the data points on the psychrometric chart lies inside of a comfort polygon or a strategy polygon. This can be connected to the "LB Create Legend" component to generate a list of colors that can be used to color the points output from "LB Psychrometric Chart" component to see exactly which points are comfortable and which are not. Values are one of the following: 0 = uncomfortable 1 = comfortable
polygon_names
A list of names for each of the polygons. This will include both the comfort polygons and the passive strategy polygons. The order of these names correspondsto the total_strategies and strategies_data outputs.
polygon_comfort
The percent of the input data that are in each of the comfort or passive strategy polygons. Each number here corresponds to the names in the polygon_names output above.
polygon_data
A list of data collections or 0/1 values indicating whether each of the data points on the psychrometric chart lies inside each of the comfort or a strategy polygons. Each data collection or here corresponds to the names in the polygon_names output above. Values are one of the following: 0 = uncomfortable 1 = comfortable
comfort_poly
Brep representing the range of comfort for the input mrt, air speed, metabolic rate and clothing level. If multiple values have been input, multiple polygons will be output here.
strategy_poly
Brep representing the area of the chart made comfortable by any input passive strategies. If multiple strategies have been input to the strategies_ input, multiple polygons will be output here.
-
Output a Sunpath (aka. sun plot) graphic into the Rhino scene.
The component also outputs sun vectors that can be used for solar access analysis and shading design.
north
A number between -360 and 360 for the counterclockwise difference between the North and the positive Y-axis in degrees. 90 is West and 270 is East. This can also be Vector for the direction to North. (Default: 0)
location [Required]
A ladybug Location that has been output from the "LB Import EPW" component or the "LB Construct Location" component.
hoys
A number or list of numbers between 0 and 8760 that represent the hour of the year at which to evaluate the sun position. The "LB Calculate HOY" component can output this number given a month, day and hour. The "LB Analysis Period" component can output a list of HOYs within a certain hour or date range.
dl_saving
An optional analysis period for daylight saving time. If None, no daylight saving time will be used. (Default: None)
solar_time
A boolean to indicate if the input hours should be treated as solar time instead of standard or daylight time. (Default: False)
center_pt
A point for the center of the sun path. (Default: (0, 0, 0))
scale
A number to set the scale of the sun path. The default is 1, which corresponds to a radius of 100 meters in the current Rhino model's unit system.
projection
Optional text for the name of a projection to use from the sky dome hemisphere to the 2D plane. If None, a 3D sun path will be drawn instead of a 2D one. (Default: None) Choose from the following:
daily
Boolean to note whether the sunpath should display only one daily arc for each unique day in the input hoys_ (True) or whether the output sun path geometry should be for the entire year, complete with analemmas for all sun-up hours and a daily arc for each month (False). (Default: False)
data
Optional HourlyContinuousCollection objects, which will be used to generate colors that align with each of the sun_pts. This data can also be used along with the statement_ below to select out sun positions that meet certain conditions.
statement
A conditional statement as a string (e.g. a > 25). The variable of the first data collection should always be named 'a' (without quotations), the variable of the second list should be named 'b', and so on. For example, if three data collections are connected to _data and the following statement is applied: '18 < a < 26 and b < 80 and c > 2' The resulting collections will only include values where the first data collection is between 18 and 26, the second collection is less than 80 and the third collection is greater than 2.
legend_par
An optional LegendParameter object to change the display of the data on the sun path. This can also be a list of legend parameters to be applied to the different connected data_.
report
Reports, errors, warnings, etc.
vectors
Vector(s) indicating the direction of sunlight for each sun position on the sun path. Note that these vectors point downwards towards the ground.
altitudes
Number(s) indicating the sun altitude(s) in degrees for each sun position on the sun path.
azimuths
Number(s) indicating the sun azimuths in degrees for each sun position on the sun path.
hoys
The hour of the year for each sun positions on the sun path.
sun_pts
Point(s) representing the location of the sun on the sunpath.
analemma
A set of curves that mark the hourly positions of the sun throughout the different months of the year.
daily
A set of arcs that mark the path of the sun across the sky dome over the course of a day.
compass
A set of circles, lines and text objects that mark the cardinal directions in relation to the sun path.
legend
Geometry representing the legend for the input data_. Will be None if no _data is connected.
title
A text object for the title of the sunpath.
color_pts
A list of points colored with the input data_, which will display in the Rhino scene in accordance with the legend. Note that the text representation of these objects bears the RGB color of each point. So casting this output to text and then to a color will yeild color objects that can be used for previewing other types of geometry with the input data_. Will be None if no _data is connected.
vis_set
An object containing VisualizationSet arguments for drawing a detailed version of the Sunpath in the Rhino scene. This can be connected to the "LB Preview Visualization Set" component to display this version of the Sunpath in Rhino.
-
Draw a psychrometric chart in the Rhino scene and plot a set of temperatures and humidity values on it.
Connected data can be either outdoor temperature and humidty from imported EPW weather data or indoor temperature and humidity ratios from an energy simulation.
temperature [Required]
A hourly, daily, or sub-hourly data collection of temperature values or a single temperature value in Celcius to be used for the whole analysis. If this input data collection is in in Farenheit, the entire chart will be drawn using IP units. Operative temperature should be used if it is available. Otherwise, air temperature (aka. dry bulb temperature) is suitable.
rel_humidity [Required]
A hourly, daily, or sub-hourly data collection of relative humidity values in % or a single relative humidity value to be used for the whole analysis. Note that the input data collection here must align with the _temperature input.
pressure
A data collection of atmospheric pressure in Pascals or a single number for the average air pressure across the data plotted on the chart. It is recommended that the barometric pressure from the "Import EPW" component be used here as the default is not sutiable for higher elevations. (Default: 101325 Pa; pressure at sea level).
base_pt
A point to be used as the bottom-left-most point from which all geometry of the plot will be generated. (Default: (0, 0, 0)).
scale
A number to set the dimensions of the chart. (Default: 1).
temp_range
An optional domain (or number for the upper temperature), which will be used to set the lower and upper boundaries of temperature on the psychrometric chart. (Default: -20 to 55 when the chart is in SI; -5 to 115 when the chart is in IP).
plot_wet_bulb
Boolean to note whether the psychrometric chart should be ploted with lines of constant enthalpy (False) or lines of constant wet bulb temperature (True). (Default: False).
legend_par
An optional LegendParameter object from the "LB Legend Parameters" component to change the display of the Pyschrometric Chart.
data
Optional data collections, which are aligned with the input _temperature and rel_humidity, which will be output from the data of this component and can be used to color points with data. This data can also be used along with the statement below to select out data that meets certain conditions.
statement
A conditional statement as a string (e.g. a > 25). The variable of the first data collection should always be named 'a' (without quotations), the variable of the second list should be named 'b', and so on. For example, if three data collections are connected to _data and the following statement is applied: '18 < a < 26 and b < 80 and c > 2' The resulting collections will only include values where the first data collection is between 18 and 26, the second collection is less than 80 and the third collection is greater than 2. For this component, temperature will always be the second-to-last letter and relative humidity will be the last letter.
period
A Ladybug analysis period to be applied to the _temperature and rel_humidity of the input data.
report
...
title
Text objects for the chart title and axes titles as well as a polyline for the outer border of the chart. Note that the polyline for the border excludes the saturation line.
temp_lines
A list of line segments and text objects for the temperature labels on the chart.
rh_lines
A list of curves and text objects for the relative humidity labels on the chart.
hr_lines
A list of line segments and text objects for the humidty ratio labels on the chart.
enth_wb_lines
A list of line segments and text objects for the enthalpy or wet bulb temperature labels on the chart.
mesh
A colored mesh showing the number of input hours that happen in each part of the psychrometric chart.
legend
A colored legend showing the number of hours that correspond to each color.
points
Points representing each of the input temperature and humidity values. By default, this ouput is hidden and it should be connected it to a native Grasshopper preview component to view it.
data
The input data_ with the input statements or the periods applied to it. These can be deconstructed with the "LB Deconstruct Data" component and the resulting values can be plugged into the "LB Create Legend" component to generate colors that can be used to color the points above using the native Grasshopper "Custom Preview" component.
psych_chart
A Psychrometric Chart object, which can be connected to any of the "Comfort Polygon" components in order to plot polygons on the chart and perform thermal comfort analyses on the data.
vis_set
An object containing VisualizationSet arguments for drawing a detailed version of the Psychrometric Chart in the Rhino scene. This can be connected to the "LB Preview Visualization Set" component to display this version of the Psychrometric Chart in Rhino.
Visualize a wind profile curve for a given terrain type.
Wind profiles assist with understanding how wind speed decreases as one approaches the ground or increases as one leaves the ground.
By default, the wind profile output by this component will be an average over the _met_wind_vel data collection (or it can be for a single meteorological wind velocity for point-in-time studies).
If a met_wind_dir_ data collection is connected, the wind profile will point in the direction of prevailing wind direction by default. A profile_dir_ can then be connected to understand the average wind profile from a specific cardinal direction (eg. NE).
north
A number between -360 and 360 for the counterclockwise difference between the North and the positive Y-axis in degrees. 90 is West and 270 is East. This can also be Vector for the direction to North. (Default: 0)
met_wind_vel [Required]
A data collection of meteorological wind speed measured at the met_height with the _met_terrian [m/s]. Typically, this comes from the "LB Import EPW" component. This can also be a single number for the meteorological wind speed in m/s.
met_wind_dir
An optional number between 0 and 360 representing the degrees from north that the meteorological wind is blowing. 0 = North, 90 = East, 180 = South, 270 = West. This can also a data collection of meteorological wind directions. in which case the wind profile will be oriented towards the prevailing wind (unless a profile_dir_ is connected). When unspecified, the wind profile is simply drawn in the XY plane.
profile_dir
An optional text string representing the cardinal direction that the wind profile represents. This input only has an effect when a data collection is connected for met_wind_dir_. It will be used to draw a wind profile for only the hours of the data collection where the wind is blowing in the specified direction. This can also be an integer that codes for a particular orientation. Choose from the following. 0 = N 1 = NE 2 = E 3 = SE 4 = S 5 = SW 6 = W 7 = NW
terrain
Text string that sets the terrain class associated with the wind profile. This can also be an integer that codes for the terrain. (Default: city). Must be one the following. 0 = city - 50% of buildings above 21m over a distance of at least 2000m upwind. 1 = suburban - suburbs, wooded areas. 2 = country - open, with scattered objects generally less than 10m high. 3 = water - flat areas downwind of a large water body (max 500m inland).
met_height
A number for the height above the ground at which the meteorological wind speed is measured in meters. (Default: 10 meters, which is the standard used by most airports and EPW files).
met_terrain
Text string that sets the terrain class associated with the meteorological wind speed. This can also be an integer that codes for the terrain. (Default: country, which is typical of most airports where wind measurements are taken). Must be one the following. 0 = city - 50% of buildings above 21m over a distance of at least 2000m upwind. 1 = suburban - suburbs, wooded areas. 2 = country - open, with scattered objects generally less than 10m high. 3 = water - flat areas downwind of a large water body (max 500m inland).
log_law
A boolean to note whether the wind profile should use a logarithmic law to determine wind speeds instead of the default power law, which is used by EnergyPlus. (Default: False).
base_pt
A point that sets the ground level frm which the wind profile is drawn. By default, the profile is generated at the scene origin.
max_speed
Script variable WindProfile
profile_height
A number in meters to specify the maximum height of the wind profile. (Default: 30 meters).
vec_spacing
A number in meters to specify the difference in height between each of the mesh arrows. (Default 2 meters).
vec_scale
A number to denote the length dimension of a 1 m/s wind vector in meters. This can be used to change the scale of the wind vector meshes in relation to the height of the wind profile curve. (Default: 5 meters).
legend_par
An optional LegendParameter object to change the display of the wind profile.
report
Reports, errors, warnings, etc.
wind_speeds
A list of wind speeds in [m/s] that correspond to the wind vectors slong the height of the wind profile visualization.
wind_vectors
A list of vectors that built the profile. Note that the magnitude of these vectors is scaled based on the vec_scale input and a vec_scale of 1 will make the magnitude of the vector equal to the wind speed in [m/s].
anchor_pts
A list of anchor points for each of the vectors above, which correspond to the height above the ground for each of the vectors.
mesh_arrows
A list of colored mesh objects that represent the wind speeds along the height of the wind profile.
profile_curve
A curve outlining the wind speed as it changes with height.
speed_axis
A list of line segments and text objects that mark the X axis, which relates to the wind speed in (m/s).
height_axis
A list of line segments and text objects that mark the Y axis, which relates to the the height above the ground in Rhino model units.
legend
A legend for the colored mesh_arrows, which notes their speed.
title
A text object for the global_title.
vis_set
An object containing VisualizationSet arguments for drawing a detailed version of the Wind Profile in the Rhino scene. This can be connected to the "LB Preview Visualization Set" component to display this version of the Wind Profile in Rhino.
Create a plot of any hourly data by wind directions.
north
An optional number between -360 and 360 for the counterclockwise difference between the North and the positive Y-axis in degrees. 90 is West and 270 is East. This can also be Vector for the direction to North
data [Required]
A HourlyContinuousCollection or HourlyDiscontinuousCollection of values corresponding to the wind directions, which is "binned" by the direction intervals. This input usually consists of wind speed values, but is not limited to this data type. It can also be a list of data collections in which case multiple wind roses will be output.
wind_direction [Required]
A HourlyContinuousCollection or HourlyDiscontinuousCollection of wind directions which will be used to "bin" the _data items for the windrose.
dir_count
Number that determines the number of directions to the wind rose will display. The number of directions must be greater then three to plot the wind rose (Default: 36).
center_pt
Point3D to be used as a starting point to generate the geometry of the plot (Default: (0, 0, 0)).
show_calm
A boolean to indicate if the wind rose should display the fraction of time with zero wind speed using a circle in the center of the plot. The radius of this circle corresponds to the total amount of time with zero values divided by the number of directions. This means that the time period representing zero values is evenly distrobuted across all directions. (Default: False).
show_avg
A boolean to note whether the average value in each wind direction bin should be displayed instead of the complete frequency of _data values. (Default: False).
freq_dist
The distance for the frequency interval in model units. If show_calm_ is True, then the initial frequency interval corresponds to the number of calm hours in the data collection, which may not align with this freq_dist_ (Default: 5 meters)
freq_hours
The number of hours in each frequency interval (Default: 50).
max_freq_lines
A number representing the maximum frequency intervals in the rose, which determines the maximum amount of hours represented by the outermost ring of the windrose. Specifically, this number multiplied by the freq_hours parameter will equal the maximum hours in that outermost ring. By default, this value is determined by the wind direction with the largest number of hours (the highest frequency) but you may want to change this if you have several wind roses that you want to compare to each other. For example, if you have wind roses for different months or seasons, which each have different maximum frequencies.
legend_par
An optional LegendParameter object to change the display of the WindRose plot. The number of segments in the legend determines the number of frequency intervals in the wind rose. If nothing is provided, a default LegendParameter object is computed using values from the wind data with 11 segments (Default: None).
statement
A conditional statement as a string (e.g. a > 25) for the _data and _wind_direction inputs. The variable of the first collection input to _data should always be named 'a' (without quotations), the variable of the second list should be named 'b', and so on. The wind direction is always the last variable, though most statements won't have a need for it. For example, if three data collections are connected to _data and the following statement is applied: '18 < a < 26 and b < 80 and c > 2' The resulting collections will only include values where the first data collection is between 18 and 26, the second collection is less than 80 and the third collection is greater than 2.
period
An optional Ladybug analysis period to be applied to all of the input data.
report
...
mesh
A colored mesh representing the wind rose derived from the input data. Multiple meshes will be output for several data collections are input.
compass
A set of circles, lines and text objects that mark the cardinal directions in relation to the wind rose.
orient_line
Line geometries representing the edges (or "spokes") of the wind rose directions.
freq_line
Polygon geometries representing the frequency intervals of the wind rose.
windrose_line
Polygon geometries representing the windrose outlines. This output is hidden by default and should be connected to a native Grasshopper Geometry component in order to be visualized.
legend
Geometry representing the legend for the wind rose.
title
A text object for the global_title.
prevailing
The predominant direction of the outpt wind rose in clockwise degrees from north. 0 is North, 90 is East, 180 is South, 270 is West.
angles
A list of angles corresponding to each windrose directions.
calm_hours
The number of hours with calm wind speeds. Only returns a value if the input _data is wind speed.
histogram
The input _data in a histogram structure after it has gone through any of the statement or period operations input to this component.
vis_set
An object containing VisualizationSet arguments for drawing a detailed version of the Wind Rose in the Rhino scene. This can be connected to the "LB Preview Visualization Set" component to display this version of the Wind Rose in Rhino.
Get a matrix representing the benefit/harm of radiation based on temperature data.
When this sky matrix is used in radiation studies or to produce radiation graphics, positive values represent helpful wintertime sun energy that can offset heating loads during cold temperatures while negative values represent harmful summertime sun energy that can increase cooling loads during hot temperatures.
Radiation benefit skies are particularly helpful for evaluating building massing and facade designs in terms of passive solar heat gain vs. cooling energy increase.
This component uses Radiance's gendaymtx function to calculate the radiation for each patch of the sky. Gendaymtx is written by Ian Ashdown and Greg Ward. Morere information can be found in Radiance manual at: http://www.radiance-online.org/learning/documentation/manual-pages/pdfs/gendaymtx.pdf
north
A number between -360 and 360 for the counterclockwise difference between the North and the positive Y-axis in degrees. 90 is West and 270 is East. This can also be Vector for the direction to North. (Default: 0)
location [Required]
A ladybug Location that has been output from the "LB Import EPW" component or the "LB Construct Location" component.
temperature [Required]
An annual hourly DataCollection of temperature, which will be used to establish whether radiation is desired or not for each time step.
bal_temp
The temperature in Celsius between which radiation switches from being a benefit to a harm. Typical residential buildings have balance temperatures as high as 18C and commercial buildings tend to have lower values around 12C. (Default 15C).
bal_offset
The temperature offset from the balance temperature in Celsius where radiation is neither harmful nor helpful. (Default: 2).
direct_rad [Required]
An annual hourly DataCollection of Direct Normal Radiation such as that which is output from the "LB Import EPW" component or the "LB Import STAT" component.
diffuse_rad [Required]
An annual hourly DataCollection of Diffuse Horizontal Radiation such as that which is output from the "LB Import EPW" component or the "LB Import STAT" component.
hoys
A number or list of numbers between 0 and 8760 that respresent the hour(s) of the year for which to generate the sky matrix. The "LB Calculate HOY" component can output this number given a month, day and hour. The "LB Analysis Period" component can output a list of HOYs within a certain hour or date range. By default, the matrix will be for the entire year.
high_density
A Boolean to indicate whether the higher-density Reinhart sky matrix should be generated (True), which has roughly 4 times the sky patches as the (default) original Tregenza sky (False). Note that, while the Reinhart sky has a higher resolution and is more accurate, it will result in considerably longer calculation time for incident radiation studies. The difference in sky resolution can be observed with the "LB Sky Dome" component. (Default: False).
ground_ref
A number between 0 and 1 to note the average ground reflectance that is associated with the sky matrix. (Default: 0.2).
folder
The folder in which the Radiance commands are executed to produce the sky matrix. If None, it will be written to Ladybug's default EPW folder.
report
...
sky_mtx
A sky matrix object containing the radiation benefit/harm coming from each patch of the sky. This can be used for a radiation study, a radition rose, or a sky dome visualization. It can also be deconstructed into its individual values with the "LB Deconstruct Matrix" component.
Visualize the solar energy falling on different direction as a rose.
By default, the Radiation Rose depicts the amount of solar energy received by a vertical wall facing each of the directions of the compass rose.
This is useful for understanding the radiation harm/benefit experienced by different building orientations or the orientations with the highest peak cooling load (for sky matrices of clear skies). The tilt_angle can be used to assess the solar energy falling on geometries that are not perfectly vertical, such as tilted photovoltaic panels.
sky_mtx [Required]
A Sky Matrix from the "LB Cumulative Sky Matrix" component or the "LB Benefit Sky Matrix" component, which describes the radiation coming from the various patches of the sky.
context
Rhino Breps and/or Rhino Meshes representing context geometry that can block solar radiation to the center of the radiation rose.
dir_count
An integer greater than or equal to 3, which notes the number of arrows to be generated for the radiation rose. (Default: 36).
tilt_angle
A number between 0 and 90 that sets the vertical tilt angle (aka. the altitude) for all of the directions. By default, the Radiation Rose depicts the amount of solar energy received by a vertical wall (tilt_angle=0). The tilt_angle can be changed to a specific value to assess the solar energy falling on geometries that are not perfectly vertical, such as a tilted photovoltaic panel. (Default: 0).
center_pt
A point for the center of the radiation rose. (Default: (0, 0, 0))
scale
A number to set the scale of the Radiation Rose. The default is 1, which corresponds to a radius of 100 meters in the current Rhino model's unit system.
arrow_scale
A fractional number to note the scale of the radiation rose arrows in relation to the entire graphic. (Default: 1).
max_rad
An optional number to set the level of radiation or irradiance associated with the full radius of the rose. If unspecified, this is determined by the maximum level of radiation in the input data but a number can be specified here to fix this at a specific value. This is particularly useful when comparing different roses to one another.
irradiance
Boolean to note whether the radiation rose should be plotted with units of cumulative Radiation (kWh/m2) [False] or with units of average Irradiance (W/m2) [True]. (Default: False).
show_comp
Boolean to indicate whether only one rose with total radiation should be displayed (False) or three roses with the solar radiation components (total, direct, and diffuse) should be shown. (Default: False).
legend_par
An optional LegendParameter object to change the display of the Radiation Rose.
report
...
mesh
A colored mesh of arrows, representing the intensity of radiation from different cardinal directions.
compass
A set of circles, lines and text objects that mark the cardinal directions in relation to the radiation rose.
orient_lines
A list of line segments marking the orientation of each arrow.
legend
A legend showing the kWh/m2 or W/m2 values that correspond to the colors of the mesh.
title
A text object for the title of the radiation rose.
dir_vecs
A list of vectors for each of the directions the rose is facing. All vectors are unit vectors.
dir_values
Radiation values for each of the rose directions in kWh/m2 or W/m2. This will be one list if show_comp_ is "False" and a list of 3 lists (aka. a Data Tree) for total, direct, diffuse if show_comp_ is "True".
vis_set
Script variable RadRose
