Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Spatially visualize the detailed results of a thermal mapping analysis from a comfort matrix.
comf_mtx [Required]
A comfort Matrix object from the "HB Read Thermal Matrix" component.
mesh [Required]
Mesh objects that correspond with the sensor grids of the thermal map analysis. These will be , with a number of faces or vertices that match the number of input values and will be colored with results.
sim_step
An optional integer (greater than or equal to 0) to select a specific time step of the comfort results to be displayed. Note that this will override any connected period.
period
A Ladybug analysis period to be applied to select a slice of time across the comfort results to be displayed.
legend_par
An optional LegendParameter object to change the display of the results.
report
...
mesh
The input mesh objects colored with results.
legend
Geometry representing the legend for the results.
title
A text object for the title.
colors
The colors associated with each input value.
values
A list of numbers for each face of the mesh, which are used to generate the colors.
Compute spatially-resolved operative temperature and Adaptive thermal comfort from a Honeybee model.
This recipe uses EnergyPlus to obtain surface temperatures and indoor air temperatures + humidities. Outdoor air temperatures, relative humidities, and air speeds are taken directly from the EPW. The energy properties of the model geometry are what determine the outcome of the simulation, though the model's Radiance sensor grids are what determine where the comfort mapping occurs.
Longwave radiant temperatures are obtained by computing spherical view factors from each sensor to the Room surfaces of the model using Radiance. These view factors are then multiplied by the surface temperatures output by EnergyPlus to yield longwave MRT at each sensor. All indoor shades (eg. those representing furniture) are assumed to be at the room-average MRT.
A Radiance-based enhanced 2-phase method is used for all shortwave MRT calculations, which precisely represents direct sun by tracing a ray from each sensor to the solar position. To determine Thermal Comfort Percent (TCP), the occupancy schedules of the energy model are used. Any hour of the occupancy schedule that is 0.1 or greater will be considered occupied. All hours of the outdoors are considered occupied.
model [Required]
A Honeybee Model for which adaptive comfort will be mapped. Note that this model should have radiance grids assigned to it in order to produce meaningful results.
epw [Required]
Path to an EPW weather file to be used for the comfort map simulation.
ddy [Required]
Path to a DDY file with design days to be used for the initial sizing calculation of the energy simulation.
north
A number between -360 and 360 for the counterclockwise difference between the North and the positive Y-axis in degrees. This can also be Vector for the direction to North. (Default: 0).
run_period
An AnalysisPeriod to set the start and end dates of the simulation. If None, the simulation will be annual.
add_str
THIS OPTION IS FOR ADVANCED USERS OF ENERGYPLUS. You can input additional text strings here to be appended to the IDF before energy simulation. The input should be complete EnergyPlus objects following the IDF format. This input can be used to write objects into the IDF that are not currently supported by Honeybee.
air_speed
A single number for air speed in m/s or an hourly data collection of air speeds that align with the input run_period_. This will be used for all indoor comfort evaluation. Note that the EPW wind speed will be used for any outdoor sensors. (Default: 0.1).
comfort_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.
solar_body_par
Optional solar body parameters from the "LB Solar Body Parameters" object to specify the properties of the human geometry assumed in the shortwave MRT calculation. The default assumes average skin/clothing absorptivity and a human subject always has their back to the sun at a 45-degree angle (SHARP = 135).
radiance_par
Text for the radiance parameters to be used for ray tracing. (Default: -ab 2 -ad 5000 -lw 2e-05).
run_settings
Settings from the "HB Recipe Settings" component that specify how the recipe should be run. This can also be a text string of recipe settings.
run [Required]
Set to True to run the recipe and get results. This input can also be the integer "2" to run the recipe silently.
report
Reports, errors, warnings, etc.
env_conds
A folder containing CSV matrices with all of the environmental conditions that were input to the comfort model. These can be loaded into Grasshopper using the "HB Read Environment Matrix" component. This includes the following.
op_temp
A folder containing CSV maps of Operative Temperature for each sensor grid at each time step of the analysis. This can be connected to the "HB Read Thermal Matrix" component to parse detailed results into Grasshopper. Values are in Celsius.
condition
A folder containing CSV maps of comfort conditions for each sensor grid at each time step of the analysis. This can be connected to the "HB Read Thermal Matrix" component to parse detailed results into Grasshopper. Values are as follows.
deg_neut
A folder containing CSV maps of the degrees Celsius from the adaptive comfort neutral temperature for each sensor grid at each time step of the analysis. This can be connected to the "HB Read Thermal Matrix" component to parse detailed results into Grasshopper. This can be used to understand not just whether conditions are acceptable but how uncomfortably hot or cold they are.
TCP
Lists of values between 0 and 100 for the Thermal Comfort Percent (TCP). These can be plugged into the "LB Spatial Heatmap" component along with meshes of the sensor grids to visualize spatial thermal comfort. TCP is the percentage of occupied time where thermal conditions are acceptable/comfortable. Occupied hours are determined from the occupancy schedules of each room (any time where the occupancy schedule is >= 0.1 will be considered occupied). Outdoor sensors are considered occupied at all times. More custom TCP studies can be done by post-processing the condition results.
HSP
Lists of values between 0 and 100 for the Heat Sensation Percent (HSP). These can be plugged into the "LB Spatial Heatmap" component along with meshes of the sensor grids to visualize uncomfortably hot locations. HSP is the percentage of occupied time where thermal conditions are hotter than what is considered acceptable/comfortable. Occupied hours are determined from the occupancy schedules of each room (any time where the occupancy schedule is >= 0.1 will be considered occupied). Outdoor sensors are considered occupied at all times. More custom HSP studies can be done by post-processing the condition results.
CSP
Lists of values between 0 and 100 for the Cold Sensation Percent (CSP). These can be plugged into the "LB Spatial Heatmap" component along with meshes of the sensor grids to visualize uncomfortably cold locations. CSP is the percentage of occupied time where thermal conditions are colder than what is considered acceptable/comfortable. Occupied hours are determined from the occupancy schedules of each room (any time where the occupancy schedule is >= 0.1 will be considered occupied). Outdoor sensors are considered occupied at all times. More custom CSP studies can be done by post-processing the condition results.
-
Read the detailed environmental conditions of a thermal mapping analysis from the env_conds output by a thermal mapping component.
Environemntal conditions include raw inputs to the thermal comfort model, such as air temperature, MRT, longwave MRT, and shortwave MRT delta.
env_conds [Required]
Path to a folder containing the detailed environmental conditions output by a thermal mapping component.
metric
Text or an integer for the specific metric to be loaded from the environmental conditions. (Default: MRT). Choose from the following.
load [Required]
Set to True to load the data into Grasshopper.
comf_mtx
A Matrix object that can be connected to the "HB Visualize Thermal Map" component in order to spatially visualize results. This Matrix object can also be connected to the "LB Deconstruct Matrix" component to obtain detailed point-by-point and hour-by-hour values. When deconstructed, each sub-list of the matrix (aka. branch of the Data Tree) represents one of the sensor grids used for analysis. The length of each sub-list matches the number of points in the grid. Each value in the sub-list is an hourly data collection containing hour-by-hour results for each point.
-
Compute spatially-resolved Universal Thermal Climate Index (UTCI) and heat/cold stress conditions an EPW and Honeybee model.
This recipe uses EnergyPlus to obtain surface temperatures and indoor air temperatures + humidities. Outdoor air temperatures, relative humidities, and air speeds are taken directly from the EPW. The energy properties of the model geometry are what determine the outcome of the simulation, though the model's Radiance sensor grids are what determine where the comfort mapping occurs.
Longwave radiant temperatures are obtained by computing spherical view factors from each sensor to the Room surfaces of the model using Radiance. These view factors are then multiplied by the surface temperatures output by EnergyPlus to yield longwave MRT at each sensor. For outdoor sensors, each sensor's sky view is multiplied by the EPW sky temperature to account for longwave radiant exchange with the sky. All outdoor context shades and the ground are assumed to be at the EPW air temperature unless they have been modeled as Honeybee rooms.
A Radiance-based enhanced 2-phase method is used for all shortwave MRT calculations, which precisely represents direct sun by tracing a ray from each sensor to the solar position. To determine Thermal Comfort Percent (TCP), the occupancy schedules of the energy model are used for indoor sensors if no schedule_ is input. Any hour of the energy model occupancy schedule that is 0.1 or greater will be considered occupied. If no schedule_ is input, all hours of the outdoors are considered occupied.
model [Required]
A Honeybee Model for which UTCI comfort will be mapped. Note that this model should have radiance grids assigned to it in order to produce meaningful results.
epw [Required]
Path to an EPW weather file to be used for the comfort map simulation.
ddy
Path to a DDY file with design days to be used for the initial sizing calculation of the energy simulation. Providing this input is important when there are conditioned Room geometries in the model, in which case the sizing of the building heating/cooling systems is important for modeling the heat exchange between indoors and outdoors. Otherwise, it can be ignored with little consequence for the simulation.
north
A number between -360 and 360 for the counterclockwise difference between the North and the positive Y-axis in degrees. This can also be Vector for the direction to North. (Default: 0).
run_period
An AnalysisPeriod to set the start and end dates of the simulation. If None, the simulation will be annual.
wind_speed
A single number for meteorological wind speed in m/s or an hourly data collection of wind speeds that align with the input run_period_. This will be used for all outdoor comfort evaluation. This can also be the path to a folder with csv files that align with the model sensor grids. Each csv file should have the same name as the sensor grid. Each csv file should contain a matrix of air speed values in m/s with one row per sensor and one column per timestep of the run period. Note that, when using this type of matrix input, these values are not meteorological and should be AT HUMAN SUBJECT LEVEL. If unspecified, the EPW wind speed will be used for all outdoor sensors and all sensors on the indoors will use a wind speed of 0.5 m/s, which is the lowest acceptable value for the UTCI model.
schedule
A schedule to specify the relevant times during which comfort should be evaluated. This must either be a Ladybug Hourly Data Collection that aligns with the input run_period_ or the path to a CSV file with a number of rows equal to the length of the run_period_. If unspecified, it will be assumed that all times are relevant for outdoor sensors and the energy model occupancy schedules will be used for indoor sensors.
comfort_par
Optional comfort parameters from the "LB UTCI Comfort Parameters" component to specify the temperatures (in Celcius) that are considered acceptable/comfortable. The default will assume a that the comfort range is between 9C and 26C.
solar_body_par
Optional solar body parameters from the "LB Solar Body Parameters" object to specify the properties of the human geometry assumed in the shortwave MRT calculation. The default assumes average skin/clothing absorptivity and a human subject always has their back to the sun at a 45-degree angle (SHARP = 135).
radiance_par
Text for the radiance parameters to be used for ray tracing. (Default: -ab 2 -ad 5000 -lw 2e-05).
run_settings
Settings from the "HB Recipe Settings" component that specify how the recipe should be run. This can also be a text string of recipe settings.
run [Required]
Set to True to run the recipe and get results. This input can also be the integer "2" to run the recipe silently.
report
Reports, errors, warnings, etc.
env_conds
A folder containing CSV matrices with all of the environmental conditions that were input to the comfort model. These can be loaded into Grasshopper using the "HB Read Environment Matrix" component. This includes the following.
utci
A folder containing CSV maps of Universal Thermal Climate Index (UTCI) temperatures for each sensor grid at each time step of the analysis. This can be connected to the "HB Read Thermal Matrix" component to parse detailed results into Grasshopper. Values are in Celsius.
condition
A folder containing CSV maps of comfort conditions for each sensor grid at each time step of the analysis. This can be connected to the "HB Read Thermal Matrix" component to parse detailed results into Grasshopper. Values are as follows.
category
A folder containing CSV maps of the heat/cold stress categories for each sensor grid at each time step of the analysis. This can be connected to the "HB Read Thermal Matrix" component to parse detailed results into Grasshopper. This can be used to understand not just whether conditions are acceptable but how uncomfortably hot or cold they are. Values indicate the following.
TCP
Lists of values between 0 and 100 for the Thermal Comfort Percent (TCP). These can be plugged into the "LB Spatial Heatmap" component along with meshes of the sensor grids to visualize spatial thermal comfort. TCP is the percentage of occupied time where thermal conditions are acceptable/comfortable. Occupied hours are determined from the occuppancy schedules of each room (any time where the occupancy schedule is >= 0.1 will be considered occupied). Outdoor sensors are considered occupied at all times. More custom TCP studies can be done by post-processing the condition results.
HSP
Lists of values between 0 and 100 for the Heat Sensation Percent (HSP). These can be plugged into the "LB Spatial Heatmap" component along with meshes of the sensor grids to visualize uncomfortably hot locations. HSP is the percentage of occupied time where thermal conditions are hotter than what is considered acceptable/comfortable. Occupied hours are determined from the occuppancy schedules of each room (any time where the occupancy schedule is >= 0.1 will be considered occupied). Outdoor sensors are considered occupied at all times. More custom HSP studies can be done by post-processing the condition results.
CSP
Lists of values between 0 and 100 for the Cold Sensation Percent (CSP). These can be plugged into the "LB Spatial Heatmap" component along with meshes of the sensor grids to visualize uncomfortably cold locations. CSP is the percentage of occupied time where thermal conditions are colder than what is considered acceptable/comfortable. Occupied hours are determined from the occuppancy schedules of each room (any time where the occupancy schedule is >= 0.1 will be considered occupied). Outdoor sensors are considered occupied at all times. More custom CSP studies can be done by post-processing the condition results.
Read the detailed results of a thermal mapping analysis from a folder of CSV files output by a thermal mapping component.
Detailed results include temperature amd thermal condition results. It also includes metrics that give a sense of how hot or cold condition are like pmv, utci category, or adaptive comfort degrees from neutral temperature.
comf_result [Required]
Path to a folder containing CSV files output by a thermal mapping component.
load [Required]
Set to True to load the data from the CSV files into Grasshopper.
comf_mtx
A Matrix object that can be connected to the "HB Visualize Thermal Map" component in order to spatially visualize results. This Matrix object can also be connected to the "LB Deconstruct Matrix" component to obtain detailed point-by-point and hour-by-hour values.
When deconstructed, each sub-list of the matrix (aka. branch of the Data Tree) represents one of the sensor grids used for analysis. The length of each sub-list matches the number of points in the grid. Each value in the sub-list is an hourly data collection containing hour-by-hour results for each point.
Compute spatially-resolved operative temperature and Predicted Mean Vote (PMV) thermal comfort from a Honeybee model. This recipe can also (optionally) compute Standard Effective Temperature (SET).
This recipe uses EnergyPlus to obtain surface temperatures and indoor air temperatures + humidities. Outdoor air temperatures, relative humidities, and air speeds are taken directly from the EPW. The energy properties of the model geometry are what determine the outcome of the simulation, though the model's Radiance sensor grids are what determine where the comfort mapping occurs.
Longwave radiant temperatures are obtained by computing spherical view factors from each sensor to the Room surfaces of the model using Radiance. These view factors are then multiplied by the surface temperatures output by EnergyPlus to yield longwave MRT at each sensor. All indoor shades (eg. those representing furniture) are assumed to be at the room-average MRT.
A Radiance-based enhanced 2-phase method is used for all shortwave MRT calculations, which precisely represents direct sun by tracing a ray from each sensor to the solar position. To determine Thermal Comfort Percent (TCP), the occupancy schedules of the energy model are used. Any hour of the occupancy schedule that is 0.1 or greater will be considered occupied. All hours of the outdoors are considered occupied.
model [Required]
A Honeybee Model for which PMV comfort will be mapped. Note that this model should have radiance grids assigned to it in order to produce meaningful results.
epw [Required]
Path to an EPW weather file to be used for the comfort map simulation.
ddy [Required]
Path to a DDY file with design days to be used for the initial sizing calculation of the energy simulation.
north
A number between -360 and 360 for the counterclockwise difference between the North and the positive Y-axis in degrees. This can also be Vector for the direction to North. (Default: 0).
run_period
An AnalysisPeriod to set the start and end dates of the simulation. If None, the simulation will be annual.
add_str
THIS OPTION IS FOR ADVANCED USERS OF ENERGYPLUS. You can input additional text strings here to be appended to the IDF before energy simulation. The input should be complete EnergyPlus objects following the IDF format. This input can be used to write objects into the IDF that are not currently supported by Honeybee.
write_set_map
A boolean to note whether the output temperature CSV should record Operative Temperature or Standard Effective Temperature (SET). SET is relatively intense to compute and so only recording Operative Temperature can greatly reduce run time, particularly when air speeds are low. However, SET accounts for all 6 PMV model inputs and so is a more representative "feels-like" temperature for the PMV model.
air_speed
A single number for air speed in m/s or an hourly data collection of air speeds that align with the input run_period_. This will be used for all indoor comfort evaluation. Note that the EPW wind speed will be used for any outdoor sensors. (Default: 0.1).
met_rate
A single number for metabolic rate in met or an hourly data collection of met rates that align with the run_period_. (Default: 1.1, for seated, typing).
clo_value
A single number for clothing level in clo or an hourly data collection of clothing levels that align with the run_period_. (Default: 0.7, for pants and a long sleeve shirt).
comfort_par
Optional comfort parameters from the "LB PMV Comfort Parameters" component to specify the criteria under which conditions are considered acceptable/comfortable. The default will assume a PPD threshold of 10% and no absolute humidity constraints.
solar_body_par
Optional solar body parameters from the "LB Solar Body Parameters" object to specify the properties of the human geometry assumed in the shortwave MRT calculation. The default assumes average skin/clothing absorptivity and a human subject always has their back to the sun at a 45-degree angle (SHARP = 135).
radiance_par
Text for the radiance parameters to be used for ray tracing. (Default: -ab 2 -ad 5000 -lw 2e-05).
run_settings
Settings from the "HB Recipe Settings" component that specify how the recipe should be run. This can also be a text string of recipe settings.
run [Required]
Set to True to run the recipe and get results. This input can also be the integer "2" to run the recipe silently.
report
Reports, errors, warnings, etc.
env_conds
A folder containing CSV matrices with all of the environmental conditions that were input to the comfort model. These can be loaded into Grasshopper using the "HB Read Environment Matrix" component. This includes the following.
temperature
A folder containing CSV maps of Operative Temperature for each sensor grid at each time step of the analysis. Alternatively, if the write_set_map_ option is used, the CSV maps here will contain Standard Effective Temperature (SET). This can be connected to the "HB Read Thermal Matrix" component to parse detailed results into Grasshopper. Values are in Celsius.
condition
A folder containing CSV maps of comfort conditions for each sensor grid at each time step of the analysis. This can be connected to the "HB Read Thermal Matrix" component to parse detailed results into Grasshopper. Values are as follows.
pmv
A folder containing CSV maps of the Predicted Mean Vote (PMV) for each sensor grid at each time step of the analysis. This can be connected to the "HB Read Thermal Matrix" component to parse detailed results into Grasshopper. This can be used to understand not just whether conditions are acceptable but how uncomfortably hot or cold they are.
TCP
Lists of values between 0 and 100 for the Thermal Comfort Percent (TCP). These can be plugged into the "LB Spatial Heatmap" component along with meshes of the sensor grids to visualize spatial thermal comfort. TCP is the percentage of occupied time where thermal conditions are acceptable/comfortable. Occupied hours are determined from the occupancy schedules of each room (any time where the occupancy schedule is >= 0.1 will be considered occupied). Outdoor sensors are considered occupied at all times. More custom TCP studies can be done by post-processing the condition results.
HSP
Lists of values between 0 and 100 for the Heat Sensation Percent (HSP). These can be plugged into the "LB Spatial Heatmap" component along with meshes of the sensor grids to visualize uncomfortably hot locations. HSP is the percentage of occupied time where thermal conditions are hotter than what is considered acceptable/comfortable. Occupied hours are determined from the occupancy schedules of each room (any time where the occupancy schedule is >= 0.1 will be considered occupied). Outdoor sensors are considered occupied at all times. More custom HSP studies can be done by post-processing the condition results.
CSP
Lists of values between 0 and 100 for the Cold Sensation Percent (CSP). These can be plugged into the "LB Spatial Heatmap" component along with meshes of the sensor grids to visualize uncomfortably cold locations. CSP is the percentage of occupied time where thermal conditions are colder than what is considered acceptable/comfortable. Occupied hours are determined from the occupancy schedules of each room (any time where the occupancy schedule is >= 0.1 will be considered occupied). Outdoor sensors are considered occupied at all times. More custom CSP studies can be done by post-processing the condition results.
