Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Run a point-in-time view-based study for a Honeybee model.
Point-in-time view-based recipes require a sky and can output High Dynamic Range (HDR) images of illuminance, irradiance, luminance or radiance.
The view_count_ input can be used to split each view for parallel processing, producing multiple images that are recombined into a single .HDR for the view at the end of the recipe. The recombination process automatically includes an anti-aliasing pass that smooths and improves the quality of the image. The recipe also performs an overture calculation prior to splitting each view, which results in an image with better interpolation between neighboring pixels.
model [Required]
A Honeybee Model for which a point-in-time view-based study will be run. Note that this model should have views assigned to it in order to produce meaningfule results.
sky [Required]
A Radiance sky from any of the sky components under the "Light Sources" tab. Skies can be either CIE, ClimateBased/Custom, or for a specific Illuminance/Irradiance. This input can also just be a text definition of a sky's paramters. Examples include:
metric
Either an integer or the full name of a point-in-time metric to be computed by the recipe. (Default: luminance). Choose from the following:
resolution
An integer for the maximum dimension of each image in pixels (either width or height depending on the input view angle and type). (Default: 800).
view_filter
Text for a view identifer or a pattern to filter the views of the model that are simulated. For instance, first_floor_* will simulate only the views that have an identifier that starts with first_floor_. By default, all views in the model will be simulated.
skip_overture
A boolean to note whether an ambient file (.amb) should be generated for an overture calculation before the view is split into smaller views. With an overture calculation, the ambient file (aka ambient cache) is first populated with values. Thereby ensuring that - when reused to create an image - Radiance uses interpolation between already calculated values rather than less reliable extrapolation. The overture calculation has comparatively small computation time to full rendering but is single-core can become time consuming in situations with a high view_count_ and workers.
radiance_par
Text for the radiance parameters to be used for ray tracing. (Default: -ab 2 -aa 0.25 -ad 512 -ar 16).
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.
results
High Dynamic Range (HDR) images for each View in the model. These can be plugged into the Ladybug "Image Viewer" component to preview the image. They can also be plugged into the "HB False Color" component to convert the image into a false color version. Lastly, it can be connected to the "HB HDR to GIF" component to get a GIF image that is more portable and easily previewed by different software. Pixel values are in the standard SI units of the requested input metric.
Run an annual irradiance study for a Honeybee model to compute hourly solar irradiance for each sensor in a model's sensor grids.
The fundamental calculation of this recipe is the same as that of "HB Annual Daylight" in that an enhaced 2-phase method is used to accurately account for direct sun at each simulation step. However, this recipe computes broadband solar irradiance in W/m2 instead of visible illuminance in lux.
Consequently, the average irradiance and cumulative radiation values produced from this recipe are more accurate than those produced by the "HB Cumulative Radiation" recipe. Furthermore, because the hourly irriadiance values are accurate, this recipe can be used to evaluate peak_irradiance and determine the worst-case solar loads over clear sky Weas that represent cooling design days.
model [Required]
A Honeybee Model for which Annual Irradiance will be simulated. Note that this model must have grids assigned to it.
wea [Required]
A Wea object produced from the Wea components that are under the Light Sources tab. This can also be the path to a .wea or a .epw file.
timestep
An integer for the timestep of the inpput _wea. This value is used to compute average irradiance and cumulative radiation. (Default: 1)
visible
Boolean to indicate the type of irradiance output, which can be solar (False) or visible (True). Note that the output values will still be irradiance (W/m2) when "visible" is selected but these irradiance values will be just for the visible portion of the electromagnetic spectrum. The visible irradiance values can be converted into illuminance by multiplying them by the Radiance luminous efficacy factor of 179. (Default: False).
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).
grid_filter
Text for a grid identifer or a pattern to filter the sensor grids of the model that are simulated. For instance, first_floor_* will simulate only the sensor grids that have an identifier that starts with first_floor_. By default, all grids in the model will be simulated.
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.
results
Raw result files (.ill) that contain matrices of irradiance in W/m2 for each time step of the wea.
res_direct
Raw result files (.ill) that contain irradiance matrices for just the direct sun at each hour of the simulation. These can be postprocessed using various components under the 4::Results sub-tab.
avg_irr
The average irradiance in W/m2 for each sensor over the Wea time period.
peak_irr
The highest irradiance value in W/m2 during the Wea time period. This is suitable for assessing the worst-case solar load of clear skies on cooling design days. It can also be used to determine the highest radiant temperatures that occupants might experience in over the time period of the Wea.
radiation
The cumulative radiation in kWh/m2 over the Wea time period.
Run an annual glare study for a Honeybee model to compute hourly Daylight Glare Probability (DGP) for each sensor in a model's sensor grids.
This recipe uses the image-less glare method developed by Nathaniel Jones to estimate glare at each sensor. More information on this method can be found here: https://github.com/nljones/Accelerad/wiki/The-Imageless-Method-for-Spatial-and-Annual-Glare-Analysis
The resulting DGP is used to compute Glare Autonomy (GA), which is the percentage of occupied time that a view is free of glare.
model [Required]
A Honeybee Model for which Annual Daylight Glare Probability (DGP) will be simulated. Note that this model must have grids assigned to it and, typically, these are radial grids created using the "radial grid" components.
wea [Required]
A Wea object produced from the Wea components that are under the Light Sources tab. This can also be the path to a .wea or a .epw file. Note that the Wea must have a timestep of 1 to be used with this recipe.
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).
glare_thresh
A fractional number for the threshold of DGP above which conditions are considered to induce glare. This value is used when calculating glare autonomy, which is the percent of hours in which the view is free of glare. (Default: 0.4 for disturbing or intolerable glare).
luminance_fac
Luminance factor in cd/m2. If the sky patch brightness is above this factor it will act as a glare source. (Default: 2000).
schedule
An annual occupancy schedule, either as a Ladybug Hourly Continuous Data Collection or a HB-Energy schedule object. This can also be the path to a CSV file with 8760 rows or the identifier of a schedule in the honeybee-energy schedule library. Any value in this schedule that is 0.1 or above will be considered occupied.
grid_filter
Text for a grid identifer or a pattern to filter the sensor grids of the model that are simulated. For instance, first_floor_* will simulate only the sensor grids that have an identifier that starts with first_floor_. By default, all grids in the model will be simulated.
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.
results
Raw result files (.dgp) that contain Daylight Glare Probability (DGP) matrices for each sensor at each hour of the simulation. These can be postprocessed using various components under the 4::Results sub-tab.
GA
Glare Autonomy (GA) results in percent. GA is the percentage of occupied hours that each view is free of glare (with a DGP below the glare threshold). These can be plugged into the "LB Spatial Heatmap" component along with meshes of the sensor grids to visualize results.
Run a cumulative radiation study for a Honeybee model.
This recipe calculates cumulative radiation (kWh/m2) and average irradiance (W/m2) over the time period of a specified Wea.
The fundamental calculation of this recipe is the same as that of the "LB Incident Radiation" component except that this recipe uses Radiance and can therefore account for ambient reflections. Like LB Incident Radiation, the direct sun in this recipe is diffused between several sky patches and so the precise line between shadow and sun for each hour is blurred. This approximation is acceptable for studies where one is only concerned about the average/total conditions over time and the timestep-by-timestep irradiance values do not need to be exact. For accurate modeling of direct irradiance on a timestep-by-timestep basis, see the "HB Annual Irradiance" recipe.
model [Required]
A Honeybee Model for which Cumulative Radiation will be simulated. Note that this model should have grids assigned to it.
wea [Required]
A Wea object produced from the Wea components that are under the Light Sources tab. This can also be the path to a .wea or a .epw file.
timestep
An integer for the timestep of the inpput _wea. (Default: 1)
sky_density
An integer for the number of times that that the original Tregenza sky patches are subdivided. 1 indicates that 145 patches are used to describe the sky hemisphere, 2 indicates that 577 patches describe the hemisphere, and each successive value will roughly quadruple the number of patches used. Setting this to a high value will result in a more accurate analysis but will take longer to run. (Default: 1).
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).
grid_filter
Text for a grid identifer or a pattern to filter the sensor grids of the model that are simulated. For instance, first_floor_* will simulate only the sensor grids that have an identifier that starts with first_floor_. By default, all grids in the model will be simulated.
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.
avg_irr
The average irradiance in W/m2 for each sensor over the Wea time period.
radiation
The cumulative radiation in kWh/m2 over the Wea time period.
Run a point-in-time grid-based study for a Honeybee model.
Point-in-time recipes require a sky and can output illuminance, irradiance, luminance or radiance.
model [Required]
A Honeybee Model for which a point-in-time grid-based study will be run. Note that this model should have grids assigned to it in order to produce meaningfule results.
sky [Required]
A Radiance sky from any of the sky components under the "Light Sources" tab. Skies can be either CIE, ClimateBased/Custom, or for a specific Illuminance/Irradiance. This input can also just be a text definition of a sky's paramters. Examples include:
metric
Either an integer or the full name of a point-in-time metric to be computed by the recipe. (Default: illuminance). Choose from the following:
grid_filter
Text for a grid identifer or a pattern to filter the sensor grids of the model that are simulated. For instance, first_floor_* will simulate only the sensor grids that have an identifier that starts with first_floor_. By default, all grids in the model will be simulated.
radiance_par