honeybee.radiance.recipe.daylightcoeff package

Submodules

honeybee.radiance.recipe.daylightcoeff.gridbased module

Radiance Daylight Coefficient Grid-Based Analysis Recipe.

class honeybee.radiance.recipe.daylightcoeff.gridbased.DaylightCoeffGridBased(sky_mtx, analysis_grids, simulation_type=0, radiance_parameters=None, reuse_daylight_mtx=True, hb_objects=None, sub_folder='gridbased_daylightcoeff')

Bases: honeybee.radiance.recipe._gridbasedbase.GenericGridBased

Grid based daylight coefficient 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 = DaylightCoeffGridBased(

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 daylight coefficient recipe from JSON file { “id”: “daylight_coeff”, “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”: {} // radiance gridbased parameters json file }

classmethod from_points_file(epw_file, points_file, sky_density=1, simulation_type=0, radiance_parameters=None, reuse_daylight_mtx=True, hb_objects=None, sub_folder='gridbased_daylightcoeff')

Create grid based daylight coefficient recipe from points file.

classmethod from_weather_file_points_and_vectors(epw_file, point_groups, vector_groups=None, sky_density=1, simulation_type=0, radiance_parameters=None, reuse_daylight_mtx=True, hb_objects=None, sub_folder='gridbased_daylightcoeff')

Create grid based daylight coefficient 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”)

preproc_commands()

Add echo in front of comments in batch file comments.

radiance_parameters

Radiance parameters for annual analysis.

results()

Return results for this analysis.

simulation_type

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

sky_density

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

sky_matrix

Get and set sky definition.

to_json()

Create daylight coefficient JSON file { “id”: “daylight_coeff”, “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”: {} // radiance gridbased parameters json file }

total_runs_count

Number of total runs for all window groups and states.

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 the header lines in commands.bat. header includes PATH and cd toFolder

Returns:

Full path to command.bat

honeybee.radiance.recipe.daylightcoeff.imagebased module

Radiance Daylight Coefficient Image-Based Analysis Recipe.

class honeybee.radiance.recipe.daylightcoeff.imagebased.DaylightCoeffImageBased(sky_mtx, views, simulation_type=2, daylight_mtx_parameters=None, vwrays_parameters=None, reuse_daylight_mtx=True, hb_objects=None, sub_folder='imagebased_daylightcoeff')

Bases: honeybee.radiance.recipe._imagebasedbase.GenericImageBased

Daylight Coefficient Image-Based.

sky_mtx

A honeybee sky for the analysis

views

List of views.

simulation_type

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

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:

ToString()

Overwrite .NET ToString method.

daylight_mtx_parameters

Radiance parameters for image based analysis (rfluxmtx). (Default: imagebased.LowQualityImage)

is_daylight_mtx_created(study_folder, view, wg, state)

Check if hdr images for daylight matrix are already created.

is_hdr_mtx_created(study_folder, view, wg, state, stype)

Check if hourly hdr images for daylight matrix are already created.

is_sun_mtx_created(study_folder, view, wg, state)

Check if hdr images for daylight matrix are already created.

results()

Return results for this analysis.

simulation_type

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

sky_density

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

sky_matrix

A honeybee sky for the analysis.

vwrays_parameters

Radiance parameters for vwrays. (Default: imagebased.LowQualityImage)

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

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.

Returns:

Full path to command.bat

Module contents

Radiance daylight coefficient recipes.

Daylight coefficient recipes support both grid-based and image-based analysis.