honeybee_radiance_command.rcalc module

rcalc command.

class honeybee_radiance_command.rcalc.Rcalc(options=None, output=None, inputs=None)[source]

Bases: Command

rcalc command.

Rcalc transforms “records” from each file according to the given set of literal and relational information. By default, records are separated by newlines, and contain numeric fields separated by tabs. The -tS option is used to specify an alternate tab character.

Parameters:

  • options – Rcalc command options. It will be set to Radiance default values if unspecified.

  • output – Output file (Default: None).

  • inputs – A collection of scene files (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)[source]

Rcalc 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()[source]

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 inputs

Octree file.

Get and set inputs files.

property options

Rcalc options.

property output

output file.

property pipe_to

Second command to pipe the outputs from this command.