honeybee.radiance.recipe.pointintime package

Submodules

honeybee.radiance.recipe.pointintime.gridbased module

Radiance Grid-based Analysis Recipe.

class honeybee.radiance.recipe.pointintime.gridbased.GridBased(sky, analysis_grids, simulation_type=0, rad_parameters=None, hb_objects=None, sub_folder='gridbased')

Bases: honeybee.radiance.recipe._gridbasedbase.GenericGridBased

Grid base analysis base class.

sky

A honeybee sky for the analysis

analysis_grids

List of analysis grids.

simulation_type

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

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”)

Usage:

# create the sky sky = SkyWithCertainIlluminanceLevel(2000)

# initiate analysis_recipe analysis_recipe = GridBased(

sky, testPoints, ptsVectors, simType )

# add honeybee object analysis_recipe.hb_objects = HBObjs

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

# run the analysis analysis_recipe.run(debaug=False)

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

ToString()

Overwrite .NET ToString method.

classmethod from_json(rec_json)

Create the solar access recipe from json. {

“id”: “point_in_time”, “type”: “gridbased”, “sky”: null, // a honeybee sky “surfaces”: [], // list of honeybee surfaces “analysis_grids”: [] // list of analysis grids // [0] illuminance(lux), [1] radiation (kwh), [2] luminance (Candela). “analysis_type”: 0

}

classmethod from_points_and_vectors(sky, point_groups, vector_groups=None, simulation_type=0, rad_parameters=None, hb_objects=None, sub_folder='gridbased')

Create grid based recipe from points and vectors.

Parameters:

• sky – A honeybee sky for the analysis
• 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.
• simulation_type – 0: Illuminance(lux), 1: Radiation (kWh), 2: Luminance (Candela) (Default: 0).
• 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”)

radiance_parameters

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

results()

Return results for this analysis.

simulation_type

**Simulation type* – 0* – Illuminance(lux), 1: Radiation (wh), 2: Luminance (Candela) (Default: 0)

sky

A honeybee sky for the analysis.

to_json()

Create point-in-time recipe from json. {

“id”: “point_in_time”, “type”: “gridbased”, “sky”: null, // a honeybee sky “surfaces”: [], // list of honeybee surfaces “analysis_grids”: [] // list of analysis grids // [0] illuminance(lux), [1] radiation (kwh), [2] luminance (Candela). “analysis_type”: 0

}

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

Write analysis files to target folder.

Files for a grid based analysis are:

test points <project_name.pts>: List of analysis points. sky file <.sky>: Radiance sky for this analysis. material file <.mat>: Radiance materials. Will be empty if hb_objects

is None.

geometry file <*.rad>: Radiance geometries. Will be empty if hb_objects

is None.

sky file <.sky>: Radiance sky for this analysis. batch file <.bat>: An executable batch file which has the list of commands.

oconve <*.sky> <project_name.mat> <project_name.rad> <additional rad_files> > <project_name.oct> rtrace <radiance_parameters> <project_name.oct> > <project_name.res>

results file <*.res>: Results file once the analysis is over.

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.

Returns:

Full path to command.bat

honeybee.radiance.recipe.pointintime.imagebased module

Radiance Grid-based Analysis Recipe.

class honeybee.radiance.recipe.pointintime.imagebased.ImageBased(sky, views, simulation_type=2, rad_parameters=None, hb_objects=None, sub_folder='imagebased')

Bases: honeybee.radiance.recipe._imagebasedbase.GenericImageBased

Grid base analysis base class.

sky

A honeybee sky for the analysis

views

List of views.

simulation_type

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

rad_parameters

Radiance parameters for grid based analysis (rtrace). (Default: imagebased.LowQualityImage)

hb_objects

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

sub_folder

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

Usage:

# create the sky sky = SkyWithCertainIlluminanceLevel(2000)

# initiate analysis_recipe analysis_recipe = ImageBased(

sky, views, simType )

# add honeybee object analysis_recipe.hb_objects = HBObjs

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

# run the analysis analysis_recipe.run(debaug=False)

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

ToString()

Overwrite .NET ToString method.

radiance_parameters

Radiance parameters for grid based analysis (rtrace). (Default: imagebased.LowQualityImage)

results()

Return results for this analysis.

simulation_type

**Simulation type* – 0* – Illuminance(lux), 1: Radiation (kWh), 2: Luminance (Candela) (Default: 0)

sky

A honeybee sky for the analysis.

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

Write analysis files to target folder.

Files for an image based analysis are:

views <.vf>: A radiance view. sky file <.sky>: Radiance sky for this analysis. material file <*.mat>: Radiance materials. Will be empty if hb_objects is

None.

geometry file <*.rad>: Radiance geometries. Will be empty if hb_objects is

None.

sky file <.sky>: Radiance sky for this analysis. batch file <.bat>: An executable batch file which has the list of commands.

oconve <*.sky> <project_name.mat> <project_name.rad> <additional rad_files> > <project_name.oct> rtrace <radiance_parameters> <project_name.oct> > <project_name.res>

results file <*.hdr>: Results file once the analysis is over.

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.

Returns:

Full path to command.bat

Module contents

Point-in-time recipes.