honeybee.radiance.command package

Subpackages

• honeybee.radiance.command.pyRad package
  • Subpackages
    • honeybee.radiance.command.pyRad.pyRadLib package
      • Submodules
      • honeybee.radiance.command.pyRad.pyRadLib.pyrad_proc module
      • Module contents
  • Submodules
  • honeybee.radiance.command.pyRad.objview module
  • Module contents

Submodules

honeybee.radiance.command.dctimestep module

dctimestep - transform a RADIANCE scene description

class honeybee.radiance.command.dctimestep.Dctimestep(tmatrix_file=None, dmatrix_file=None, sky_vector_file=None, vmatrix_spec=None, dctimestep_parameters=None, output_filename_format=None, output_name=None, daylight_coeff_spec=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

daylight_coeff_spec = None

dctimestep_parameters

Get and set gendaymtx_parameters.

dmatrix_file = None

input_files

output_file = None

output_filename_format

-o option in dctimestep.

The -o option may be used to specify a file or a set of output files to use rather than the standard output. If the given specification contains a ‘%d’ format string, this will be replaced by the time step index, starting from 1. In this way, multiple output pictures may be produced, or separate result vectors (one per timestep).

sky_vector_file = None

tmatrix_file = None

to_rad_string(relative_path=False)

Return radiance command line.

vmatrix_spec = None

honeybee.radiance.command.epw2wea module

class honeybee.radiance.command.epw2wea.Epw2wea(epw_file=None, output_wea_file=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

epw2wea transforms an EnergyPlus weather data (.epw) file into the DAYSIM weather file format, for use with the RADIANCE gendaymtx program.

epw_file

Filepath of the epw file that is to be converted into wea format.

Usage: from honeybee.radiance.command.epw2wea import Epw2wea.

#create an epw2wea command. epwWea = Epw2wea(epw_fileName=’c:/ladybug/test.epw’)

epw_file

The path of the epw file that is to be converted to a wea file.

input_files

Return input files specified by user.

output_wea_file = None

The path of the output wea file. Note that this path will be created if not specified by the user.

to_rad_string(relative_path=False)

Return full radiance command as string

honeybee.radiance.command.falsecolor module

falsecolor - make a falsecolor Radiance picture

class honeybee.radiance.command.falsecolor.Falsecolor(input_image_file=None, output_file=None, falsecolor_parameters=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

falsecolor - make a falsecolor Radiance picture

execute()

falsecolor_parameters

Paramters for the falsecolor command.

input_files

input_image_file = None

The file path for which the falsecolor image is to be created.

output_file = None

The name of the output file.

to_rad_string(relative_path=False)

“Return full command as string

honeybee.radiance.command.genBSDF module

class honeybee.radiance.command.genBSDF.GenBSDF(input_geometry=None, gen_bsdf_parameters=None, grid_based_parameters=None, output_file=None, normal_orientation=None, prepare_geometry=True)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

execute()

gen_bsdf_parameters

These are parameters specific to genBsdf such as sampling, geometry dimensions etc.

grid_based_parameters

The input for this attribute must be an instance of Grid based parameters

input_files

input_geometry

Rad or mgf files that are inputs for genBSDF

normal_orientation = None

Direction of the normal surface for the overall input geometry

output_file = None

Path name for the XML file created by genBSDF

prepare_geometry = None

A boolean value to decide if the input geometry needs to be translated and rotated before being sent as input to genBSDf

prepare_geometry_for_bsdf()

A method that will translate and rotate the model properly for genBSDF.

to_rad_string(relative_path=False)

honeybee.radiance.command.gendaylit module

class honeybee.radiance.command.gendaylit.Gendaylit(output_name, month_day_hour, rotation=0, gendaylit_parameters=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

gendaylit - Generate an annual Perez sky matrix from a weather tape.

The attributes for this class and their data descriptors are given below. Please note that the first two inputs for each descriptor are for internal naming purposes only.

output_name

An optional name for output file name (Default: ‘untitled’).

month_day_hour

A tuple containing inputs for month, day and hour.

gendaylit_parameters

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

Usage:

from honeybee.radiance.parameters.gendaylit import GendaylitParameters from honeybee.radiance.command.gendaylit import Gendaylit

# create and modify gendaylit parameters. gndayParam = GendaylitParameters() gndayParam.dir_norm_dif_horz_irrad = (600,100)

# create the gendaylit Command. gnday = Gendaylit(month_day_hour=(1,1,11), gendaylit_parameters=gndayParam, output_name = r’d:/sunnyWSun_010111.sky’ )

# run gendaylit gnday.execute()

>

classmethod from_location_direct_and_diffuse_radiation(output_name, location, month_day_hour, direct_radiation, diffuse_radiation, rotation=0)

gendaylit_parameters

Get and set gendaylit_parameters.

input_files

Input files for this command.

month_day_hour = None

output_file = None

results file for sky (Default – untitled)

to_rad_string(relative_path=False)

Return full command as a string.

honeybee.radiance.command.gendaymtx module

class honeybee.radiance.command.gendaymtx.Gendaymtx(output_name=None, wea_file=None, gendaymtx_parameters=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

gendaymtx - Generate an annual Perez sky matrix from a weather tape.

output_name

An optional name for output file name. If None the name of .epw file will be used.

wea_file

Full path to input wea file (Default: None).

gendaymtx_parameters

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

Usage:

from honeybee.radiance.parameters.gendaymtx import GendaymtxParameters from honeybee.radiance.command.gendaymtx import Gendaymtx

# create and modify gendaymtx_parameters # generate sky matrix with default values gmtx = GendaymtxParameters()

# ask only for direct sun gmtx.only_direct = True

# create gendaymtx dmtx = Gendaymtx(wea_file=”C:/IZMIR_TUR.wea”, gendaymtx_parameters=gmtx)

# run gendaymtx dmtx.execute() > c:/radiance/bin/gendaymtx: reading weather tape ‘C:/ladybug/IZMIR_TUR.wea’ > c:/radiance/bin/gendaymtx: location ‘IZMIR_TUR’ > c:/radiance/bin/gendaymtx: (lat,long)=(38.5,-27.0) degrees north, west > c:/radiance/bin/gendaymtx: 146 sky patches per time step > c:/radiance/bin/gendaymtx: stepping through month 1… > c:/radiance/bin/gendaymtx: stepping through month 2… > c:/radiance/bin/gendaymtx: stepping through month 3… > c:/radiance/bin/gendaymtx: stepping through month 4… > c:/radiance/bin/gendaymtx: stepping through month 5… > c:/radiance/bin/gendaymtx: stepping through month 6… > c:/radiance/bin/gendaymtx: stepping through month 7… > c:/radiance/bin/gendaymtx: stepping through month 8… > c:/radiance/bin/gendaymtx: stepping through month 9… > c:/radiance/bin/gendaymtx: stepping through month 10… > c:/radiance/bin/gendaymtx: stepping through month 11… > c:/radiance/bin/gendaymtx: stepping through month 12… > c:/radiance/bin/gendaymtx: writing matrix with 8760 time steps… > c:/radiance/bin/gendaymtx: done.

# change it not to be verbose dmtx.gendaymtx_parameters.verbose_report = False

# run it again dmtx.execute() >

gendaymtx_parameters

Get and set gendaymtx_parameters.

input_files

Input files for this command.

output_file

Output file address.

to_rad_string(relative_path=False)

Return full command as a string.

honeybee.radiance.command.gensky module

class honeybee.radiance.command.gensky.Gensky(output_name='untitled', month_day_hour=None, rotation=0, gensky_parameters=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

gensky - Generate an annual Perez sky matrix from a weather tape.

The attributes for this class and their data descriptors are given below. Please note that the first two inputs for each descriptor are for internal naming purposes only.

output_name

An optional name for output file name (Default: ‘untitled’).

month_day_hour

A tuple containing inputs for month, day and hour.

gensky_parameters

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

Usage:

from honeybee.radiance.parameters.gensky import GenSkyParameters from honeybee.radiance.command.gensky import GenSky

# create and modify gensky_parameters. In this case a sunny with no sun # will be generated. gnsky_param = GenSkyParameters() gnskyParam.sunny_skyNoSun = True

# create the gensky Command. gnsky = GenSky(month_day_hour=(1,1,11), gensky_parameters=gnskyParam, output_name = r’d:/sunnyWSun_010111.sky’ )

# run gensky gnsky.execute()

>

classmethod from_sky_type(output_name='untitled', month_day_hour=(9, 21, 12), sky_type=0, latitude=None, longitude=None, meridian=None, rotation=0)

Create a sky by sky type.

Parameters:

• output_name – An optional name for output file name (Default: ‘untitled’).
• month_day_hour – A tuple containing inputs for month, day and hour.
• sky_type – An intger between 0-5 for CIE sky type. 0: [+s] Sunny with sun, 1: [-s] Sunny without sun, 2: [+i] Intermediate with sun, 3: [-i] Intermediate with no sun, 4: [-c] Cloudy overcast sky, 5: [-u] Uniform cloudy sky
• latitude – [-a] A float number to indicate site altitude. Negative angle indicates south latitude.
• longitude – [-o] A float number to indicate site latitude. Negative angle indicates east longitude.
• meridian – [-m] A float number to indicate site meridian west of Greenwich.

gensky_parameters

Get and set gensky_parameters.

input_files

Input files for this command.

month_day_hour = None

output_file = None

results file for sky (Default – untitled)

to_rad_string()

Return full command as a string.

classmethod uniform_skyfrom_illuminance_value(output_name='untitled', illuminance_value=10000, sky_type=4)

Uniform CIE sky based on illuminance value.

output_name

An optional name for output file name (Default: ‘untitled’).

illuminance_value

Desired illuminance value in lux

honeybee.radiance.command.genskyvec module

class honeybee.radiance.command.genskyvec.Genskyvec(header_suppress=None, sky_subdivision=None, sky_color_rgb=None, sun_only_vector=None, input_sky_file=None, output_file=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

header_suppress = None

input_files

input_sky_file = None

output_file = None

sky_color_rgb = None

sky_subdivision = None

sun_only_vector = None

to_rad_string(relative_path=False)

honeybee.radiance.command.getbbox module

getbbox - compute bounding box for Radiance rad.

class honeybee.radiance.command.getbbox.Getbbox(warnings_suppress=None, header_suppress=None, rad_files=None, output_file=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

header_suppress = None

input_files

Return input files by user.

output_file = None

rad_files

Get and set rad files.

to_rad_string(relative_path=False)

warnings_suppress = None

honeybee.radiance.command.getinfo module

getinfo - get header information from a RADIANCE file

class honeybee.radiance.command.getinfo.Getinfo(get_dimensions=None, header_suppress=None, rad_files=None, output_file=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

get_dimensions = None

input_file

Get and set rad files.

input_files

Return input files by user.

output_file = None

to_rad_string(relative_path=False)

honeybee.radiance.command.mkpmap module

class honeybee.radiance.command.mkpmap.Mkpmap(oct_file=None, mkpmap_parameters=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

mkpmap - generate RADIANCE photon map

oct_file

Full path to input octree file (Default: None).

mkpmap_parameters

Radiance parameters for mkpmap. If None Default parameters will be set.

input_files

Input files for this command.

mkpmap_parameters

Get and set mkpmap_parameters.

to_rad_string(relative_path=False)

Return full command as a string.

honeybee.radiance.command.objview module

class honeybee.radiance.command.objview.Objview(use_open_gl=None, hemisphere_up=None, back_face_visibility=None, view_details=None, num_processors=None, output_device=None, verbose_display=None, disable_warnings=None, gl_rad_full_screen=None, view_file=None, scene_exposure=None, no_lights=None, run_silently=None, print_views=None, scene_files=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

back_face_visibility = None

disable_warnings = None

gl_rad_full_screen = None

hemisphere_up = None

input_files

Return input files by user.

no_lights = None

num_processors = None

output_device = None

print_views = None

run_silently = None

scene_exposure = None

scene_files

Get and set scene files.

to_rad_string(relative_path=False)

use_open_gl = None

verbose_display = None

view_details = None

view_file = None

honeybee.radiance.command.oconv module

oconv-create an octree from a RADIANCE scene description.

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

Bases: honeybee.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.radiance.parameters.oconv import OconvParameters from honeybee.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.

input_files

Return input files by user.

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

results file for coefficients (Default – untitled)

scene_files

Sorted list of full path to input rad files (Default – [])

to_rad_string(relative_path=False)

Return full command as a string.

honeybee.radiance.command.pcomb module

pcomb - combine Radiance pictures

class honeybee.radiance.command.pcomb.Pcomb(image_list=None, output_file=None, pcomb_parameters=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

image_list

input_files

output_file = None

pcomb_parameters

Get and set gendaymtx_parameters.

to_rad_string(relative_path=False)

Return full command as a string

class honeybee.radiance.command.pcomb.PcombImage(original_pixel_use=None, scaling_factor=None, rgb_color_multiplier=None, input_image_file=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

execute()

input_files

input_image_file = None

original_pixel_use = None

radbin_path

Get and set path to radiance binaries. If you set a new value the value will be changed globally.

rgb_color_multiplier = None

scaling_factor = None

to_rad_string(relative_path=False)

honeybee.radiance.command.raBmp module

ra_bmp

class honeybee.radiance.command.raBmp.RaBmp(input_hdr_file=None, output_bmp_file=None, ra_bmp_parameters=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

input_files

input_hdr_file = None

Path for input HDR file

output_bmp_file = None

Path for output tiff file

ra_bmp_parameters

An instance of RaBmp parameters

to_rad_string(relative_path=False)

honeybee.radiance.command.raTiff module

ra_bmp

class honeybee.radiance.command.raTiff.RaTiff(input_hdr_file=None, output_tiff_file=None, ra_tiff_parameters=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

input_files

input_hdr_file = None

Path for input HDR file

output_tiff_file = None

Path for output tiff file

ra_tiff_parameters

An instance of RaTiff parameters

to_rad_string(relative_path=False)

honeybee.radiance.command.rcalc module

rcalc - transform a RADIANCE scene description

class honeybee.radiance.command.rcalc.Rcalc(output_file=None, rad_file=None, rcalc_parameters=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

input_files

Return input files by the user.

output_file

rad_file

Get and set rad files.

rcalc_parameters

Get and set gendaymtx_parameters.

to_rad_string(relative_path=False)

Return full command as a string.

honeybee.radiance.command.rcollate module

class honeybee.radiance.command.rcollate.Rcollate(executable_name=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

rcollate - resize or transpose matrix data

Attributes:

input_files

Input files for this command.

matrix_file = None

to_rad_string(relative_path=False)

honeybee.radiance.command.rcontrib module

RADIANCE rcontrib command.

class honeybee.radiance.command.rcontrib.Rcontrib(output_name=None, octree_file=None, points_file=None, rcontrib_parameters=None)

Bases: honeybee.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.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()

input_files

Input files for this command.

octree_file = None

Full path to input oct file.

output_file = None

results file for coefficients (Default – untitled)

points_file = None

Full path to input points file.

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.

to_rad_string(relative_path=False)

Return full command as a string.

honeybee.radiance.command.rfluxmtx module

class honeybee.radiance.command.rfluxmtx.Rfluxmtx(sender=None, receiver_file=None, octree_file=None, rad_files=None, points_file=None, output_matrix=None, view_rays_file=None, view_info_file=None, output_filename_format=None, num_processors=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

Radiance Rfluxmtx matrix.

static add_control_parameters(input_string, modifier_dict)

static check_for_rflux_parameters(file_val)

static control_parameters(hemi_type='u', hemi_up_direction='Y', output_file='')

Rfluxmtx ControlParameters.

static default_sky_ground(file_name, sky_type=None, sky_file_format=None, ground_file_format=None)

Parameters:

• file_name – This should be the name of the file to which the sky defintion should be written to.
• sky_type –

  The acceptable inputs for hemisphere type are: u for uniform.(Usually applicable for ground).

  kf for klems full.

  kh for klems half.

  kq for klems quarter.

  rN for Reinhart - Tregenza type skies. N stands for

  subdivisions and defaults to 1.

  scN for shirley-chiu subdivisions.

Returns:

Passes back the same file_name that was provided as input.

Return type:

file_name

ground_string = '\n void glow ground_glow\n 0\n 0\n 4 1 1 1 0\n\n ground_glow source ground\n 0\n 0\n 4 0 0 -1 180\n '

input_files

num_processors = None

Number of processors

number_of_points = None

Number of test points. Initially set to 0.

octree_file = None

Octree file containing the other rad file in the scene.

output_data_format = None

output_filename_format

Filename format

output_matrix = None

The flux matrix file that will be created by rfluxmtx.

points_file

The points file or input vwrays for which the illuminance/luminance value are to be calculated.

rad_files

Rad files other than the sender and receiver that are a part of the scene.

receiver_file = None

Receiver file will usually be the sky file containing rfluxmtx variables

rfluxmtx_parameters

sender = None

Sender file will be either a rad file containing rfluxmtx variables or just a -

sky_string = '\n void glow sky_glow\n 0\n 0\n 4 1 1 1 0\n\n sky_glow source sky\n 0\n 0\n 4 0 0 1 180\n '

to_rad_string(relative_path=False)

verbose = None

view_info_file

File containing view dimensions calculated from vwrays.

view_rays_file = None

File containing ray samples generated from vwrays

class honeybee.radiance.command.rfluxmtx.RfluxmtxControlParameters(hemi_type='u', hemi_up_direction='Y', output_file='')

Bases: object

Rfluxmtx ControlParameters.

Set the values for hemispheretype, hemisphere up direction and output file location (optional).

hemisphere_type

The acceptable inputs for hemisphere type are – u for uniform.(Usually applicable for ground). kf for klems full. kh for klems half. kq for klems quarter. rN for Reinhart - Tregenza type skies. N stands for subdivisions

and defaults to 1.

scN for shirley-chiu subdivisions.

hemisphere_up_direction

honeybee.radiance.command.rmtxop module

class honeybee.radiance.command.rmtxop.Rmtxop(matrix_files=None, rmtxop_matrices=None, output_file=None, rmtxop_parameters=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

rmtxop - concatenate, add, transpose, scale, and convert matrices

rmtxop [ -v ][ -f[afdc] ][ -t ][ -s sf .. ][ -c ce .. ] m1 [ + ] ..

#Simple usage (for just adding stuff): mtx = Rmtxop() mtx.matrix_files = [matrix_filePath1, matrix_filePath2] mtx.output_file = output_matrixFilePath #Then to_rad_string will be:

‘rmtxop matrix_filesPath1 + matrix_filePath2 > output_matrixFilePath’

#Advanced usage with transformations and such. In this case I am subtracting one # matrix and adding another. final_matrix = Rmtxop()

#std. dc matrix. dc_matrix = RmtxopMatrix() dc_matrix.matrix_file = x.ill

#direct dc matrix. -1 indicates that this one is being subtracted from dc matrix. dc_direct_matrix = RmtxopMatrix() dc_direct_matrix.matrix_file = y.ill dc_direct_matrix.scalar_factors = [-1]

#Sun coefficient matrix. sun_coeff_matrix = RmtxopMatrix() sun_coeff_matrix.matrix_file = z.ill

#combine the matrices together. Sequence is extremely important final_matrix.rmtxop_matrices = [dc_matrix,dc_direct_matrix,sun_coeff_matrix] final_matrix.output_file = res.ill

#Then the to_rad_string will be:

c:/radiance/bin/rmtxop x.ill + -s -1 y.ill + z.ill > res.ill

input_files

Input files.

For this command are actually None as the files are specified as inputs using the matrices input

matrix_files

Get and set scene files.

output_file = None

rmtxop_matrices

rmtxop_parameters

Get and set rmtxop_parameters.

to_rad_string(relative_path=False)

Return full command as string.

class honeybee.radiance.command.rmtxop.RmtxopMatrix(transpose=None, scalar_factors=None, transform_coefficients=None, matrix_file=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

execute()

input_files

matrix_file = None

radbin_path

Get and set path to radiance binaries. If you set a new value the value will be changed globally.

scalar_factors = None

Scalar values for resizing the elements of the matrix. If a single value is specified then it will be applied across the board.

to_rad_string(relative_path=False)

transform_coefficients = None

transpose = None

Set this to true to transpose the matrix

honeybee.radiance.command.rpict module

RADIANCE rcontrib command.

class honeybee.radiance.command.rpict.Rpict(output_name='untitled', octree_file=None, view=None, view_file=None, simulation_type=2, rpict_parameters=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

Rpict command.

execute()

Execute the command.

input_files

List of input files that should be checked before running the analysis.

octree_file = None

output_file = None

rpict_parameters

Get and set image parameters for rendering.

simulation_type

Get/set simulation Type.

0: Illuminance(lux), 1: Radiation (kWh), 2: Luminance (Candela) (Default: 0)

to_rad_string(relative_path=False)

Return full command as string.

view

Get and set view for rpict.

view_file = None

honeybee.radiance.command.rtrace module

class honeybee.radiance.command.rtrace.Rtrace(output_name='untitled', octree_file=None, points_file=None, simulation_type=0, radiance_parameters=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

Create a grid-based Radiance ray-tracer.

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

output_name

Name of output file (Default: untitled).

octree_file

Full path to input oct files (Default: None)

points_file

Full path to input pt files (Default: None)

simulation_type

An integer to define type of analysis. 0: Illuminance (lux), 1: Radiation (kWh), 2: Luminance (Candela) (Default: 0)

radiance_parameters

Radiance parameters for this analysis. (Default: girdbased.LowQuality)

input_files

Input files for this command.

octree_file = None

Full path to input oct file.

output_file = None

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

points_file = None

Full path to input points file.

radiance_parameters

Radiance parameters for this analysis (Default: RadianceParameters.LowQuality).

simulation_type

**Simulation type* – 0* – Illuminance(lux), 1: Radiation (kWh), 2: Luminance (Candela) (Default: 0)

to_rad_string(relative_path=False)

Return full command as a string.

honeybee.radiance.command.vwrays module

class honeybee.radiance.command.vwrays.Vwrays(view_file=None, vwrays_parameters=None, output_file=None, output_data_format=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

Vwrays compute rays for a given picture or a view.

input_files

Input files.

isVwraysParameters

return True for type check.

output_data_format = None

output_file

Output file.

to_rad_string(relative_path=False)

Return full command as a string.

view_file = None

vwrays_parameters

Get and set gendaymtx_parameters.

honeybee.radiance.command.xform module

xform - transform a RADIANCE scene description

class honeybee.radiance.command.xform.Xform(rad_file=None, xform_parameters=None, output_file=None, transforms=None)

Bases: honeybee.radiance.command._commandbase.RadianceCommand

input_files

Return input files by the user.

output_file

rad_file

Get and set rad files.

to_rad_string(relative_path=False)

Return full command as a string

transforms

xform_parameters

Get and set gendaymtx_parameters.

Module contents

Radiance commands.