modifier¶

honeybee-radiance modifier¶

Commands for generating and modifying Radiance modifiers.

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

split-modifiers¶

Split a list of modifiers into multiple files.

This command splits the modifiers based on the sensor count and the max value. The max value is divided by the sensor count to calculate the maximum number of modifiers in each distributed file of modifiers.

This command creates a new folder with evenly distributed modifiers. The folder will include a _dist_info.json file which has the information to recreate the original input files from this folder and the results generated based on the modifiers in this folder.

_redist_info.json file includes an array of JSON objects. Each object has the distribution information, which in comparison to the command to split grids is much simpler.

Args:

modifier_file: Full path to a file with Radiance modifiers. The modifiers

must be the identifiers of the modifiers and not the actual Radiance

description of the modifiers.

output_folder: A new folder to write the newly created files.

honeybee-radiance modifier split-modifiers [OPTIONS] MODIFIER_FILE
                                           OUTPUT_FOLDER

Options

-sc, --sensor-count <sensor_count>¶

The number of sensors in the sensor grid that will be used in rcontrib with the distributed modifiers.

Default: 5000

-gf, --grid-file <grid_file>¶: Full path to a sensor grid file. This file is used to count the number of sensors and will override the –sensor-count option.

-max, --max-value <max_value>¶

An optional integer to define the maximum value allowed when multiplying the number of sensors with the number of modifiers in the distributed modifiers. Default: 40000000.

Default: 40000000

-d, --sensor-multiplier <sensor_multiplier>¶: An optional integer to be multiplied by the grid count to yield a final number of the sensor count. This is useful in workflows where the sensor grids are modified such as when calculating view factor. Default: 1.

Arguments

MODIFIER_FILE¶: Required argument

OUTPUT_FOLDER¶: Required argument