raytrace¶

honeybee-radiance raytrace¶

Commands to run ray-tracing in Radiance.

honeybee-radiance raytrace [OPTIONS] COMMAND [ARGS]...

daylight-factor¶

Run rtrace command with rcalc post-processing for daylight factor studies.

Args:

octree: Path to octree file.

sensor_grid: Path to sensor grid file.

honeybee-radiance raytrace daylight-factor [OPTIONS] OCTREE SENSOR_GRID

Options

--rad-params <rad_params>¶: Radiance parameters.

--rad-params-locked <rad_params_locked>¶: Protected Radiance parameters. These values will overwrite user input rad parameters.

-i, --sky-illum <sky_illum>¶

Sky illuminance value. The post-processed results will be divided by this number.

Default:: 100000

-o, --output <output>¶: Path to output file. If a relative path is provided it should be relative to project folder.

--dry-run¶

A flag to show the command without running it.

Default:: False

Arguments

OCTREE¶: Required argument

SENSOR_GRID¶: Required argument

point-in-time¶

Run rtrace command with rcalc post-processing for point-in-time studies.

Args:

octree: Path to octree file.

sensor_grid: Path to sensor grid file.

honeybee-radiance raytrace point-in-time [OPTIONS] OCTREE SENSOR_GRID

Options

--rad-params <rad_params>¶: Radiance parameters.

--rad-params-locked <rad_params_locked>¶: Protected Radiance parameters. These values will overwrite user input rad parameters.

-m, --metric <metric>¶

Text for the type of metric to be output from the calculation. Choose from: illuminance, irradiance, luminance, radiance.

Default:: 'illuminance'

-o, --output <output>¶: Path to output file. If a relative path is provided it should be relative to project folder.

--dry-run¶

A flag to show the command without running it.

Default:: False

Arguments

OCTREE¶: Required argument

SENSOR_GRID¶: Required argument

rtrace¶

Run rtrace command for an input octree and a sensor grid.

Args:

octree: Path to octree file.

sensor_grid: Path to sensor grid file.

honeybee-radiance raytrace rtrace [OPTIONS] OCTREE SENSOR_GRID

Options

--rad-params <rad_params>¶: Radiance parameters.

--rad-params-locked <rad_params_locked>¶: Protected Radiance parameters. These values will overwrite user input rad parameters.

-o, --output <output>¶: Path to output file. If a relative path is provided it should be relative to project folder.

--dry-run¶

A flag to show the command without running it.

Default:: False

Arguments

OCTREE¶: Required argument

SENSOR_GRID¶: Required argument