main¶

honeybee-radiance-folder¶

honeybee folder commands.

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

Options

--version¶: Show the version and exit.

aperture-files¶

Return aperture files.

honeybee-radiance-folder aperture-files [OPTIONS] RADIANCE_FOLDER

Options

-m, --model <model>¶

Optional name for model folder

Default:: 'model'

--default, --black¶

Flag to note whether black material files must be returned.

Default:: True

-lf, --log-file <log_file>¶: Optional log file to export the output. By default this will be printed to stdout

Arguments

RADIANCE_FOLDER¶: Required argument

scene-files¶

Return scene files.

honeybee-radiance-folder scene-files [OPTIONS] RADIANCE_FOLDER

Options

-m, --model <model>¶

Optional name for model folder

Default:: 'model'

--default, --black¶

Flag to note whether black material files must be returned.

Default:: True

-lf, --log-file <log_file>¶: Optional log file to export the output. By default this will be printed to stdout

Arguments

RADIANCE_FOLDER¶: Required argument

grid-files¶

Return grid files.

honeybee-radiance-folder grid-files [OPTIONS] RADIANCE_FOLDER

Options

-m, --model <model>¶

Optional name for model folder

Default:: 'model'

-lf, --log-file <log_file>¶: Optional log file to export the output. By default this will be printed to stdout

Arguments

RADIANCE_FOLDER¶: Required argument

grid-info-files¶

Return grid information files.

honeybee-radiance-folder grid-info-files [OPTIONS] RADIANCE_FOLDER

Options

-m, --model <model>¶

Optional name for model folder

Default:: 'model'

-lf, --log-file <log_file>¶: Optional log file to export the output. By default this will be printed to stdout

Arguments

RADIANCE_FOLDER¶: Required argument

view-files¶

Return view files.

honeybee-radiance-folder view-files [OPTIONS] RADIANCE_FOLDER

Options

-m, --model <model>¶

Optional name for model folder

Default:: 'model'

-lf, --log-file <log_file>¶: Optional log file to export the output. By default this will be printed to stdout

Arguments

RADIANCE_FOLDER¶: Required argument

view-info-files¶

Return view information files.

honeybee-radiance-folder view-info-files [OPTIONS] RADIANCE_FOLDER

Options

-m, --model <model>¶

Optional name for model folder

Default:: 'model'

-lf, --log-file <log_file>¶: Optional log file to export the output. By default this will be printed to stdout

Arguments

RADIANCE_FOLDER¶: Required argument

aperture-groups¶

Return aperture groups.

honeybee-radiance-folder aperture-groups [OPTIONS] RADIANCE_FOLDER

Options

-m, --model <model>¶

Optional name for model folder

Default:: 'model'

--exterior, --interior¶

Flag to note whether interior or exterior aperture groups must be returned.

Default:: True

-lf, --log-file <log_file>¶: Optional log file to export the output. By default this will be printed to stdout

Arguments

RADIANCE_FOLDER¶: Required argument

add-output-spec¶

Add output spec to a receiver file.

Args:

receiver_file: Path to a receiver file. You can find these files under the: aperture_group subfolder.

output_spec: A string for receiver output spec.

honeybee-radiance-folder add-output-spec [OPTIONS] RECEIVER_FILE OUTPUT_SPEC

Options

-o, --output-file <output_file>¶: Optional path for an output file. By default this command modifies the input receiver file.

Arguments

RECEIVER_FILE¶: Required argument

OUTPUT_SPEC¶: Required argument

dynamic-scene¶

Return dynamic scene.

honeybee-radiance-folder dynamic-scene [OPTIONS] RADIANCE_FOLDER

Options

-m, --model <model>¶

Optional name for model folder

Default:: 'model'

--outdoor, --indoor¶

Flag to note whether indoor or outdoor dynamic scene must be returned.

Default:: True

-lf, --log-file <log_file>¶: Optional log file to export the output. By default this will be printed to stdout

Arguments

RADIANCE_FOLDER¶: Required argument

filter-folder¶

Filter files in a folder.

Args:

folder: path to folder.

pattern: a regex pattern to filter files based on. The pattern must be a raw

string with no quotes. The command compiles the string to a regex pattern.

honeybee-radiance-folder filter-folder [OPTIONS] FOLDER PATTERN

Options

-lf, --log-file <log_file>¶: Optional log file to export the output. By default this will be printed to stdout

Arguments

FOLDER¶: Required argument

PATTERN¶: Required argument

filter-file¶

Filter a list fo JSON objects based on value for a specific key.

Args:

input-file: Path to input JSON file. Input JSON file should be an array of

JSON objects.

pattern: Two string values separated by a :. For example group:daylight

will keep/remove the objects when the value for group key is set to daylight.

honeybee-radiance-folder filter-file [OPTIONS] INPUT_FILE [PATTERN]

Options

-of, --output-file <output_file>¶

--keep, --remove¶

A flag to switch between keeping the objects or removing them from the input list.

Default:: True

Arguments

INPUT_FILE¶: Required argument

PATTERN¶: Optional argument