octree

honeybee-radiance octree

Commands to generate Radiance octree.

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

from-abstracted-groups

Generate a set of octrees from a folder containing abstracted aperture groups.

This command assumes that each aperture group in the radiance folder contains only two states. The first is a 100 percent transmittance specular (or beam) representation of the aperture group and the second is a 100 percent transmittance diffuse representation of the aperture group. This abstracted representation is intended to simulate contributions of dynamic groups when an external source is able to provide specular and diffuse transmittances at each timestep. For example, EnergyPlus can provide such values, which together can account for several types of complex dynamic fenestration types.

Each aperture group will get at least two octrees (one with specular and one with diffuse). If a sun-path is provided, a third octree will be added with the suns included.

Args:
folder: Path to a Radiance model folder.
honeybee-radiance octree from-abstracted-groups [OPTIONS] FOLDER

Options

-sp, --sun-path <sun_path>

Path for a sun-path file that will be added to octrees for direct sunlight studies. If sunpath is provided an extra octree for direct_sun will be created.

--output-folder <output_folder>

Output folder relative to the model folder into which the files be written.

Default

octree

Arguments

FOLDER

Required argument

from-folder

Generate a static octree from a folder.

Args:
folder: Path to a Radiance model folder.
honeybee-radiance octree from-folder [OPTIONS] FOLDER

Options

-o, --output <output>

Path to output file (.oct). If a relative path is provided it should be relative to project folder.

--default, -b, --black

Flag to note whether the octree should be created completely with black materials.

Default

True

--include-aperture, -xa, --exclude-aperture

Flag to note whether static apertures should be included in the octree.

Default

True

--black-groups, -xg, --exclude-groups

Flag to note whether dynamic aperture groups should blacked-out in the octree or they should simply be excluded, letting light pass through.

Default

True

--first-shade-state, -xs, --exclude-shade-groups

Flag to note whether dynamic shade groups should be included in the octree as the first shade state or they should simply be excluded.

Default

True

--include-ies, -xi, --exclude-ies

Flag to note whether IES files should be included in the octree.

Default

True

--add-before <add_before>

Path for a file to be added to octree before scene files.

--add-after <add_after>

Path for a file to be added to octree after scene files.

--dry-run

A flag to show the command without running it.

Default

False

Arguments

FOLDER

Required argument

from-folder-multiphase

Generate a set of octrees from a folder.

This command will generate octrees for both default and direct studies. It will do so for static apertures and aperture groups, creating one octree for each light path, i.e., all other light paths are blacked.

Args:
folder: Path to a Radiance model folder.
honeybee-radiance octree from-folder-multiphase [OPTIONS] FOLDER

Options

--sun-path <sun_path>

Path for a sun-path file that will be added to octrees for direct sunlight studies. If sunpath is provided an extra octree for direct_sun will be created.

--phase <phase>

Select a multiphase study for which octrees will be created. 3-phase includes 2-phase, and 5-phase includes 3-phase and 2-phase.

Default

5

Options

2 | 3 | 5

--output-folder <output_folder>

Output folder into which the files be written.

Default

octree

Arguments

FOLDER

Required argument

from-shade-trans-groups

Generate a set of octrees from a folder containing shade transmittance groups.

This command assumes that each shade group in the radiance folder contains only two states. The first is a completely opaque representation of the shade group and the second is a completely transparent representation of the shade group. This abstracted representation is intended to simulate dynamic shade transmittance that changes at each timestep.

Each shade group will get an octree. If a sun-path is provided, an additional octree will be added for each group.

Args:
folder: Path to a Radiance model folder.
honeybee-radiance octree from-shade-trans-groups [OPTIONS] FOLDER

Options

-sp, --sun-path <sun_path>

Path for a sun-path file that will be added to octrees for direct sunlight studies. If sunpath is provided an extra octree for direct_sun will be created.

--output-folder <output_folder>

Output folder relative to the model folder into which the files be written.

Default

octree

Arguments

FOLDER

Required argument