create

honeybee create

Commands for creating Honeybee models.

honeybee create [OPTIONS] COMMAND [ARGS]...

from-sync

Create a Model from two similar model files and instructions for syncing them.

Args:
base_model_file: An base Honeybee Model (as HBJSON or HBPkl)
that forms the base of the new model to be created.
other_model_file: An other Honeybee Model (as HBJSON or HBPkl)
that contains changes to the base model to be merged into
the base_model.
sync_instructions: A JSON file of SyncInstructions that states which
changes from the other model should be accepted or rejected
when building a new Model from the base model. The SyncInstructions
schema is essentially a variant of the ComparisonReport schema
that can be obtained by calling `honeybee compare models base_model_file
other_model_file –json`. The main difference is that the XXX_changed
properties should be replaced with update_XXX properties for
whether the change from the other_model should be accepted into
the new model or rejected from it.
honeybee create from-sync [OPTIONS] BASE_MODEL_FILE OTHER_MODEL_FILE
                          SYNC_INSTRUCTIONS_FILE

Options

-f, --output-file <output_file>

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

Arguments

BASE_MODEL_FILE

Required argument

OTHER_MODEL_FILE

Required argument

SYNC_INSTRUCTIONS_FILE

Required argument

l-shaped-plan

Create a model with an L-shaped floor plan.

Note that the resulting Rooms in the model won’t have any windows or solved adjacencies. The edit commands should be used for this purpose.

Args:
width_1: Number for the width of the lower part of the L segment.
length_1: Number for the length of the lower part of the L segment, not
counting the overlap between the upper and lower segments.
width_2: Number for the width of the upper (left) part of the L segment.
length_2: Number for the length of the upper (left) part of the L segment, not
counting the overlap between the upper and lower segments.
floor_to_floor_height: Number for the height of each floor of the model
(in the Z direction).
honeybee create l-shaped-plan [OPTIONS] WIDTH_1 LENGTH_1 WIDTH_2 LENGTH_2
                              FLOOR_TO_FLOOR_HEIGHT

Options

-p, --perimeter-offset <perimeter_offset>

An optional positive number that will be used to offset the perimeter to create core/perimeter Rooms. If this value is 0, no offset will occur and each floor will have one Room

Default

0

-s, --story-count <story_count>

An integer for the number of stories to generate.

Default

1

-a, --orientation-angle <orientation_angle>

A number between 0 and 360 for the counterclockwise orientation that the L faces.

Default

0

--outdoor-roof, -ar, --adiabatic-roof

Flag to note whether the roof faces of the top floor should be outdoor or adiabatic.

Default

True

--ground-floor, -af, --adiabatic-floor

Flag to note whether the floor faces of the bottom floor should be ground or adiabatic.

Default

True

-u, --units <units>

Text for the units system in which the model geometry exists. Must be (Meters, Millimeters, Feet, Inches, Centimeters).

Default

Meters

-t, --tolerance <tolerance>

The maximum difference between x, y, and z values at which vertices are considered equivalent.

-f, --output-file <output_file>

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

Arguments

WIDTH_1

Required argument

LENGTH_1

Required argument

WIDTH_2

Required argument

LENGTH_2

Required argument

FLOOR_TO_FLOOR_HEIGHT

Required argument

rectangle-plan

Create a model with a rectangular floor plan.

Note that the resulting Rooms in the model won’t have any windows or solved adjacencies. The edit commands should be used for this purpose.

Args:
width: Number for the width of the plan (in the X direction).
length: Number for the length of the plan (in the Y direction).
floor_to_floor_height: Number for the height of each floor of the model
(in the Z direction).
honeybee create rectangle-plan [OPTIONS] WIDTH LENGTH FLOOR_TO_FLOOR_HEIGHT

Options

-p, --perimeter-offset <perimeter_offset>

An optional positive number that will be used to offset the perimeter to create core/perimeter Rooms. If this value is 0, no offset will occur and each floor will have one Room

Default

0

-s, --story-count <story_count>

An integer for the number of stories to generate.

Default

1

-a, --orientation-angle <orientation_angle>

A number between 0 and 360 for the counterclockwise orientation that the width of the box faces.

Default

0

--outdoor-roof, -ar, --adiabatic-roof

Flag to note whether the roof faces of the top floor should be outdoor or adiabatic.

Default

True

--ground-floor, -af, --adiabatic-floor

Flag to note whether the floor faces of the bottom floor should be ground or adiabatic.

Default

True

-u, --units <units>

Text for the units system in which the model geometry exists. Must be (Meters, Millimeters, Feet, Inches, Centimeters).

Default

Meters

-t, --tolerance <tolerance>

The maximum difference between x, y, and z values at which vertices are considered equivalent.

-f, --output-file <output_file>

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

Arguments

WIDTH

Required argument

LENGTH

Required argument

FLOOR_TO_FLOOR_HEIGHT

Required argument

shoe-box

Create a model with a single shoe box Room.

Args:
width: Number for the width of the box (in the X direction).
depth: Number for the depth of the box (in the Y direction).
height: Number for the height of the box (in the Z direction).
honeybee create shoe-box [OPTIONS] WIDTH DEPTH HEIGHT

Options

-a, --orientation-angle <orientation_angle>

A number between 0 and 360 for the clockwise orientation of the box in degrees. (0=North, 90=East, 180=South, 270=West).

Default

0

-wr, --window-ratio <window_ratio>

A number between 0 and 1 (but not equal to 1) for the ratio between aperture area and area of the face pointing towards the orientation-angle. Using 0 will generate no windows

Default

0

--adiabatic, -o, --outdoors

Flag to note whether the faces that are not in the direction of the orientation-angle are adiabatic or outdoors.

Default

True

-u, --units <units>

Text for the units system in which the model geometry exists. Must be (Meters, Millimeters, Feet, Inches, Centimeters).

Default

Meters

-t, --tolerance <tolerance>

The maximum difference between x, y, and z values at which vertices are considered equivalent.

-f, --output-file <output_file>

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

Arguments

WIDTH

Required argument

DEPTH

Required argument

HEIGHT

Required argument