honeybee_plus.radiance.command.oconv module

oconv-create an octree from a RADIANCE scene description.

class honeybee_plus.radiance.command.oconv.Oconv(output_name='untitled', scene_files=[], oconv_parameters=None)

Bases: honeybee_plus.radiance.command._commandbase.RadianceCommand

Create a Radiance octree.

Read more at: http://radsite.lbl.gov/radiance/man_html/oconv.1.html

output_name

Output oct file which is usually the same as the project name (Default: untitled)

scene_files

A list of radiance files (e.g. sky files, material files, geometry files) in the order that they should show up in oconv command. Make sure to put files with modifiers (e.g materials, sources) before the files that are using them (e.g geometry files).

oconv_parameters

Radiance parameters for oconv. If None Default parameters will be set. You can use self.oconv_parameters to view, add or remove the parameters before executing the command.

Usage:

from honeybee_plus.radiance.parameters.oconv import OconvParameters from honeybee_plus.radiance.command.oconv import Oconv

# generate oconv parameters rcp = OconvParameters()

# trun off turn off warnings rcp.turn_off_warns = True

# create an oconv command oconv = Oconv(output_name=”C:/ladybug/test3/gridbased/test3.oct”,

scene_files=((r”C:/ladybug/test3/gridbased/test3.mat”,

r”c:/ladybug/test3/gridbased/test3.rad”)),

oconv_parameters=rcp )

# print command line to check print(oconv.to_rad_string()) > c:/radiance/bin/oconv -f C:/ladybug/test3/gridbased/test3.mat

c:/ladybug/test3/gridbased/test3.rad > test3.oct

# execute the command output_file_path = oconv.execute()

print(output_filePath) > C:/ladybug/test3/gridbased/test3.oct

add_file_to_scene(file_path)

Add a new file to the scene.

property input_files

Return input files by user.

property oconv_parameters

Radiance parameters for oconv. If None Default parameters will be set. You can use self.oconv_parameters to view, add or remove the parameters before executing the command.

output_file = None

untitled)

Type

results file for coefficients (Default

property scene_files

[])

Type

Sorted list of full path to input rad files (Default

to_rad_string(relative_path=False)

Return full command as a string.