edit

honeybee-radiance edit

Commands for editing radiance properties of Honeybee Models.

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

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.

Args:
model_json: Full path to a Model JSON file.
honeybee-radiance edit add-room-sensors [OPTIONS] MODEL_JSON

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_JSON

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 downard pointing grids account for ground-reflected shortwave irradiance.

Args:
model_json: Full path to a Model JSON file.
honeybee-radiance edit mirror-model-sensors [OPTIONS] MODEL_JSON

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_JSON

Required argument