honeybee.radiance.recipe.fivephase package

Submodules

honeybee.radiance.recipe.fivephase.gridbased module

class honeybee.radiance.recipe.fivephase.gridbased.FivePhaseGridBased(sky_mtx, analysis_grids, simulation_type=0, view_mtx_parameters=None, daylight_mtx_parameters=None, reuse_view_mtx=True, reuse_daylight_mtx=True, hb_objects=None, sub_folder='gridbased_fivephase')

Bases: honeybee.radiance.recipe.threephase.gridbased.ThreePhaseGridBased

Grid based five phase analysis recipe.

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: “daylightcoeff”).

Usage:

# initiate analysis_recipe analysis_recipe = ThreePhaseGridBased(

sky_mtx, analysis_grids, rad_parameters )

# add honeybee object analysis_recipe.hb_objects = HBObjs

# write analysis files to local drive commandsFile = analysis_recipe.write(_folder_, _name_)

# run the analysis analysis_recipe.run(commandsFile)

# get the results print(analysis_recipe.results())

classmethod from_json(rec_json)

Create five phase recipe from JSON file { “id”: “five_phase”, “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 “view_mtx_parameters”: {} // radiance gridbased parameters json file “daylight_mtx_parameters”: {} //radiance gridbased parameters json file }

to_json()

Create five phase recipe JSON file { “id”: “five_phase”, “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 “view_mtx_parameters”: {} // radiance gridbased parameters json file “daylight_mtx_parameters”: {} //radiance gridbased parameters json file }

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

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 path to radiance folder in commands file.

Returns:

Path yo commands file.

Module contents

Radiance five-phase recipes.