honeybee_radiance_command.oconv module

oconv command.

class honeybee_radiance_command.oconv.Oconv(options=None, output=None, inputs=None)[source]

Bases: honeybee_radiance_command._command.Command

Oconv command.

Oconv adds each scene description input to octree and sends the result to the standard output. Each input can be either a file name, or a command (enclosed in quotes and preceded by a ‘!’). Similarly, the octree input may be given as a command preceded by a ‘!’. If any of the surfaces will not fit in octree, an error message is printed and the program aborts. If no octree is given, a new one is created large enough for all of the surfaces.

Parameters

  • options – Oconv 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]

Oconv 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

Input files.

Get and set inputs files.

property options

Oconv options.

property output

output file.

property pipe_to

Second command to pipe the outputs from this command.