edit¶
honeybee-radiance edit¶
Commands for editing radiance properties of Honeybee Models.
honeybee-radiance edit [OPTIONS] COMMAND [ARGS]...
add-aperture-sensors¶
Add SensorGrids to a honeybee model generated from the model’s apertures.
honeybee-radiance edit add-aperture-sensors [OPTIONS] MODEL_FILE
Options
- -s, --grid-size <grid_size>¶
A number for the dimension of the mesh grid cells. This can include the units of the distance (eg. 1ft) or, if no units are provided, the value will be interpreted in the honeybee model units.
- Default:
'0.5m'
- -o, --offset <offset>¶
A number for the distance at which the the sensor grid should be offset from the apertures. This can include the units of the distance (eg. 3ft) or, if no units are provided, the value will be interpreted in the honeybee model units.
- Default:
'0.1m'
- -t, --aperture-type <aperture_type>¶
Text to specify the type of aperture that will be used to generate grids. Note that only Faces with Outdoors boundary conditions will be used, meaning that most Floors will typically be excluded unless they represent the underside of a cantilever. Choose from Window, Skylight, All.
- Default:
'All'
- --include-mesh, -xm, --exclude-mesh¶
Flag to note whether to include a Mesh3D object that aligns with the grid positions under the “mesh” property of each grid. Excluding the mesh can greatly reduce model size but will mean Radiance results cannot be visualized as colored meshes.
- -r, --room <room>¶
Room identifier(s) to specify the room(s) for which sensor grids should be generated. By default, all rooms will get sensor grids.
- -f, --output-file <output_file>¶
Optional hbjson file to output the JSON string of the new model. By default this will be printed out to stdout
- Default:
'-'
Arguments
- MODEL_FILE¶
Required argument
add-face-sensors¶
Add SensorGrids to a honeybee model generated from the model’s faces.
honeybee-radiance edit add-face-sensors [OPTIONS] MODEL_FILE
Options
- -s, --grid-size <grid_size>¶
A number for the dimension of the mesh grid cells. This can include the units of the distance (eg. 1ft) or, if no units are provided, the value will be interpreted in the honeybee model units.
- Default:
'0.5m'
- -o, --offset <offset>¶
A number for the distance at which the the sensor grid should be offset from the floor. This can include the units of the distance (eg. 3ft) or, if no units are provided, the value will be interpreted in the honeybee model units.
- Default:
'0.1m'
- -t, --face-type <face_type>¶
Text to specify the type of face that will be used to generate grids. Note that only Faces with Outdoors boundary conditions will be used, meaning that most Floors will typically be excluded unless they represent the underside of a cantilever. Choose from Wall, Roof, Floor, All.
- Default:
'Wall'
- --full-geometry, -p, --punched-geometry¶
Flag to note whether the punched_geometry of the faces should be used with the areas of sub-faces removed from the grid or the full geometry should be used.
- --include-mesh, -xm, --exclude-mesh¶
Flag to note whether to include a Mesh3D object that aligns with the grid positions under the “mesh” property of each grid. Excluding the mesh can greatly reduce model size but will mean Radiance results cannot be visualized as colored meshes.
- -r, --room <room>¶
Room identifier(s) to specify the room(s) for which sensor grids should be generated. By default, all rooms will get sensor grids.
- -f, --output-file <output_file>¶
Optional hbjson file to output the JSON string of the new model. By default this will be printed out to stdout
- Default:
'-'
Arguments
- MODEL_FILE¶
Required argument
add-face3d-sensors¶
Add SensorGrids to a honeybee model generated from a JSON array of Face3D objects.
honeybee-radiance edit add-face3d-sensors [OPTIONS] MODEL_FILE FACE3D_FILE
Options
- -n, --grid-name <grid_name>¶
Text string for the name of the SensorGrid, which will also be used to assign SensorGrid ID. This will be used to identify the object across a model and in the exported Radiance files so it is recommended that it be relatively unique. If unspecified, a random name will be generated.
- -s, --grid-size <grid_size>¶
A number for the dimension of the mesh grid cells. This can include the units of the distance (eg. 1ft) or, if no units are provided, the value will be interpreted in the honeybee model units.
- Default:
'0.5m'
- -o, --offset <offset>¶
A number for the distance at which the the sensor grid should be offset from the base geometry. This can include the units of the distance (eg. 3ft) or, if no units are provided, the value will be interpreted in the honeybee model units.
- Default:
'0'
- --no-flip, -fl, --flip¶
Flag to note whether the mesh normals should be reversed from the direction of the face geometriesand the –offset move the sensors in the opposite direction from the face normals.
- Default:
True
- --include-mesh, -xm, --exclude-mesh¶
Flag to note whether to include a Mesh3D object that aligns with the grid positions under the “mesh” property of each grid. Excluding the mesh can greatly reduce model size but will mean Radiance results cannot be visualized as colored meshes.
- -f, --output-file <output_file>¶
Optional hbjson file to output the JSON string of the new model. By default this will be printed out to stdout
- Default:
'-'
Arguments
- MODEL_FILE¶
Required argument
- FACE3D_FILE¶
Required argument
add-room-radial-sensors¶
Add SensorGrids to a honeybee model generated from the Room’s floors.
The grids will have the rooms referenced in their room_identifier property.
honeybee-radiance edit add-room-radial-sensors [OPTIONS] MODEL_FILE
Options
- -s, --grid-size <grid_size>¶
A number for the dimension of the radial grid. This can include the units of the distance (eg. 1ft) or, if no units are provided, the value will be interpreted in the honeybee model units.
- Default:
'0.5m'
- -o, --offset <offset>¶
A number for the distance at which the the sensor grid should be offset from the floor. This can include the units of the distance (eg. 3ft) or, if no units are provided, the value will be interpreted in the honeybee model units.
- Default:
'1.2m'
- --include-mesh, -xm, --exclude-mesh¶
Flag to note whether to include a Mesh3D object that aligns with the grid positions under the “mesh” property of each grid. Excluding the mesh can greatly reduce model size but will mean Radiance results cannot be visualized as colored meshes.
- --keep-out, -out, --remove-out¶
Flag to note whether an extra check should be run to remove sensor points that lie outside the Room volume. Note that this can add significantly to the runtime and this check is not necessary in the case that all walls are vertical and all floors are horizontal.
- Default:
True
- -w, --wall-offset <wall_offset>¶
A number for the distance at which sensors close to walls should be removed. This can include the units of the distance (eg. 3ft) or, if no units are provided, the value will be interpreted in the honeybee model units. Note that this option has no effect unless the value is more than half of the grid-size.
- Default:
'0m'
- -d, --dir-count <dir_count>¶
A positive integer for the number of radial directions to be generated around each position.
- Default:
8
- -v, --start-vector <start_vector>¶
An optional list of three values (separated by spaces) set the start direction of the generated directions. This can be used to orient the resulting sensors to specific parts of the scene. It can also change the elevation of the resulting directions since this start vector will always be rotated in the XY plane to generate the resulting directions.
- Default:
'0 -1 0'
- -m, --mesh-radius <mesh_radius>¶
An optional number to override the radius of the meshes generated around each sensor. If unspecified, it will be equal to 45 percent of the grid-size. Set to zero to ensure no mesh is added to the resulting sensor grids.
- -r, --room <room>¶
Room identifier(s) to specify the room(s) for which sensor grids should be generated. By default, all rooms will get sensor grids.
- -f, --output-file <output_file>¶
Optional hbjson file to output the JSON string of the new model. By default this will be printed out to stdout
- Default:
'-'
Arguments
- MODEL_FILE¶
Required argument
add-room-sensors¶
Add SensorGrids to a honeybee model generated from the Room’s floors.
The grids will have the rooms referenced in their room_identifier property.
honeybee-radiance edit add-room-sensors [OPTIONS] MODEL_FILE
Options
- -s, --grid-size <grid_size>¶
A number for the dimension of the mesh grid cells. This can include the units of the distance (eg. 1ft) or, if no units are provided, the value will be interpreted in the honeybee model units.
- Default:
'0.5m'
- -o, --offset <offset>¶
A number for the distance at which the the sensor grid should be offset from the floor. This can include the units of the distance (eg. 3ft) or, if no units are provided, the value will be interpreted in the honeybee model units.
- Default:
'0.8m'
- --include-mesh, -xm, --exclude-mesh¶
Flag to note whether to include a Mesh3D object that aligns with the grid positions under the “mesh” property of each grid. Excluding the mesh can greatly reduce model size but will mean Radiance results cannot be visualized as colored meshes.
- --keep-out, -out, --remove-out¶
Flag to note whether an extra check should be run to remove sensor points that lie outside the Room volume. Note that this can add significantly to the runtime and this check is not necessary in the case that all walls are vertical and all floors are horizontal.
- Default:
True
- -w, --wall-offset <wall_offset>¶
A number for the distance at which sensors close to walls should be removed. This can include the units of the distance (eg. 3ft) or, if no units are provided, the value will be interpreted in the honeybee model units. Note that this option has no effect unless the value is more than half of the grid-size.
- Default:
'0m'
- -r, --room <room>¶
Room identifier(s) to specify the room(s) for which sensor grids should be generated. By default, all rooms will get sensor grids.
- -f, --output-file <output_file>¶
Optional hbjson file to output the JSON string of the new model. By default this will be printed out to stdout
- Default:
'-'
Arguments
- MODEL_FILE¶
Required argument
mirror-model-sensors¶
Mirror a honeybee Model’s SensorGrids and format them for thermal mapping.
This involves setting the direction of every sensor to point up (0, 0, 1) and then adding a mirrored sensor grid with the same sensor positions that all point downward. In thermal mapping workflows, the upward-pointing grids can be used to account for direct and diffuse shortwave irradiance while the downward pointing grids account for ground-reflected shortwave irradiance.
honeybee-radiance edit mirror-model-sensors [OPTIONS] MODEL_FILE
Options
- -f, --output-file <output_file>¶
Optional hbjson file to output the JSON string of the converted model. By default this will be printed out to stdout
- Default:
'-'
Arguments
- MODEL_FILE¶
Required argument
reset-resource-ids¶
Reset the identifiers of resource objects in a Model file.
This is useful when human-readable names are needed when the model is exported to other formats like RAD and the uniqueness of the identifiers is less of a concern.
honeybee-radiance edit reset-resource-ids [OPTIONS] MODEL_FILE
Options
- --by-name, -uuid, --by-name-and-uuid¶
Flag to note whether newly-generated resource object IDs should be derived only from a cleaned display_name or whether this new ID should also have a unique set of 8 characters appended to it to guarantee uniqueness.
- --reset-modifiers, -m, --keep-modifiers¶
Flag to note whether the IDs of all modifiers in the model should be reset.
- Default:
True
- --reset-modifier-sets, -ms, --keep-modifier-sets¶
Flag to note whether the IDs of all modifier sets in the model should be reset.
- Default:
True
- -f, --output-file <output_file>¶
Optional hbjson file to output the JSON string of the converted model. By default this will be printed out to stdout
- Default:
'-'
Arguments
- MODEL_FILE¶
Required argument