honeybee_plus.radiance.command.rcontrib module¶
RADIANCE rcontrib command.
-
class
honeybee_plus.radiance.command.rcontrib.
Rcontrib
(output_name=None, octree_file=None, points_file=None, rcontrib_parameters=None)[source]¶ Bases:
honeybee_plus.radiance.command._commandbase.RadianceCommand
rcontrib - Compute contribution coefficients in a RADIANCE scene.
Read more at: https://www.radiance-online.org/learning/documentation/manual-pages/pdfs/rcontrib.pdf
-
output_name
¶ An optional name for output file name. If None the name of .epw file will be used.
-
rcontrib_parameters
¶ Radiance parameters for rcontrib. If None Default parameters will be set. You can use self.rcontrib_parameters to view, add or remove the parameters before executing the command.
Usage:
from honeybee_plus.radiance.command.rcontrib import Rcontrib
- rcontrib = Rcontrib(output_name=”test3”,
octree_file=r”C:/ladybug/test3/gridbased/test3.oct”, points_file=r”C:/ladybug/test3/gridbased/test3.pts”)
# set up parameters rcontrib.rcontrib_parameters.mod_file = r”C:/ladybug/test3/sunlist.txt” rcontrib.rcontrib_parameters.I = True rcontrib.rcontrib_parameters.ab = 0 rcontrib.rcontrib_parameters.ad = 10000
print(rcontrib.to_rad_string()) > c:/radiance/bin/rcontrib -ab 0 -ad 10000 -M
C:/ladybug/test3/gridbased/sunlist.txt -I C:/ladybug/test3/gridbased/test3.oct < C:/ladybug/test3/gridbased/test3.pts > test3.dc
# run rcontrib rcontrib.execute()
-
property
input_files
¶ Input files for this command.
-
octree_file
= None¶ Full path to input oct file.
-
output_file
= None¶ untitled)
- Type
results file for coefficients (Default
-
points_file
= None¶ Full path to input points file.
-
property
rcontrib_parameters
¶ Radiance parameters for rcontrib. If None Default parameters will be set. You can use self.rcontrib_parameters to view, add or remove the parameters before executing the command.
-