honeybee_radiance_command.rcollate module

rcollate command.

class honeybee_radiance_command.rcollate.Rcollate(options=None, output=None, input=None)

Bases: Command

Rcollate command.

Rcollate reads in a single matrix file (table) and reshapes it to have the number of columns specified by the -oc option.

Parameters:

• options – Command options. It will be set to Radiance default values if not provided by user.

• output – File path to the output matrix file (Default: None).

• input – File path of the input matrix file. (Default: None).

Properties:

• options

• output

• input

after_run()

After run script.

Overwrite this method to add extra tasks that runs right after run method.

enclose_command(stdin_input=False)

Enclose command in quotes and exclamation point (‘!’). This method should be used when reading the input of a command from another Radiance command.

Example: rmtxop -c 47.4 119.9 11.6 “!rmtxop view transmission daylight sky” > output

run(env=None, cwd=None)

Run command as a subprocess.

Parameters:

• env – Environmental variables (default: None).

• cwd – Working directory (Default: ‘.’).

Returns:

Command return code.

Return type:

• int

to_radiance(stdin_input=False)

Command in Radiance format.

Parameters:

stdin_input – A boolean that indicates if the input for this command comes from stdin. This is for instance the case when you pipe the input from another command (default: False).

validate(stdin_input=False)

Overwrite this method to add extra specific checks for the command. For instance for rcontrib you want to make sure there is at least one modifier set in the command.

This method will be executed right before running the command.

property command

property input

Path to the matrix file on which the reshaping and other operations are to be performed.

property options

rcollate options.

property output

output file.

property pipe_to

Second command to pipe the outputs from this command.