viewfactor

honeybee-radiance view_factor

Commands to compute view factors to geometry.

honeybee-radiance view_factor [OPTIONS] COMMAND [ARGS]...

contrib

Run rcontrib to get spherical view factors from a sensor grid.

Args:
octree: Path to octree file.
sensor-grid: Path to sensor grid file.
modifiers: Path to modifiers file.
honeybee-radiance view_factor contrib [OPTIONS] OCTREE SENSOR_GRID MODIFIERS

Options

--ray-count <ray_count>

The number of rays to be equally distributed over a sphere to compute the view factor for each of the input sensors.

Default

6

--rad-params <rad_params>

Radiance parameters.

--rad-params-locked <rad_params_locked>

Protected Radiance parameters. These values will overwrite user input rad parameters.

--folder <folder>

Output folder into which the modifier and octree files will be written.

--name <name>

File name, which will be used for the rebuilt sensor-grid, the matrix and the resulting CSV with view factors.

Arguments

OCTREE

Required argument

SENSOR_GRID

Required argument

MODIFIERS

Required argument

modifiers

Translate a Model into an Octree and corresponding modifier list for view factors.

Args:
model_file: Full path to a Model JSON file (HBJSON) or a Model pkl (HBpkl) file.
honeybee-radiance view_factor modifiers [OPTIONS] MODEL_FILE

Options

--exclude-sky, -s, --include-sky

Flag to note whether a sky dome should be included in the resulting octree. The inclusion of the sky dome enables the sky view to be computed in the resulting calculation.

Default

True

--exclude-ground, -g, --include-ground

Flag to note whether a ground dome should be included in the resulting octree. The inclusion of the ground dome enables the ground view to be computed in the resulting calculation.

Default

True

--individual-shades, -shd, --grouped-shades

Flag to note whether the shade geometries should be included in the list of modifiers. Note that they are still included in the resulting octree but are just excluded from the list of modifiers.

Default

True

--triangulate, -t, --skip-triangulate

Flag to note whether the Apertures and Doors of the output model should be triangulated if they have more than 4 vertices. This triangulation is necessary to align a model with EnergyPlus results since E+ cannot accept sub-faces with more than 4 vertices.

--folder <folder>

Output folder into which the modifier and octree files will be written.

--name <name>

File name, which will be used for both the modifiers and the octree.

Arguments

MODEL_FILE

Required argument