honeybee_plus.radiance.recipe.annual.gridbased module

Radiance Annual Grid-Based Analysis Recipe.

This recipe is identical to daylight coefficient recipe with the exception of how it loads the results. This class is more memory efficient in loading the results however it can only be used for models with no window groups.

class honeybee_plus.radiance.recipe.annual.gridbased.GridBased(sky_mtx, analysis_grids, simulation_type=0, radiance_parameters=None, reuse_daylight_mtx=True, hb_objects=None, sub_folder='gridbased_annual')[source]

Bases: honeybee_plus.radiance.recipe.daylightcoeff.gridbased.DaylightCoeffGridBased

Grid based annual recipe based on daylight coefficient analysis recipe.

This recipe is identical to daylight coefficient recipe with the exception of how it loads the results. This class is more memory efficient in loading the results however it can only be used for models with no window groups.

sky_mtx

A radiance SkyMatrix or SkyVector. For an SkyMatrix the analysis will be ran for the analysis period.

analysis_grids

A list of Honeybee analysis grids. Daylight metrics will be calculated for each analysisGrid separately.

simulation_type

0: Illuminance(lux), 1: Radiation (kWh), 2: Luminance (Candela) (Default: 0)

radiance_parameters

Radiance parameters for this analysis. Parameters should be an instance of RfluxmtxParameters.

hb_objects

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

sub_folder

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

classmethod from_json(rec_json)[source]

Create annual recipe from JSON file { “id”: “annual”, “type”: “gridbased”, “sky_mtx”: {}, // sky matrix json file “analysis_grids”: [], // list of analysis grids “surfaces”: [], // list of honeybee surfaces “simulation_type”: int // value between 0-2 “rad_parameters”: {

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

}

results()[source]

Return results for this analysis.

to_json()[source]

Create annual recipe JSON file { “id”: “annual”, “type”: “gridbased”, “sky_mtx”: {}, // sky matrix json file “analysis_grids”: [], // list of analysis grids “surfaces”: [], // list of honeybee surfaces “simulation_type”: int // value between 0-2 “rad_parameters”: {

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

}

write(target_folder, project_name='untitled', header=True, transpose=False)[source]

Write analysis files to target folder.

Parameters

  • target_folder – Path to parent folder. Files will be created under target_folder/gridbased. use self.sub_folder to change subfolder name.

  • project_name – Name of this project as a string.

  • header – A boolean to include the header lines in commands.bat. header includes PATH and cd toFolder

Returns

Full path to command.bat