multiphase¶
honeybee-radiance multi_phase¶
Commands to run multi-phase operations in Radiance.
honeybee-radiance multi_phase [OPTIONS] COMMAND [ARGS]...
add-aperture-group-blinds¶
Add a state geometry to aperture groups.
This command adds state geometry to all aperture groups in the model. The geometry is the same as the aperture geometry but the modifier is changed. The geometry is translated inward by a distance which by default is 0.001 in model units.
honeybee-radiance multi_phase add-aperture-group-blinds [OPTIONS] MODEL_FILE
Options
- -dt, --diffuse-transmission <diffuse_transmission>¶
Diffuse transmission of the aperture group blinds. Default is 0.05 (5%).
- Default
0.05
- -dt, --specular-transmission <specular_transmission>¶
Specular transmission of the aperture group blinds. Default is 0 (0%).
- Default
0
- -d, --distance <distance>¶
Distance from the aperture parent surface to the blind surface.
- Default
0.001
- -s, --scale <scale>¶
Scaling value to scale blind geometry at the center point of the aperture.
- Default
1.001
- --output-model <output_model>¶
Optional name of output HBJSON file as a string. If no name is provided the name will be the identifier of the model with “blinds” as suffix.
Arguments
- MODEL_FILE¶
Required argument
aperture-group¶
Calculate aperture groups for exterior apertures.
This command calculates view factor from apertures to sky patches (rfluxmtx). Each aperture is represented by a sensor grid, and the view factor for the whole aperture is the average of the grid. The apertures are grouped based on the threshold.
honeybee-radiance multi_phase aperture-group [OPTIONS] MODEL_FILE
Options
- --octree <octree>¶
Path to octree file. The octree will be created from the model-file if no file is provided.
- --rflux-sky <rflux_sky>¶
Path to rflux sky file. The rflux sky file will be created if no file is provided.
- -s, --size <size>¶
Aperture grid size. A lower number will give a finer grid and more accurate results but the calculation time will increase.
- Default
0.2
- -t, --threshold <threshold>¶
A number that determines if two apertures/aperture groups can be clustered. A lower number is more accurate but will also increase the number of aperture groups.
- Default
0.001
- -ad, --ambient-division <ambient_division>¶
Number of ambient divisions (-ad) for view factor calculation in rfluxmtx. Increasing the number will give more accurate results but also increase the calculation time.
- Default
1000
- -rb, --room-based, -nrb, --no-room-based¶
Flag to note whether the apertures should be grouped on a room basis. If grouped on a room basis apertures from different room cannot be in the same group.
- Default
True
- -vf, --view-factor, -or, --orientation¶
Flag to note whether the apertures should be grouped by calculating view factors for the apertures to a discretized sky or simply by the normal orientation of the apertures.
- Default
True
- -vt, --vertical-tolerance <vertical_tolerance>¶
A float value for vertical tolerance between two apertures. If the vertical distance between two apertures is larger than this tolerance the apertures cannot be grouped. If no value is given the vertical grouping will be skipped.
- --output-folder <output_folder>¶
Output folder into which the files be written.
- Default
aperture_groups
- --output-model <output_model>¶
Optional name of output HBJSON file as a string. If no name is provided the update Model with dynamic group identifiers will be written to a HBJSON file.
Arguments
- MODEL_FILE¶
Required argument
dmtx-group¶
Calculate aperture groups for daylight matrix purposes. This command calculates view factor from apertures to sky patches (rfluxmtx). Each aperture is represented by a sensor grid, and the view factor for the whole aperture is the average of the grid. The apertures are grouped based on the threshold.
honeybee-radiance multi_phase dmtx-group [OPTIONS] FOLDER OCTREE RFLUX_SKY
Options
- --name <name>¶
Name of output JSON file.
- Default
dmx_aperture_groups
- -s, --size <size>¶
Aperture grid size. A lower number will give a finer grid and more accurate results but the calculation time will increase.
- Default
0.2
- -t, --threshold <threshold>¶
A number that determines if two apertures/aperture groups can be clustered. A higher number is more accurate but will also increase the number of aperture groups.
- Default
0.001
- -ad, --ambient-division <ambient_division>¶
Number of ambient divisions (-ad) for view factor calculation in rfluxmtx. Increasing the number will give more accurate results but also increase the calculation time.
- Default
1000
- --output-folder <output_folder>¶
Output folder into which the files be written.
- Default
dmtx_aperture_groups
Arguments
- FOLDER¶
Required argument
- OCTREE¶
Required argument
- RFLUX_SKY¶
Required argument
flux-transfer¶
Calculate flux transfer matrix for a sender file per receiver.
This command calculates a flux transfer matrix for the given sender and receiver files. This can be used to calculate a flux transfer matrix for input and output apertures on a light pipe, or a flux transfer matrix from an aperture to a discretized sky (daylight matrix).
honeybee-radiance multi_phase flux-transfer [OPTIONS] SENDER_FILE
RECEIVER_FILE OCTREE
Options
- --rad-params <rad_params>¶
Radiance parameters.
- --rad-params-locked <rad_params_locked>¶
Protected Radiance parameters. These values will overwrite user input rad parameters.
- -o, --output <output>¶
Path to output file. If a relative path is provided it should be relative to project folder.
- --dry-run¶
A flag to show the command without running it.
- Default
False
Arguments
- SENDER_FILE¶
Required argument
- RECEIVER_FILE¶
Required argument
- OCTREE¶
Required argument
prepare-multiphase¶
This command prepares the model folder for simulations with aperture groups. It will generate a set of octrees and sensor grids that are unique to each state of each aperture group.
This command will generate octrees for both default and direct studies for aperture groups, creating one octree for each light path, i.e., all other light paths are blacked.
Sensor grids will be redistributed if they are to be used in a two phase simulation. A subfolder for each light path will be created. In this folder the redistributed grids are found.
If the model folder have aperture groups, a file with states information for each grid will be written.
honeybee-radiance multi_phase prepare-multiphase [OPTIONS] FOLDER GRID_COUNT
Options
- -d, --grid-divisor <grid_divisor>¶
An optional integer to be divided by the grid-count to yield a final number of grids to generate. This is useful in workflows where the grid-count is being interpreted as a cpu-count but there are multiple processors acting on a single grid. To ignore this limitation set the value to 1. Default: 1.
- -msc, --min-sensor-count <min_sensor_count>¶
Minimum number of sensors in each output grid. Use this number to ensure the number of sensors in output grids never gets very small. This input will override the input grid-count when specified. To ignore this limitation, set the value to 1. Default: 1.
- --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
- --octree-folder <octree_folder>¶
Output folder into which the octree files be written.
- Default
octree
- --grid-folder <grid_folder>¶
Output folder into which the grid files be written.
- Default
grid
- --exclude-static, --include-static¶
A flag to indicate if static apertures should be excluded or included. If excluded static apertures will not be treated as its own dynamic state.
- Default
True
- --default-states, --all-states¶
A flag to indicate if the command should generate octrees and grids for all aperture group states or just the default states of aperture groups.
- Default
False
Arguments
- FOLDER¶
Required argument
- GRID_COUNT¶
Required argument
three-phase¶
Commands to do matrix operations for three-phase.
honeybee-radiance multi_phase three-phase [OPTIONS] COMMAND [ARGS]...
combinations¶
Matrix multiplication for view matrix, transmission matrix, daylight matrix and sky matrix.
honeybee-radiance multi_phase three-phase combinations [OPTIONS] SENDER_INFO
RECEIVER_INFO
STATES_INFO
Options
- --folder <folder>¶
Path to target folder. The command will create two JSON files in this folder.
- Default
.
- -cn, --combinations-name <combinations_name>¶
Output file name for 3 phase multiplication combinations.
- Default
3phase_multiplication_info
- -rn, --result-mapper-name <result_mapper_name>¶
Output file name for results mapper file.
- Default
3phase_results_info
Arguments
- SENDER_INFO¶
Required argument
- RECEIVER_INFO¶
Required argument
- STATES_INFO¶
Required argument
multiplication¶
Matrix multiplication for view matrix, transmission matrix, daylight matrix and sky matrix.
honeybee-radiance multi_phase three-phase multiplication [OPTIONS] SKY_VECTOR
VIEW_MATRIX T_MATRIX
DAYLIGHT_MATRIX
OUTPUT_MATRIX
Options
- --options <options>¶
a string that will be passed to dctimestep for setting options such as output file format (-o), input data format(-i) etc.
- --dry-run¶
A flag to show the command without running it.
- Default
False
Arguments
- SKY_VECTOR¶
Required argument
- VIEW_MATRIX¶
Required argument
- T_MATRIX¶
Required argument
- DAYLIGHT_MATRIX¶
Required argument
- OUTPUT_MATRIX¶
Required argument
rmtxop¶
Matrix multiplication for view matrix, transmission matrix, daylight matrix and sky matrix.
honeybee-radiance multi_phase three-phase rmtxop [OPTIONS] VIEW_MATRIX
T_MATRIX DAYLIGHT_MATRIX
SKY_VECTOR OUTPUT_MATRIX
Options
- --output-format <output_format>¶
Output format for output matrix. Valid inputs are a, f, d and c for ASCII, float, double or RGBE colors. If conversion is not provided you can change the output type using rad-params options.
- Default
a
- Options
a | f | d | c
- --illuminance, --raw¶
A flag to convert the result to illuminance.
- Default
True
- --remove-header, --keep-header¶
A flag to keep or remove the header from the output file.
- --dry-run¶
A flag to show the command without running it.
- Default
False
Arguments
- VIEW_MATRIX¶
Required argument
- T_MATRIX¶
Required argument
- DAYLIGHT_MATRIX¶
Required argument
- SKY_VECTOR¶
Required argument
- OUTPUT_MATRIX¶
Required argument
view-matrix¶
Calculate view matrix for a receiver file.
honeybee-radiance multi_phase view-matrix [OPTIONS] RECEIVER_FILE OCTREE
SENSOR_GRID
Options
- --sensor-count <sensor_count>¶
Number of sensors in sensor grid file. Number of sensors will be parsed form the sensor file if not provided.
- --rad-params <rad_params>¶
Radiance parameters.
- --rad-params-locked <rad_params_locked>¶
Protected Radiance parameters. These values will overwrite user input rad parameters.
- -o, --output <output>¶
Path to output file. If a relative path is provided it should be relative to project folder.
- --dry-run¶
A flag to show the command without running it.
- Default
False
Arguments
- RECEIVER_FILE¶
Required argument
- OCTREE¶
Required argument
- SENSOR_GRID¶
Required argument