create¶
honeybee create¶
Commands for creating Honeybee models.
honeybee create [OPTIONS] COMMAND [ARGS]...
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.
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.
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.
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