honeybee_radiance_command.rcontrib module

rcontrib command.

class honeybee_radiance_command.rcontrib.Rcontrib(options=None, output=None, octree=None, sensors=None)[source]

Bases: Rtrace

rcontrib command.

Rcontrib computes ray coefficients for objects whose modifiers are named in one or more -m settings. These modifiers are usually materials associated with light sources or sky domes, and must directly modify some geometric primitives to be considered in the output. A modifier list may also be read from a file using the -M option. The RAYPATH environment variable determines directories to search for this file. (No search takes place if a file name begins with a ‘.’, ‘/’ or ‘~’ character.).

Parameters:

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

  • output – Output file (Default: None).

  • octree – Octree file (Default: None).

  • sensors – Sensors file (Default: None).

Properties:

  • options

  • output

  • octree

  • sensors

Note: https://www.radiance-online.org/learning/documentation/manual-pages/pdfs/rcontrib.pdf

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 octree

Octree file.

property options

Rcontrib options.

property output

output file.

property pipe_to

Second command to pipe the outputs from this command.

property sensors

Sensor file.