postprocess¶

honeybee-radiance-postprocess post-process¶

Commands to post-process Radiance results.

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

abnt¶

Commands for ABNT NBR (Brazil) post-processing of Radiance results.

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

abnt-nbr-15575¶

Calculate metrics for ABNT NBR 15575.

Args:

folder: Simulation folder for a ABNT NBR 15575 simulation. It should

contain four sub-folder of complete point-in-time illuminance
simulations labeled “4_930AM”, “4_330PM”, “10_930AM”, and “10_330PM”.
These sub-folder should each have results folder that include a
grids_info.json and .res files with illuminance values for each
sensor.

model-file: A Honeybee Model file that was used in the simulations. This

file is used to extract the center points of the sensor grids. It is

a requirement that the sensor grids have Meshes.

honeybee-radiance-postprocess post-process abnt abnt-nbr-15575 
    [OPTIONS] FOLDER MODEL_FILE

Options

-gl, --ground-level <ground_level>¶

A value to define the height of the ground level. This will make sure that rooms below this height will not be counted as ground level rooms.

Default:: 0

-rc, --room-center, -gc, --grid-center¶

Flag to note whether the evaluation of the center is at the room center or the grid center.

Default:: True

-sf, --sub-folder <sub_folder>¶: Relative path for subfolder to write output files.

Arguments

FOLDER¶: Required argument

MODEL_FILE¶: Required argument

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.

honeybee-radiance-postprocess 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

-st, --states <states>¶: A JSON file with a dictionary of states. If states are not provided the default states will be used for any aperture groups.

-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.

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-postprocess post-process annual-daylight-en17037 
    [OPTIONS] FOLDER SCHEDULE

Options

-st, --states <states>¶: A JSON file with a dictionary of states. If states are not provided the default states will be used for any aperture groups.

-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-daylight-file¶

Compute annual metrics for a single file and write the metrics 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:

file: Annual illuminance file. This can be either a NumPy file or a

binary Radiance file.

sun_up_hours: A file with the sun up hours of the study.

honeybee-radiance-postprocess post-process annual-daylight-file 
    [OPTIONS] FILE SUN_UP_HOURS

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

--study-info <study_info>¶: Optional study info file. This option is needed if the time step is larger than 1.

-gn, --grid-name <grid_name>¶: Optional name of each metric file.

-sf, --sub-folder <sub_folder>¶: Optional relative path for subfolder to write output metric files.

Arguments

FILE¶: Required argument

SUN_UP_HOURS¶: 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. This folder is an output folder of annual

irradiance recipe. Folder should include grids_info.json and

sun-up-hours.txt.

honeybee-radiance-postprocess post-process annual-irradiance 
    [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.

-st, --states <states>¶: A JSON file with a dictionary of states. If states are not provided the default states will be used for any aperture groups.

-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-sunlight-exposure¶

Compute annual sunlight exposure in a folder and write them in a subfolder.

This command generates 2 files for each input grid.

ase/{grid-name}.ase -> Annual Sunlight Exposure

hours_above/{grid-name}.hours -> Number of overlit hours for each sensor

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.

honeybee-radiance-postprocess post-process annual-sunlight-exposure 
    [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.

-dt, --direct-threshold <direct_threshold>¶

The threshold that determines if a sensor is overlit.

Default:: 1000

-oh, --occ-hours <occ_hours>¶

The number of occupied hours that cannot receive more than the direct_threshold.

Default:: 250

-st, --states <states>¶: A JSON file with a dictionary of states. If states are not provided the default states will be used for any aperture groups.

-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-to-data¶

Get annual data collections as JSON files.

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-postprocess post-process annual-to-data [OPTIONS] FOLDER

Options

-st, --states <states>¶: A JSON file with a dictionary of states. If states are not provided the default states will be used for any aperture groups.

-gf, --grids-filter <grids_filter>¶

A pattern to filter the grids.

Default:: '*'

-si, --sensor-index <sensor_index>¶: A JSON file with a dictionary of sensor indices for each grid. If not provided all sensors will be used.

--total, --direct¶: Switch between total and direct results. Default is total.

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

Optional file to output the JSON strings of the data collections. By default, it will be printed to stdout

Default:: '-'

Arguments

FOLDER¶: Required argument

annual-uniformity-ratio¶

Calculate annual uniformity ratio and write it to a folder.

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.

honeybee-radiance-postprocess post-process annual-uniformity-ratio 
    [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>¶

A threshold for the uniformity ratio. Defaults to 0.5.

Default:: 0.5

-st, --states <states>¶: A JSON file with a dictionary of states. If states are not provided the default states will be used for any aperture groups.

-gf, --grids-filter <grids_filter>¶

A pattern to filter the grids.

Default:: '*'

-sf, --sub-folder <sub_folder>¶: Optional relative path for subfolder to write annual uniformity ratio.

Arguments

FOLDER¶: Required argument

average-values¶

Get average values for each sensor over a given period.

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-postprocess post-process average-values [OPTIONS] FOLDER

Options

-h, --hoys-file <hoys_file>¶: Path to an HOYs file. Values must be separated by new line. If not provided the data will not be filtered by HOYs.

-st, --states <states>¶: A JSON file with a dictionary of states. If states are not provided the default states will be used for any aperture groups.

-gf, --grids-filter <grids_filter>¶

A pattern to filter the grids.

Default:: '*'

--total, --direct¶: Switch between total and direct results. Default is total.

-sf, --sub-folder <sub_folder>¶: Optional relative path for subfolder to write output metric files.

Arguments

FOLDER¶: Required argument

breeam¶

Commands for BREEAM post-processing of Radiance results.

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

breeam-4b¶

Calculate metrics for BREEAM.

Args:

folder: Results folder. This folder is an output folder of annual daylight

recipe.

model-file: A Honeybee Model file that was used in the simulation.

honeybee-radiance-postprocess post-process breeam breeam-4b 
    [OPTIONS] FOLDER

Options

-m, --model-file <model_file>¶: A Honeybee Model file that was used in the simulation.

-sf, --sub-folder <sub_folder>¶: Relative path for subfolder to write output files.

Arguments

FOLDER¶: 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 or binary format. The input
Radiance file must have a header.

Args:: input-matrix: A Radiance matrix file.

honeybee-radiance-postprocess post-process convert-to-binary 
    [OPTIONS] INPUT_MATRIX

Options

--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.

-n, --name <name>¶

Name of output file.

Default:: 'binary'

-of, --output-folder <output_folder>¶: Output folder.

Arguments

INPUT_MATRIX¶: Required argument

cumulative-values¶

Get cumulative values for each sensor over a given period.

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-postprocess post-process cumulative-values 
    [OPTIONS] FOLDER

Options

-h, --hoys-file <hoys_file>¶: Path to an HOYs file. Values must be separated by new line. If not provided the data will not be filtered by HOYs.

-st, --states <states>¶: A JSON file with a dictionary of states. If states are not provided the default states will be used for any aperture groups.

-gf, --grids-filter <grids_filter>¶

A pattern to filter the grids.

Default:: '*'

--total, --direct¶: Switch between total and direct results. Default is total.

-sf, --sub-folder <sub_folder>¶: Optional relative path for subfolder to write output metric files.

Arguments

FOLDER¶: Required argument

direct-sun-hours¶

Post-process a Radiance matrix to direct sun hours and cumulative direct sun hours.

This command will convert values in the Radiance matrix file to 0-1 values.
The output will be a direct sun hours file, and a cumulative direct sun hours
file where the values are the summed values for each row.

Args:: input-matrix: A Radiance matrix file.

honeybee-radiance-postprocess post-process direct-sun-hours 
    [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.

-of, --output-folder <output_folder>¶: Output folder.

Arguments

INPUT_MATRIX¶: Required argument

grid-summary¶

Calculate a grid summary.

If the grids info file is omitted it is a requirement that there is a grids info file in the main folder or in each sub folder.

Args:

folder: A folder with results.

honeybee-radiance-postprocess post-process grid-summary [OPTIONS] FOLDER

Options

-m, --model <model>¶: An optional HBJSON model file. This will be used to find the area of the grids. The area is used when calculating percentages of floor area.

-gi, --grids-info <grids_info>¶: An optional JSON file with grid information. If no file is provided the command will look for a file in the folder.

-n, --name <name>¶

Optional filename of grid summary.

Default:: 'grid_summary'

-gm, --grid-metrics <grid_metrics>¶: An optional JSON file with additional custom metrics to calculate.

--sub-folder, --main-folder¶: If sub-folder is selected it will look for any sub-folders in the folder argument. If main-folder is selected it will look for result files in the folder argument.

Arguments

FOLDER¶: Required argument

leed¶

Commands for LEED post-processing of Radiance results.

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

daylight-option-one¶

Calculate credits for LEED v4.1 Daylight Option 1.

Use the shade-transmittance option to set a shade transmittance values for aperture groups. The shade-transmittance-file option takes precedence over the shade-transmittance, however, if any aperture groups are missing in the JSON file given to the shade-transmittance-file option, the value from shade-transmittance will be used for those aperture groups.

Args:

folder: Results folder. This folder is an output folder of annual daylight

recipe. The daylight simulation must include aperture groups.

honeybee-radiance-postprocess post-process leed daylight-option-one 
    [OPTIONS] FOLDER

Options

-gf, --grids-filter <grids_filter>¶

A pattern to filter the grids.

Default:: '*'

-st, --shade-transmittance <shade_transmittance>¶

A value to use as a multiplier in place of solar shading. Value for shade transmittance must be 1 > value > 0.

Default:: 0.02

-stf, --shade-transmittance-file <shade_transmittance_file>¶: A JSON file with a dictionary where aperture groups are keys, and the value for each key is the shade transmittance. Values for shade transmittance must be 1 > value > 0. If any aperture groups are missing in the JSON file, its shade transmittance value will be set to the value of the –shade-transmittance option (0.02 by default).

--use-shade-transmittance, --use-states¶

A flag to select if the post-processing should use a shade transmittance or the simulated states of aperture groups. Using states should only be selected if the annual daylight simulation included ray tracing of a second (blind) state for each aperture group.

Default:: True

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

Relative path for subfolder to write output files.

Default:: 'leed_summary'

Arguments

FOLDER¶: Required argument

median-values¶

Get median values for each sensor over a given period.

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-postprocess post-process median-values [OPTIONS] FOLDER

Options

-h, --hoys-file <hoys_file>¶: Path to an HOYs file. Values must be separated by new line. If not provided the data will not be filtered by HOYs.

-st, --states <states>¶: A JSON file with a dictionary of states. If states are not provided the default states will be used for any aperture groups.

-gf, --grids-filter <grids_filter>¶

A pattern to filter the grids.

Default:: '*'

--total, --direct¶: Switch between total and direct results. Default is total.

-sf, --sub-folder <sub_folder>¶: Optional relative path for subfolder to write output metric files.

Arguments

FOLDER¶: Required argument

peak-values¶

Get peak values for each sensor over a given period.

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-postprocess post-process peak-values [OPTIONS] FOLDER

Options

-h, --hoys-file <hoys_file>¶: Path to an HOYs file. Values must be separated by new line. If not provided the data will not be filtered by HOYs.

-st, --states <states>¶: A JSON file with a dictionary of states. If states are not provided the default states will be used for any aperture groups.

-gf, --grids-filter <grids_filter>¶

A pattern to filter the grids.

Default:: '*'

--total, --direct¶: Switch between total and direct results. Default is total.

--coincident, --non-coincident¶

Boolean to indicate whether output values represent the the peak value for each sensor throughout the entire analysis (False) or they represent the highest overall value across each sensor grid at a particular timestep (True).

Default:: False

-sf, --sub-folder <sub_folder>¶: Optional relative path for subfolder to write output metric files.

Arguments

FOLDER¶: Required argument

point-in-time¶

Get point in time values.

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.

hoy: An HOY (point-in-time) for which to get the point-in-time values.

honeybee-radiance-postprocess post-process point-in-time [OPTIONS] FOLDER HOY

Options

-st, --states <states>¶: A JSON file with a dictionary of states. If states are not provided the default states will be used for any aperture groups.

-gf, --grids-filter <grids_filter>¶

A pattern to filter the grids.

Default:: '*'

--total, --direct¶: Switch between total and direct results. Default is total.

-sf, --sub-folder <sub_folder>¶: Optional relative path for subfolder to write output metric files.

Arguments

FOLDER¶: Required argument

HOY¶: Required argument

two-phase¶

Commands to work with two phase Radiance matrices using NumPy.

honeybee-radiance-postprocess post-process two-phase [OPTIONS] COMMAND
                                                     [ARGS]...

add-remove-sky-matrix¶

Process results of two phase simulations (total, direct, direct sunlight).

The function will replace the direct values with the direct sunlight values: total - direct + direct_sunlight.

The function has two output files. One for the results of the above calculation, and one for the direct sunlight values.

Args:

total-mtx: Path to total matrix.
direct-mtx: Path to direct matrix.
direct-sunlight-mtx: Path to direct sunlight matrix.

honeybee-radiance-postprocess post-process two-phase add-remove-sky-matrix 
    [OPTIONS] TOTAL_MTX DIRECT_MTX DIRECT_SUNLIGHT_MTX

Options

--binary, --ascii¶: Switch between binary and ascii input matrices. Default is binary.

-n, --total-name <total_name>¶

Total output file name.

Default:: 'total'

-n, --direct-name <direct_name>¶

Direct output file name.

Default:: 'direct'

-of, --output-folder <output_folder>¶: Output folder.

Arguments

TOTAL_MTX¶: Required argument

DIRECT_MTX¶: Required argument

DIRECT_SUNLIGHT_MTX¶: Required argument

rgb-to-illuminance¶

Process results of two phase simulations (total, direct, direct sunlight).

The function will replace the direct illuminance with the direct sunlight illuminance: total - direct + direct_sunlight.

The function has two output files. One for the illuminance of the above calculation, and one for the direct sunlight illuminance. In both cases the conversion from RGB to illuminance is executed.

Args:

total-mtx: Path to total matrix.
direct-mtx: Path to direct matrix.
direct-sunlight-mtx: Path to direct sunlight matrix.

honeybee-radiance-postprocess post-process two-phase rgb-to-illuminance 
    [OPTIONS] TOTAL_MTX DIRECT_MTX DIRECT_SUNLIGHT_MTX

Options

--binary, --ascii¶: Switch between binary and ascii input matrices. Default is binary.

-n, --total-name <total_name>¶

Total output file name.

Default:: 'total'

-n, --direct-name <direct_name>¶

Direct output file name.

Default:: 'direct'

-of, --output-folder <output_folder>¶: Output folder.

Arguments

TOTAL_MTX¶: Required argument

DIRECT_MTX¶: Required argument

DIRECT_SUNLIGHT_MTX¶: Required argument

rgb-to-illuminance-file¶

Convert a RGB Radiance matrix to illuminance and save the array as a NumPy file.

Args:

mtx-file: Path to matrix file to convert.

honeybee-radiance-postprocess post-process two-phase rgb-to-illuminance-file 
    [OPTIONS] MTX_FILE

Options

--binary, --ascii¶: Switch between binary and ascii input matrices. Default is binary.

-n, --name <name>¶

Name of output file.

Default:: 'illuminance'

-of, --output-folder <output_folder>¶: Output folder.

Arguments

MTX_FILE¶: Required argument

well¶

Commands for WELL post-processing of Radiance results.

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

well-annual-daylight¶

Calculate credits for WELL L06.

Args:

folder: Results folder. This folder is an output folder of annual daylight

recipe. The daylight simulation must include aperture groups.

honeybee-radiance-postprocess post-process well well-annual-daylight 
    [OPTIONS] FOLDER

Options

-gf, --grids-filter <grids_filter>¶

A pattern to filter the grids.

Default:: '*'

-st, --shade-transmittance <shade_transmittance>¶

A value to use as a multiplier in place of solar shading. Value for shade transmittance must be 1 > value > 0.

Default:: 0.02

-stf, --shade-transmittance-file <shade_transmittance_file>¶: A JSON file with a dictionary where aperture groups are keys, and the value for each key is the shade transmittance. Values for shade transmittance must be 1 > value > 0. If any aperture groups are missing in the JSON file, its shade transmittance value will be set to the value of the –shade-transmittance option (0.02 by default).

--use-shade-transmittance, --use-states¶

Default:: True

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

Relative path for subfolder to write output files.

Default:: 'well_summary'

Arguments

FOLDER¶: Required argument