threephase¶

honeybee-radiance three_phase¶

Commands to do matrix operations for three-phase.

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

combinations¶

Matrix multiplication for view matrix, transmission matrix, daylight matrix and sky matrix.

args:

sender_info: A JSON file that includes the information for senders. This file

is created as an output of the daylight matrix grouping command.

receiver_info: A JSON file that includes the information for receivers. This

file is written to model/receiver folder.

states_info: A JSON file that includes the state information for all the

aperture groups. This file is created under model/aperture_groups.

honeybee-radiance three_phase combinations [OPTIONS] SENDER_INFO RECEIVER_INFO
                                           STATES_INFO

Options

--folder <folder>¶

Path to target folder. The command will create two JSON files in this folder.

Default:: '.'

-cn, --combinations-name <combinations_name>¶

Output file name for 3 phase multiplication combinations.

Default:: '3phase_multiplication_info'

-rn, --result-mapper-name <result_mapper_name>¶

Output file name for results mapper file.

Default:: '3phase_results_info'

Arguments

SENDER_INFO¶: Required argument

RECEIVER_INFO¶: Required argument

STATES_INFO¶: Required argument

multiplication¶

Matrix multiplication for view matrix, transmission matrix, daylight matrix and sky matrix.

honeybee-radiance three_phase multiplication [OPTIONS] SKY_VECTOR VIEW_MATRIX
                                             T_MATRIX DAYLIGHT_MATRIX
                                             OUTPUT_MATRIX

Options

--options <options>¶: a string that will be passed to dctimestep for setting options such as output file format (-o), input data format(-i) etc.

--dry-run¶

A flag to show the command without running it.

Default:: False

Arguments

SKY_VECTOR¶: Required argument

VIEW_MATRIX¶: Required argument

T_MATRIX¶: Required argument

DAYLIGHT_MATRIX¶: Required argument

OUTPUT_MATRIX¶: Required argument

rmtxop¶

Matrix multiplication for view matrix, transmission matrix, daylight matrix and sky matrix.

honeybee-radiance three_phase rmtxop [OPTIONS] VIEW_MATRIX T_MATRIX
                                     DAYLIGHT_MATRIX SKY_VECTOR OUTPUT_MATRIX

Options

--output-format <output_format>¶

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

Default:: 'a'
Options:: a | f | d | c

--illuminance, --raw¶

A flag to convert the result to illuminance.

Default:: True

--remove-header, --keep-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

VIEW_MATRIX¶: Required argument

T_MATRIX¶: Required argument

DAYLIGHT_MATRIX¶: Required argument

SKY_VECTOR¶: Required argument

OUTPUT_MATRIX¶: Required argument