dc

honeybee-radiance dc

Commands to run daylight contribution/ coefficient calculations in Radiance.

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

coeff

Run rfluxmtx command without sky matrix.

This command calculates the coefficient matrix for a sensor grid and sky dome. There is no postprocessing, i.e., no sky matrix.

Args:
octree: Path to octree file.
sensor-grid: Path to sensor grid file.
sky-dome: Path to sky dome for coefficient calculation.
honeybee-radiance dc coeff [OPTIONS] OCTREE SENSOR_GRID SKY_DOME

Options

--sensor-count <sensor_count>

Number of sensors in sensor grid file. Number of sensors will be parsed form the sensor file if not provided.

--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 (.mtx or .dc). If a relative path is provided it should be relative to project folder.

--input-format <input_format>

Format type for input. Valid inputs are a, f and d for ASCII, float or double.

Default

a

Options

a | f | d

--output-format <output_format>

Output type for converted results. Valid inputs are a, f and d for ASCII, float or double.

Default

f

Options

a | f | d

--keep-header, -h-, --remove-header

A flag to keep or remove the header from the output file.

--dry-run

A flag to show the command without running it.

Default

False

Arguments

OCTREE

Required argument

SENSOR_GRID

Required argument

SKY_DOME

Required argument

scoeff

Run rfluxmtx command and pass the results to rmtxop.

octree: Path to octree file.

sensor-grid: Path to sensor grid file.

sky-dome: Path to sky dome for coefficient calculation.

sky-mtx: Path to sky matrix.

honeybee-radiance dc scoeff [OPTIONS] OCTREE SENSOR_GRID SKY_DOME SKY_MTX

Options

--sensor-count <sensor_count>

Number of sensors in sensor grid file. Number of sensors will be parsed form the sensor file if not provided.

--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 (.mtx or .dc). If a relative path is provided it should be relative to project folder.

--conversion <conversion>

conversion as a string which will be passed to rmtxop -c. This option is useful to post-process the results from 3 RGB components into one as part of this command.

--multiply-by <multiply_by>

A value to multiply by all the results. This input is helpful to adjust the values for runs with different timesteps if required. This value will be multiplied by the values provided by converstion input.

--output-format <output_format>

Output type for converted results. Valid inputs are a, f and d for ASCII, float or double.

Default

f

Options

a | f | d

--order-by-sensor, --order-by-datetime

An option to change how results are ordered in each row. By default each row are the results for a sensor during all the sun-up hours. You can change that by using –order-by-datetime flag to get the results for a single datetime in each row.

Default

True

--keep-header, -h-, --remove-header

A flag to keep or remove the header from the output file.

--dry-run

A flag to show the command without running it.

Default

False

Arguments

OCTREE

Required argument

SENSOR_GRID

Required argument

SKY_DOME

Required argument

SKY_MTX

Required argument

scontrib

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

Args:
octree: Path to octree file.
sensor-grid: Path to sensor grid file.
modifiers: Path to modifiers file.
honeybee-radiance dc scontrib [OPTIONS] OCTREE SENSOR_GRID MODIFIERS

Options

--sensor-count <sensor_count>

Number of sensors in sensor grid file. Number of sensors will be parsed form the sensor file if not provided.

--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 (.mtx or .dc). If a relative path is provided it should be relative to project folder.

--coeff, --value

Switch between daylight coefficient and values. Default is coeff for calculating coefficient.

--conversion <conversion>

conversion as a string which will be passed to rmtxop -c. This option is useful to post-process the results from 3 RGB components into one as part of this command.

--multiply-by <multiply_by>

A value to multiply by all the results. This input is helpful to adjust the values for runs with different timesteps if required. This value will be multiplied by the values provided by conversion input.

--output-format <output_format>

Output type for converted results. Valid inputs are a, f and d for ASCII, float or double. If conversion is not provided you can change the output type using rad-params options.

Default

a

Options

a | f | d

--order-by-sensor, --order-by-datetime

An option to change how results are ordered in each row. By default each row are the results for a sensor during all the sun-up hours. You can change that by using –order-by-datetime flag to get the results for a single datetime in each row.

Default

True

--keep-header, -h-, --remove-header

A flag to keep or remove the header from the output file.

--dry-run

A flag to show the command without running it.

Default

False

Arguments

OCTREE

Required argument

SENSOR_GRID

Required argument

MODIFIERS

Required argument