honeybee_plus.radiance.recipe.threephase.gridbased module

class honeybee_plus.radiance.recipe.threephase.gridbased.ThreePhaseGridBased(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_threephase')

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

Grid based three 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())

property daylight_mtx_parameters

View matrix parameters.

classmethod from_json(rec_json)

Create three phase recipe from JSON file { “id”: “three_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 }

classmethod from_points_file(epw_file, points_file, sky_density=1, simulation_type=0, view_mtx_parameters=None, daylight_mtx_parameters=None, reuse_view_mtx=True, reuse_daylight_mtx=True, hb_window_surfaces=None, hb_objects=None, sub_folder='gridbased_threephase')

Create an annual recipe from points file.

classmethod from_weather_file_points_and_vectors(epw_file, point_groups, vector_groups=None, sky_density=1, simulation_type=0, view_mtx_parameters=None, daylight_mtx_parameters=None, reuse_view_mtx=True, reuse_daylight_mtx=True, hb_window_surfaces=None, hb_objects=None, sub_folder='gridbased_threephase')

Create three-phase recipe from weather file, points and vectors.

Parameters

• epw_file – An EnergyPlus weather file.

• 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.

• sky_density – A positive intger for sky density. 1: Tregenza Sky, 2: Reinhart Sky, etc. (Default: 1)

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

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

property sky_density

Radiance sky type e.g. r1, r2, r4.

to_json()

Create three phase recipe JSON file { “id”: “three_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 }

property view_mtx_parameters

View matrix parameters.

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.