edit

honeybee edit

Commands for editing Honeybee models.

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

convert-units

Convert a Model to a given units system.

Args:

model_file: Full path to a Honeybee Model file.

units: Text for the units system to which the model will be converted.

Choose from (Meters, Millimeters, Feet, Inches, Centimeters).

honeybee edit convert-units [OPTIONS] MODEL_FILE UNITS

Options

--scale, -ns, --do-not-scale

Flag to note whether the model should be scaled as it is converted to the new units system.

Default:

True

-f, --output-file <output_file>

Optional file to output the Model JSON string with solved adjacency. By default it will be printed out to stdout

Arguments

MODEL_FILE

Required argument

UNITS

Required argument

extruded-border

Add extruded borders to all windows in walls.

Args:

model_file: Full path to a Honeybee Model file.

honeybee edit extruded-border [OPTIONS] MODEL_FILE

Options

-d, --depth <depth>

A number for the extrusion depth. 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.2m'

--outdoor, -i, --indoor

Flag to note whether the borders should be on the indoors.

Default:

True

-f, --output-file <output_file>

Optional file to output the Model JSON string with borders. By default it will be printed out to stdout

Arguments

MODEL_FILE

Required argument

louvers-by-count

Add louvers to all outdoor walls or windows in walls.

Args:

model_file: Full path to a Honeybee Model file.

louver_count: A positive integer for the number of louvers to generate.

honeybee edit louvers-by-count [OPTIONS] MODEL_FILE LOUVER_COUNT

Options

-d, --depth <depth>

A number for the depth of the louvers. 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.25m'

-a, --angle <angle>

A number for the for an angle to rotate the louvers in degrees. Positive numbers indicate a downward rotation while negative numbers indicate an upward rotation.

Default:

0

-o, --offset <offset>

An optional number for the offset of the louvers from base Face or Aperture. 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'

--horizontal, -v, --vertical

Flag to note whether louvers are horizontal or vertical.

Default:

True

--per-window, -pw, --per-wall

Flag to note whether the louvers should be generated per aperture or per wall.

Default:

True

--outdoor, -i, --indoor

Flag to note whether the louvers should be on the indoors like a light shelf.

Default:

True

--no-flip, -fs, --flip-start

Flag to note whether the the side that the louvers start from should be flipped. If not flipped, louvers will start from top or right. If flipped, they will start from the bottom or left.

Default:

True

-f, --output-file <output_file>

Optional file to output the Model JSON string with louvers. By default it will be printed out to stdout

Arguments

MODEL_FILE

Required argument

LOUVER_COUNT

Required argument

louvers-by-spacing

Add louvers to all outdoor walls or windows in walls.

Args:

model_file: Full path to a Honeybee Model file.

honeybee edit louvers-by-spacing [OPTIONS] MODEL_FILE

Options

-s, --spacing <spacing>

A number for the distance between each louver. This can include the units of the distance (eg. 2ft) or, if no units are provided, the value will be interpreted in the honeybee model units.

Default:

'0.5m'

-d, --depth <depth>

A number for the depth of the louvers. 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.25m'

-a, --angle <angle>

A number for the for an angle to rotate the louvers in degrees. Positive numbers indicate a downward rotation while negative numbers indicate an upward rotation.

Default:

0

-o, --offset <offset>

An optional number for the offset of the louvers from base Face or Aperture. 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'

--horizontal, -v, --vertical

Flag to note wh.

Default:

True

-m, --max-count <max_count>

Optional integer to set the maximum number of louvers that will be generated. If 0, louvers will cover the entire face.

Default:

0

--per-window, -pw, --per-wall

Flag to note whether the louvers should be generated per aperture or per wall.

Default:

True

--outdoor, -i, --indoor

Flag to note whether the louvers should be on the indoors like a light shelf.

Default:

True

--no-flip, -fs, --flip-start

Flag to note whether the the side that the louvers start from should be flipped. If not flipped, louvers will start from top or right. If flipped, they will start from the bottom or left.

Default:

True

-f, --output-file <output_file>

Optional file to output the Model JSON string with louvers. By default it will be printed out to stdout

Arguments

MODEL_FILE

Required argument

overhang

Add overhangs to all outdoor walls or windows in walls.

Args:

model_file: Full path to a Honeybee Model file.

honeybee edit overhang [OPTIONS] MODEL_FILE

Options

-d, --depth <depth>

A number for the overhang depth. 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:

'1m'

-a, --angle <angle>

A number for the for an angle to rotate the overhang in degrees. Positive numbers indicate a downward rotation while negative numbers indicate an upward rotation.

Default:

0

-vo, --vertical-offset <vertical_offset>

An optional number for the vertical offset of the overhang from the top of the window or face. Positive numbers move up while negative mode down. 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'

--per-window, -pw, --per-wall

Flag to note whether the overhangs should be generated per aperture or per wall.

Default:

True

--outdoor, -i, --indoor

Flag to note whether the overhangs should be on the indoors like a light shelf.

Default:

True

-f, --output-file <output_file>

Optional file to output the Model JSON string with overhangs. By default it will be printed out to stdout

Arguments

MODEL_FILE

Required argument

reset-resource-ids

Reset the identifiers of all resource objects in a Model file.

This will reset the identifiers of all resources of all extensions and is useful when human-readable names are needed when the model is exported to simulation engines.

Args:

model_file: Full path to a Honeybee Model (HBJSON) file.

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

-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

solve-adjacency

Solve adjacency between Rooms of a Model file.

Args:

model_file: Full path to a Honeybee Model file.

honeybee edit solve-adjacency [OPTIONS] MODEL_FILE

Options

--no-merge, -m, --merge-coplanar

Flag to note whether coplanar Faces of the Rooms should be merged before proceeding with the rest of the adjacency solving. This is particularly helpful when used with the –intersect option since it will ensure the Room geometry is relatively clean before the intersection and adjacency solving occurs.

Default:

True

--no-intersect, -i, --intersect

Flag to note whether the Faces of the Rooms should be intersected with one another before the adjacencies are solved.

Default:

True

--no-overwrite, -ow, --overwrite

Flag to note whether existing Surface boundary conditions should be overwritten.

Default:

True

--wall, -ab, --air-boundary

Flag to note whether the wall adjacencies should be of the air boundary face type.

Default:

True

--surface, -a, --adiabatic

Flag to note whether the adjacencies should be surface or adiabatic.

Default:

True

-f, --output-file <output_file>

Optional file to output the Model JSON string with solved adjacency. By default it will be printed out to stdout

Arguments

MODEL_FILE

Required argument

windows-by-ratio

Add apertures to all outdoor walls of a model given a ratio.

Note that this method removes any existing apertures and doors from the Walls. This method attempts to generate as few apertures as necessary to meet the ratio.

Args:

model_file: Full path to a Honeybee Model file.

ratio: A number between 0 and 1 (but not perfectly equal to 1)

for the desired ratio between window area and wall area.

honeybee edit windows-by-ratio [OPTIONS] MODEL_FILE RATIO

Options

-f, --output-file <output_file>

Optional file to output the Model JSON string with windows. By default it will be printed out to stdout

Arguments

MODEL_FILE

Required argument

RATIO

Required argument

windows-by-ratio-rect

Add apertures to all outdoor walls of a model given a ratio.

Note that this method removes any existing apertures and doors from the Walls. Any rectangular portions of walls will have customized rectangular apertures using the various inputs.

Args:

model_file: Full path to a Honeybee Model file.

ratio: A number between 0 and 1 (but not perfectly equal to 1)

for the desired ratio between window area and wall area.

honeybee edit windows-by-ratio-rect [OPTIONS] MODEL_FILE RATIO

Options

-ah, --aperture-height <aperture_height>

A number for the target height of the output 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. Note that, if the ratio is too large for the height, the ratio will take precedence and the actual aperture_height will be larger than this value.

Default:

'2m'

-sh, --sill-height <sill_height>

A number for the target height above the bottom edge of the rectangle to start the apertures. Note that, if the ratio is too large for the height, the ratio will take precedence and the sill_height will be smaller than this value. 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'

-hs, --horizontal-separation <horizontal_separation>

A number for the target separation between individual aperture center lines. If this number is larger than the parent rectangle base, only one aperture will be produced. 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:

'3m'

-vs, --vertical-separation <vertical_separation>

An optional number to create a single vertical separation between top and bottom 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'

-f, --output-file <output_file>

Optional file to output the Model JSON string with windows. By default it will be printed out to stdout

Arguments

MODEL_FILE

Required argument

RATIO

Required argument