honeybee_plus.radiance.recipe.daylightfactor.gridbased module

Radiance Grid-based Analysis Recipe.

class honeybee_plus.radiance.recipe.daylightfactor.gridbased.GridBased(analysis_grids, rad_parameters=None, hb_objects=None, sub_folder='daylightfactor')[source]

Bases: honeybee_plus.radiance.recipe.pointintime.gridbased.GridBased

Daylight factor grid based analysis.

analysis_grids

List of analysis grids.

rad_parameters

Radiance parameters for grid based analysis (rtrace). (Default: gridbased.LowQuality)

hb_objects

An optional list of Honeybee surfaces or zones (Default: None).

sub_folder

Analysis subfolder for this recipe. (Default: “daylightfactor”)

SKYILLUM = 100000
classmethod from_json(rec_json)[source]

Create Daylight Factor recipe from json. { “id”: “daylight_factor”, “type”: “gridbased”, “analysis_grids”: [], // list of analysis grids “surfaces”: [], // list of honeybee surfaces “rad_parameters”: {

gridbased_parameters: string // A standard radiance parameter string (e.g. -ab 5 -aa 0.05 -ar 128) },

}

classmethod from_points_and_vectors(point_groups, vector_groups=None, rad_parameters=None, hb_objects=None, sub_folder='gridbased')[source]

Create grid based recipe from points and vectors.

Parameters
  • point_groups – A list of (x, y, z) test points or lists of (x, y, z) test points. Each list of test points will be converted to a TestPointGroup. If testPts is a single flattened list only one TestPointGroup will be created.

  • vector_groups – An optional list of (x, y, z) vectors. Each vector represents direction of corresponding point in testPts. If the vector is not provided (0, 0, 1) will be assigned.

  • rad_parameters – Radiance parameters for grid based analysis (rtrace). (Default: gridbased.LowQuality)

  • hb_objects – An optional list of Honeybee surfaces or zones (Default: None).

  • sub_folder – Analysis subfolder for this recipe. (Default: “gridbased”)

property legend_parameters

Legend parameters for daylight factor analysis.

results()[source]

Return results for this analysis.

to_json()[source]

Convert Daylight Factor recipe to json. { “id”: “daylight_factor”, “type”: “gridbased”, “analysis_grids”: [], // list of analysis grids “surfaces”: [], // list of honeybee surfaces “rad_parameters”: {

gridbased_parameters: tring // A standard radiance parameter string (e.g. -ab 5 -aa 0.05 -ar 128) },

}