honeybee_plus.radiance.recipe.parameters module

Radiance parameters collection for recipes.

Note on default parameters for daylight coefficient based studies

  1. These parameters are meant specifically for rcontrib-based workflows and are not

    applicable to conventional rpict- and rtrace- based simulations.

  2. The values in tuples DCDEFAULTS, VMDEFAULTS are geared towards illuminance

    simulations. The values for DMDEFAULTS and SMDEFAULTS can be used with image-based simulations too.

  3. The value for limit-weight should be a value less than 1/ambient-divisions. The

    current values have been assigned as (1/ambient-divisions)*0.01. This should be taken into account if these parameters are being changed in the future.

  4. Finally, in the present scenario, there are no optimized set of parameters to

    bring any simulation results to convergence using Monte-Carlo simulations. So, these default values are based on best-practice discussions and experience of developers.

class honeybee_plus.radiance.recipe.parameters.Parameters(rad, vmtx, dmtx, smtx)

Bases: tuple

property dmtx

Alias for field number 2

property rad

Alias for field number 0

property smtx

Alias for field number 3

property vmtx

Alias for field number 1

honeybee_plus.radiance.recipe.parameters.get_radiance_parameters_grid_based(quality, rec_type)[source]

Get Radiance parameters for grid based recipes.

Parameters

  • quality – 0 > low, 1 > Medium, 2 > High

  • rec_type – Type of recipe. 0 > Point-in-time, 1 > Daylight Coeff., 2 > 3Phase, 3 > 5Phase

Returns

radiance_parameters, viewMatrixParameters, daylight_matrixParameters, sun_matrixParameters

honeybee_plus.radiance.recipe.parameters.get_radiance_parameters_image_based(quality, rec_type)[source]

Get Radiance parameters for image based recipes.

Parameters

  • quality – 0 > low, 1 > Medium, 2 > High

  • rec_type – Type of recipe. 0 > Point-in-time, 1 > Daylight Coeff., 2 > 3Phase, 3 > 5Phase

Returns

radiance_parameters, viewMatrixParameters, daylight_matrixParameters