CLI Docs¶
Installation¶
To check if the Honeybee command line interface is installed correctly try honeybee viz and you
should get a viiiiiiiiiiiiizzzzzzzzz! back in response!
ApertureToString()add_indoor_shade()add_indoor_shades()add_outdoor_shade()add_outdoor_shades()add_prefix()cardinal_direction()check_planar()check_self_intersecting()display_dict()duplicate()extruded_border()from_dict()from_vertices()horizontal_orientation()is_geo_equivalent()left_fin()louvers()louvers_by_count()louvers_by_distance_between()move()move_shades()overhang()reflect()reflect_shades()remove_colinear_vertices()remove_indoor_shades()remove_outdoor_shades()remove_shades()right_fin()rotate()rotate_shades()rotate_xy()rotate_xy_shades()scale()scale_shades()set_adjacency()to_dict()BC_COLORSTYPE_COLORaltitudeareaazimuthbc_colorboundary_conditioncenterdisplay_namefull_idgeometryhas_parentidentifierindoor_shadesis_exterioris_operablemaxminnormaloutdoor_shadesparentperimeterpropertiesshadestilttotop_level_parenttriangulated_mesh3dtype_colorupper_left_verticesuser_dataverticesDoorToString()add_indoor_shade()add_indoor_shades()add_outdoor_shade()add_outdoor_shades()add_prefix()cardinal_direction()check_planar()check_self_intersecting()display_dict()duplicate()from_dict()from_vertices()horizontal_orientation()is_geo_equivalent()move()move_shades()overhang()reflect()reflect_shades()remove_colinear_vertices()remove_indoor_shades()remove_outdoor_shades()remove_shades()rotate()rotate_shades()rotate_xy()rotate_xy_shades()scale()scale_shades()set_adjacency()to_dict()BC_COLORSTYPE_COLORSaltitudeareaazimuthbc_colorboundary_conditioncenterdisplay_namefull_idgeometryhas_parentidentifierindoor_shadesis_exterioris_glassmaxminnormaloutdoor_shadesparentperimeterpropertiesshadestilttotop_level_parenttriangulated_mesh3dtype_colorupper_left_verticesuser_dataverticesFaceToString()add_aperture()add_apertures()add_door()add_doors()add_indoor_shade()add_indoor_shades()add_outdoor_shade()add_outdoor_shades()add_prefix()add_sub_face()add_sub_faces()aperture_by_width_height()apertures_by_ratio()apertures_by_ratio_gridded()apertures_by_ratio_rectangle()apertures_by_width_height_rectangle()cardinal_direction()check_apertures_valid()check_doors_valid()check_planar()check_self_intersecting()check_sub_faces_overlapping()check_sub_faces_valid()check_upside_down()display_dict()duplicate()fix_invalid_sub_faces()from_dict()from_vertices()horizontal_orientation()is_geo_equivalent()louvers()louvers_by_count()louvers_by_distance_between()merge_neighboring_sub_faces()move()move_shades()offset_aperture_edges()overhang()project_and_add_sub_face()rectangularize_apertures()reflect()reflect_shades()remove_apertures()remove_colinear_vertices()remove_degenerate_sub_faces()remove_doors()remove_indoor_shades()remove_outdoor_shades()remove_shades()remove_sub_faces()replace_apertures()rotate()rotate_shades()rotate_xy()rotate_xy_shades()scale()scale_shades()set_adjacency()to_dict()BC_COLORSTYPESTYPE_COLORSaltitudeaperture_areaaperture_ratioaperturesareaazimuthbc_colorboundary_conditioncan_be_groundcenterdisplay_namedoorsfull_idgeometryhas_parenthas_sub_facesidentifierindoor_shadesis_exteriormaxminnormaloutdoor_shadesparentperimeterpropertiespunched_geometrypunched_verticesshadessub_facestilttotypetype_colorupper_left_verticesuser_dataverticesModelToString()add_aperture()add_apertures()add_door()add_doors()add_face()add_faces()add_model()add_prefix()add_room()add_rooms()add_shade()add_shade_mesh()add_shade_meshes()add_shades()apertures_by_identifier()assign_stories_by_floor_height()check_all()check_all_air_boundaries_adjacent()check_all_duplicate_identifiers()check_degenerate_rooms()check_duplicate_face_identifiers()check_duplicate_room_identifiers()check_duplicate_shade_identifiers()check_duplicate_shade_mesh_identifiers()check_duplicate_sub_face_identifiers()check_for_extension()check_matching_adjacent_areas()check_missing_adjacencies()check_planar()check_room_volume_collisions()check_rooms_solid()check_self_intersecting()check_sub_faces_overlapping()check_sub_faces_valid()check_upside_down_faces()comparison_report()conversion_factor_to_meters()convert_to_units()display_dict()doors_by_identifier()duplicate()faces_by_identifier()from_dict()from_file()from_hbjson()from_hbpkl()from_l_shaped_plan()from_objects()from_rectangle_plan()from_shoe_box()from_stl()from_sync()from_sync_files()generate_exterior_aperture_grid()generate_exterior_face_grid()move()rectangularize_apertures()reflect()remove_all_apertures()remove_all_doors()remove_all_shades()remove_apertures()remove_assigned_apertures()remove_assigned_doors()remove_assigned_shades()remove_degenerate_geometry()remove_doors()remove_faces()remove_rooms()remove_shade_meshes()remove_shades()reset_ids()reset_room_ids()rooms_by_identifier()rooms_to_extrusions()rooms_to_orphaned()rotate()rotate_xy()scale()shade_meshes_by_identifier()shades_by_identifier()simplify_apertures()skylight_apertures_by_ratio()solve_adjacency()split_rooms_through_holes()to_dict()to_hbjson()to_hbpkl()to_stl()triangulate_non_planar_quads()triangulated_apertures()triangulated_doors()validate()wall_apertures_by_ratio()UNITSUNITS_TOLERANCESangle_toleranceaperturesdisplay_namedoorsexposed_areaexterior_aperture_areaexterior_roof_areaexterior_skylight_aperture_areaexterior_wall_aperture_areaexterior_wall_areafacesfloor_areafull_idgrouped_shadeshas_zonesidentifierindoor_shadesmaxminorphaned_aperturesorphaned_doorsorphaned_facesorphaned_shadesoutdoor_shadespropertiesroomsshade_meshesshadesstoriestotolerancetop_level_dictunitsuser_datavolumezone_dictRoomToString()add_indoor_furniture()add_indoor_shade()add_indoor_shades()add_outdoor_shade()add_outdoor_shades()add_prefix()average_orientation()check_degenerate()check_planar()check_room_volume_collisions()check_self_intersecting()check_solid()check_sub_faces_overlapping()check_sub_faces_valid()check_upside_down_faces()clean_envelope()coplanar_split()display_dict()duplicate()faces_by_guide_surface()find_adjacency()from_box()from_dict()from_polyface3d()generate_exterior_aperture_grid()generate_exterior_face_grid()generate_grid()ground_by_custom_surface()group_by_adjacency()group_by_air_boundary_adjacency()group_by_floor_height()group_by_orientation()grouped_horizontal_boundary()horizontal_boundary()horizontal_floor_boundaries()intersect_adjacency()is_extrusion()is_geo_equivalent()merge_coplanar_faces()move()move_shades()rectangularize_apertures()reflect()reflect_shades()remove_colinear_vertices_envelope()remove_indoor_furniture()remove_indoor_shades()remove_outdoor_shades()remove_shades()rooms_from_footprint()rooms_from_l_shaped_plan()rooms_from_rectangle_plan()rotate()rotate_shades()rotate_xy()rotate_xy_shades()scale()scale_shades()simplify_apertures()skylight_apertures_by_ratio()solve_adjacency()split_through_holes()stories_by_floor_height()to_dict()to_extrusion()wall_apertures_by_ratio()air_boundariesaperturesaverage_floor_heightcenterdisplay_namedoorsexclude_floor_areaexposed_areaexterior_aperture_areaexterior_aperturesexterior_roof_areaexterior_skylight_aperture_areaexterior_wall_aperture_areaexterior_wall_areafacesfloor_areafloorsfull_idgeometryhas_parentidentifierindoor_furnitureindoor_shadesmaxminmultiplieroutdoor_shadespropertiesroof_ceilingsshadesstorytouser_datavolumewallszoneShadeToString()add_prefix()check_planar()check_self_intersecting()display_dict()duplicate()from_dict()from_vertices()is_geo_equivalent()move()reflect()remove_colinear_vertices()rotate()rotate_xy()scale()to_dict()BC_COLORTYPE_COLORSaltitudeareaazimuthbc_colorcenterdisplay_namefull_idgeometryhas_parentidentifieris_detachedis_indoormaxminnormalparentperimeterpropertiestilttotop_level_parenttype_colorupper_left_verticesuser_dataverticesShadeMeshToString()add_prefix()display_dict()duplicate()from_dict()is_geo_equivalent()move()reflect()rotate()rotate_xy()scale()to_dict()triangulate_and_remove_degenerate_faces()BC_COLORTYPE_COLORSareabc_colorcenterdisplay_namefacesfull_idgeometryidentifieris_detachedmaxminpropertiestotype_coloruser_dataverticesclean_and_id_ep_string()clean_and_id_rad_string()clean_and_id_string()clean_and_number_ep_string()clean_and_number_rad_string()clean_and_number_string()clean_doe2_string()clean_ep_string()clean_rad_string()clean_string()fixed_string_length()float_in_range()float_in_range_excl()float_in_range_excl_incl()float_in_range_incl_excl()float_positive()int_in_range()int_positive()invalid_dict_error()list_with_length()normpath()readable_short_name()truncate_and_id_string()tuple_with_length()valid_ep_string()valid_rad_string()valid_string()wrapper