postprocess

honeybee-radiance post-process

Commands to post-process Radiance results.

honeybee-radiance post-process [OPTIONS] COMMAND [ARGS]...

annual-daylight

Compute annual metrics in a folder and write them in a subfolder.

This command generates 5 files for each input grid.
da/{grid-name}.da -> Daylight Autonomy
cda/{grid-name}.cda -> Continuos Daylight Autonomy
udi/{grid-name}.udi -> Useful Daylight Illuminance
udi_lower/{grid-name}_upper.udi -> Upper Useful Daylight Illuminance
udi_upper/{grid-name}_lower.udi -> Lower Useful Daylight Illuminance
Args:
folder: Results folder. This folder is an output folder of annual
daylight recipe. Folder should include grids_info.json and sun-up-hours.txt.
The command uses the list in grids_info.json to find the result files for each
sensor grid.
honeybee-radiance post-process annual-daylight [OPTIONS] FOLDER

Options

-sch, --schedule <schedule>

Path to an annual schedule file. Values should be 0-1 separated by new line. If not provided an 8-5 annual schedule will be created.

-t, --threshold <threshold>

Threshold illuminance level for daylight autonomy.

Default

300

-lt, --lower-threshold <lower_threshold>

Minimum threshold for useful daylight illuminance.

Default

100

-ut, --upper-threshold <upper_threshold>

Maximum threshold for useful daylight illuminance.

Default

3000

-gf, --grids-filter <grids_filter>

A pattern to filter the grids.

Default
-sf, --sub_folder <sub_folder>

Optional relative path for subfolder to write output metric files.

Arguments

FOLDER

Required argument

annual-daylight-en17037

Compute annual EN 17037 metrics in a folder and write them in a subfolder.

This command generates multiple files for each input grid. Files for target
illuminance and minimum illuminance will be calculated for three levels of
recommendation: minimum, medium, high.
Args:
folder: Results folder. This folder is an output folder of annual
daylight recipe. Folder should include grids_info.json and sun-up-hours.txt.
The command uses the list in grids_info.json to find the result files for
each sensor grid.
schedule: Path to an annual schedule file. Values should be 0-1 separated by new
line. This should be a daylight hours schedule.
honeybee-radiance post-process annual-daylight-en17037 [OPTIONS] FOLDER
                                                       SCHEDULE

Options

-gf, --grids-filter <grids_filter>

A pattern to filter the grids.

Default
-sf, --sub_folder <sub_folder>

Optional relative path for subfolder to write output metric files.

Arguments

FOLDER

Required argument

SCHEDULE

Required argument

annual-glare

Compute annual glare autonomy in a folder and write them in a subfolder.

This command generates 1 file for each input grid.
ga/{grid-name}.ga -> Glare Autonomy
Args:
folder: Results folder. This folder is an output folder of imageless annual
glare recipe. Folder should include grids_info.json and sun-up-hours.txt.
The command uses the list in grids_info.json to find the result files for each
sensor grid.
honeybee-radiance post-process annual-glare [OPTIONS] FOLDER

Options

-sch, --schedule <schedule>

Path to an annual schedule file. Values should be 0-1 separated by new line. If not provided an 8-5 annual schedule will be created.

-gt, --glare-threshold <glare_threshold>

A fractional number for the threshold of DGP above which conditions are considered to induce glare.

Default

0.4

-gf, --grids-filter <grids_filter>

A pattern to filter the grids.

Default
-sf, --sub_folder <sub_folder>

Optional relative path for subfolder to write output metric files.

Arguments

FOLDER

Required argument

annual-irradiance

Compute irradiance metrics in a folder and write them in a subfolder.

This command generates 3 files for each input grid.
average_irradiance/{grid-name}.res -> Average Irradiance (W/m2)
peak_irradiance/{grid-name}.res -> Peak Irradiance (W/m2)
cumulative_radiation/{grid-name}.res -> Cumulative Radiation (kWh/m2)
Args:
folder: Results folder from an annual irradiance recipe.
wea: The .wea file that was used in the annual irradiance simulation. This
will be used to determine the duration of the analysis for computing
cumulative radiation.
honeybee-radiance post-process annual-irradiance [OPTIONS] FOLDER WEA

Options

--timestep <timestep>

The timestep of the Wea file, which is used to ensure the summed row of irradiance yields cumulative radiation over the time period of the Wea.

-sf, --sub-folder <sub_folder>

Optional relative path for subfolder to write output metric files.

Arguments

FOLDER

Required argument

WEA

Required argument

average-row

Postprocess a Radiance matrix and average the numbers in each row.

This command is useful for translating Radiance results to outputs like radiation
to average radiation. Input matrix must be in ASCII format. The header in the input
file will be ignored.
honeybee-radiance post-process average-row [OPTIONS] INPUT_MATRIX

Options

-o, --output <output>

Optional path to output file to output the name of the newly created matrix. By default the list will be printed out to stdout

Arguments

INPUT_MATRIX

Required argument

convert-to-binary

Postprocess a Radiance matrix and convert it to 0-1 values.

This command is useful for translating Radiance results to outputs like sunlight
hours. Input matrix must be in ASCII format. The header in the input file will be
ignored.
honeybee-radiance post-process convert-to-binary [OPTIONS] INPUT_MATRIX

Options

-o, --output <output>

Optional path to output file to output the name of the newly created matrix. By default the list will be printed out to stdout

--minimum <minimum>

Minimum range for values to be converted to 1.

--maximum <maximum>

Maximum range for values to be converted to 1.

--include-max, --exclude-max

A flag to include the maximum threshold itself. By default the threshold value will be included.

--include-min, --exclude-min

A flag to include the minimum threshold itself. By default the threshold value will be included.

--comply, --reverse

A flag to reverse the selection logic. This is useful for cases that you want to all the values outside a certain range to be converted to 1. By default the input logic will be used as is.

Arguments

INPUT_MATRIX

Required argument

count

Count values in a row that meet a certain criteria.

This command is useful for post processing results like the number of sensors
which receive more than X lux at any timestep.
honeybee-radiance post-process count [OPTIONS] INPUT_MATRIX

Options

-o, --output <output>

Optional path to output file to output the name of the newly created matrix. By default the list will be printed out to stdout

--minimum <minimum>

Minimum range for values to be converted to 1.

--maximum <maximum>

Maximum range for values to be converted to 1.

--include-max, --exclude-max

A flag to include the maximum threshold itself. By default the threshold value will be included.

--include-min, --exclude-min

A flag to include the minimum threshold itself. By default the threshold value will be included.

--comply, --reverse

A flag to reverse the selection logic. This is useful for cases that you want to all the values outside a certain range to be converted to 1. By default the input logic will be used as is.

Arguments

INPUT_MATRIX

Required argument

cumulative-radiation

Postprocess average irradiance (W/m2) into cumulative radiation (kWh/m2).

Args:
average_irradiance: A single-column matrix of average irradiance values.
This input matrix must be in ASCII format.
wea: The .wea file that was used in the irradiance simulation. This
will be used to determine the duration of the analysis for computing
cumulative radiation.
honeybee-radiance post-process cumulative-radiation [OPTIONS]
                                                    AVERAGE_IRRADIANCE WEA

Options

--timestep <timestep>

The timestep of the Wea file, which is used to to compute cumulative radiation over the time period of the Wea.

-o, --output <output>

Optional path to output file to output the name of the newly created matrix. By default the list will be printed out to stdout

Arguments

AVERAGE_IRRADIANCE

Required argument

WEA

Required argument

cumulative-radiation-config

Write a vtk-config file for cumulative radiation.

honeybee-radiance post-process cumulative-radiation-config 
    [OPTIONS]

Options

-o, --output-file <output_file>

Optional JSON file to output the config file.

Default

daylight-factor-config

Write a vtk-config file for daylight factor.

honeybee-radiance post-process daylight-factor-config [OPTIONS]

Options

-f, --folder <folder>

Optional relative path for results folder. This value will be set as path inside the config file

-o, --output-file <output_file>

Optional JSON file to output the config file.

Default

direct-sun-hours-config

Write a vtk-config file for direct sun hours.

honeybee-radiance post-process direct-sun-hours-config [OPTIONS]

Options

-f, --folder <folder>

Optional relative path for results folder. This value will be set as path inside the config file

-o, --output-file <output_file>

Optional JSON file to output the config file.

Default

electric-lighting

Generate electric lighting schedules from annual daylight results.

Such controls will dim the lights according to whether the illuminance values at the sensor locations are at a target illuminance setpoint. The results can be used to account for daylight controls in energy simulations.

This function will generate one schedule per sensor grid in the simulation. Each grid should have sensors at the locations in space where daylight dimming sensors are located. Grids with one, two, or more sensors can be used to model setups where fractions of each room are controlled by different sensors. If the sensor grids are distributed over the entire floor of the rooms, the resulting schedules will be idealized, where light dimming has been optimized to supply the minimum illuminance setpoint everywhere in the room.

Args:
folder: Results folder. This folder is an output folder of the annual
daylight recipe. Folder should include grids_info.json and
sun-up-hours.txt. The command uses the list in grids_info.json to
find the result files for each sensor grid.
honeybee-radiance post-process electric-lighting [OPTIONS] FOLDER

Options

-s, --base-schedule <base_schedule>

Path to a CSV file for the lighting schedule without any daylight controls. The values of this schedule will be multiplied by the hourly dimming fraction to yield the output lighting schedules. If unspecified, a schedule from 9AM to 5PM on weekdays will be used.

-i, --ill-setpoint <ill_setpoint>

A number for the illuminance setpoint in lux beyond which electric lights are dimmed if there is sufficient daylight.

Default

300

-p, --min-power-in <min_power_in>

A number between 0 and 1 for the the lowest power the lighting system can dim down to, expressed as a fraction of maximum input power.

Default

0.3

-l, --min-light-out <min_light_out>

A number between 0 and 1 the lowest lighting output the lighting system can dim down to, expressed as a fraction of maximum light output. Note that setting this to 1 means lights are not dimmed at all until the illuminance setpoint is reached. This can be used to approximate manual light-switching behavior when used in conjunction with the off_at_min_ output below.

Default

0.2

--on-at-min, -oam, --off-at-min

Flag to note whether lights should switch off completely when they get to the minimum power input.

Default

True

-f, --output-file <output_file>

Optional JSON file to output a summary of the number of LEED credits and the percentage of sensor area that meets the criteria. By default this will be printed out to stdout

Default

Arguments

FOLDER

Required argument

leed-illuminance

Estimate LEED daylight credits from two point-in-time illuminance folders.

Args:
folder: Project folder for a LEED illuminance simulation. It should contain
a HBJSON model and two sub-folders of complete point-in-time illuminance
simulations labeled “9AM” and “3PM”. These two sub-folders should each
have results folders that include a grids_info.json and .res files with
illuminance values for each sensor. If Meshes are found for the sensor
grids in the HBJSON file, they will be used to compute percentages
of occupied floor area that pass vs. fail. Otherwise, all sensors will
be assumed to represent an equal amount of floor area.
honeybee-radiance post-process leed-illuminance [OPTIONS] FOLDER

Options

--glare-control, -ngc, --no-glare-control

Flag to note whether the model has “view-preserving automatic (with manual override) glare-control devices,” which means that illuminance only needs to be above 300 lux and not between 300 and 3000 lux.

Default

True

-gf, --grids-filter <grids_filter>

A pattern to filter the grids for just the regularly occupied spaces.

Default
-sf, --sub-folder <sub_folder>

Optional relative path for a subfolder to write the pass/fail files for each sensor grid.

--output-file <output_file>

Optional JSON file to output a summary of the number of LEED credits and the percentage of sensor area that meets the criteria. By default this will be printed out to stdout

Default

Arguments

FOLDER

Required argument

point-in-time-config

Write a vtk-config file for a point-in-time study.

honeybee-radiance post-process point-in-time-config [OPTIONS]

Options

-m, --metric <metric>

Text for the type of metric to be output from the calculation. Choose from: illuminance, irradiance, luminance, radiance.

Default

illuminance

-f, --folder <folder>

Optional relative path for results folder. This value will be set as path inside the config file

-o, --output-file <output_file>

Optional JSON file to output the config file.

Default

sky-view-config

Write a vtk-config file for daylight factor.

honeybee-radiance post-process sky-view-config [OPTIONS]

Options

-f, --folder <folder>

Optional relative path for results folder. This value will be set as path inside the config file

-o, --output-file <output_file>

Optional JSON file to output the config file.

Default

solar-tracking

Postprocess a list of result folders to account for dynamic solar tracking.

This function essentially takes .ill files for each state of a dynamic tracking
system and produces a single .ill file that models the tracking behavior.
Args:
folder: Results folder containing sub-folders that each represent a state
of the dynamic solar tracking system. Each sub-folder should contain .ill
files for that state and the names of these .ill files should be the
same across all sub-folders.
sun_up_hours: The .txt file containing the sun-up hours that were simulated.
wea: The .wea file that was used in the simulation. This will be used to
determine the solar positions.
honeybee-radiance post-process solar-tracking [OPTIONS] FOLDER SUN_UP_HOURS
                                              WEA

Options

--north <north>

Angle to north (0-360). 90 is west and 270 is east

Default

0

-t, --tracking-increment <tracking_increment>

An integer for the increment angle of each state in degrees. (Default: 5).

-sf, --sub-folder <sub_folder>

Optional relative path for subfolder to write output .ill files of the dynamic tracking system.

Arguments

FOLDER

Required argument

SUN_UP_HOURS

Required argument

WEA

Required argument

sum-row

Postprocess a Radiance matrix and add all the numbers in each row.

This command is useful for translating Radiance results to outputs like radiation
to total radiation. Input matrix must be in ASCII format. The header in the input
file will be ignored.
honeybee-radiance post-process sum-row [OPTIONS] INPUT_MATRIX

Options

--divisor <divisor>

An optional number, that the summed row will be divided by. For example, this can be a timestep, which can be used to ensure that a summed row of irradiance yields cumulative radiation over the entire time period of the matrix.

-o, --output <output>

Optional path to output file to output the name of the newly created matrix. By default the list will be printed out to stdout

Arguments

INPUT_MATRIX

Required argument