honeybee_plus.radiance.command.rtrace module

class honeybee_plus.radiance.command.rtrace.Rtrace(output_name='untitled', octree_file=None, points_file=None, simulation_type=0, radiance_parameters=None)

Bases: honeybee_plus.radiance.command._commandbase.RadianceCommand

Create a grid-based Radiance ray-tracer.

Read more at: http://radsite.lbl.gov/radiance/man_html/rtrace.1.html

output_name

Name of output file (Default: untitled).

octree_file

Full path to input oct files (Default: None)

points_file

Full path to input pt files (Default: None)

simulation_type

An integer to define type of analysis. 0: Illuminance (lux), 1: Radiation (kWh), 2: Luminance (Candela) (Default: 0)

radiance_parameters

Radiance parameters for this analysis. (Default: girdbased.LowQuality)

property input_files

Input files for this command.

octree_file = None

Full path to input oct file.

output_file = None

oct file name which is usually the same as the project name (Default: untitled)

points_file = None

Full path to input points file.

property radiance_parameters

Radiance parameters for this analysis (Default: RadianceParameters.LowQuality).

property simulation_type

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

Type

Simulation type

Type

0

to_rad_string(relative_path=False)

Return full command as a string.