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!
ApertureAperture.ToString()Aperture.add_indoor_shade()Aperture.add_indoor_shades()Aperture.add_outdoor_shade()Aperture.add_outdoor_shades()Aperture.add_prefix()Aperture.cardinal_direction()Aperture.check_planar()Aperture.check_self_intersecting()Aperture.display_dict()Aperture.duplicate()Aperture.extruded_border()Aperture.from_dict()Aperture.from_vertices()Aperture.horizontal_orientation()Aperture.is_geo_equivalent()Aperture.left_fin()Aperture.louvers_by_count()Aperture.louvers_by_distance_between()Aperture.move()Aperture.move_shades()Aperture.overhang()Aperture.reflect()Aperture.reflect_shades()Aperture.remove_colinear_vertices()Aperture.remove_indoor_shades()Aperture.remove_outdoor_shades()Aperture.remove_shades()Aperture.right_fin()Aperture.rotate()Aperture.rotate_shades()Aperture.rotate_xy()Aperture.rotate_xy_shades()Aperture.scale()Aperture.scale_shades()Aperture.set_adjacency()Aperture.to_dict()Aperture.BC_COLORSAperture.TYPE_COLORAperture.altitudeAperture.areaAperture.azimuthAperture.bc_colorAperture.boundary_conditionAperture.centerAperture.display_nameAperture.full_idAperture.geometryAperture.has_parentAperture.identifierAperture.indoor_shadesAperture.is_operableAperture.maxAperture.minAperture.normalAperture.outdoor_shadesAperture.parentAperture.perimeterAperture.propertiesAperture.shadesAperture.tiltAperture.toAperture.top_level_parentAperture.triangulated_mesh3dAperture.type_colorAperture.upper_left_verticesAperture.user_dataAperture.verticesColorFaceColorFace.ToString()ColorFace.attr_nameColorFace.attr_name_endColorFace.attributesColorFace.attributes_originalColorFace.attributes_uniqueColorFace.facesColorFace.flat_facesColorFace.flat_geometryColorFace.graphic_containerColorFace.legend_parametersColorFace.max_pointColorFace.min_pointColorRoom
FoldersFolders.config_fileFolders.default_simulation_folderFolders.default_standards_folderFolders.honeybee_core_versionFolders.honeybee_core_version_strFolders.honeybee_schema_versionFolders.honeybee_schema_version_strFolders.python_exe_pathFolders.python_package_pathFolders.python_scripts_pathFolders.python_versionFolders.python_version_strDoorDoor.ToString()Door.add_indoor_shade()Door.add_indoor_shades()Door.add_outdoor_shade()Door.add_outdoor_shades()Door.add_prefix()Door.cardinal_direction()Door.check_planar()Door.check_self_intersecting()Door.display_dict()Door.duplicate()Door.from_dict()Door.from_vertices()Door.horizontal_orientation()Door.is_geo_equivalent()Door.move()Door.move_shades()Door.overhang()Door.reflect()Door.reflect_shades()Door.remove_colinear_vertices()Door.remove_indoor_shades()Door.remove_outdoor_shades()Door.remove_shades()Door.rotate()Door.rotate_shades()Door.rotate_xy()Door.rotate_xy_shades()Door.scale()Door.scale_shades()Door.set_adjacency()Door.to_dict()Door.BC_COLORSDoor.TYPE_COLORSDoor.altitudeDoor.areaDoor.azimuthDoor.bc_colorDoor.boundary_conditionDoor.centerDoor.display_nameDoor.full_idDoor.geometryDoor.has_parentDoor.identifierDoor.indoor_shadesDoor.is_glassDoor.maxDoor.minDoor.normalDoor.outdoor_shadesDoor.parentDoor.perimeterDoor.propertiesDoor.shadesDoor.tiltDoor.toDoor.top_level_parentDoor.triangulated_mesh3dDoor.type_colorDoor.upper_left_verticesDoor.user_dataDoor.verticesFaceFace.ToString()Face.add_aperture()Face.add_apertures()Face.add_door()Face.add_doors()Face.add_indoor_shade()Face.add_indoor_shades()Face.add_outdoor_shade()Face.add_outdoor_shades()Face.add_prefix()Face.aperture_by_width_height()Face.apertures_by_ratio()Face.apertures_by_ratio_gridded()Face.apertures_by_ratio_rectangle()Face.apertures_by_width_height_rectangle()Face.cardinal_direction()Face.check_apertures_valid()Face.check_doors_valid()Face.check_planar()Face.check_self_intersecting()Face.check_sub_faces_overlapping()Face.check_sub_faces_valid()Face.check_upside_down()Face.display_dict()Face.duplicate()Face.fix_invalid_sub_faces()Face.from_dict()Face.from_vertices()Face.horizontal_orientation()Face.is_geo_equivalent()Face.louvers_by_count()Face.louvers_by_distance_between()Face.move()Face.move_shades()Face.offset_aperture_edges()Face.overhang()Face.rectangularize_apertures()Face.reflect()Face.reflect_shades()Face.remove_apertures()Face.remove_colinear_vertices()Face.remove_degenerate_sub_faces()Face.remove_doors()Face.remove_indoor_shades()Face.remove_outdoor_shades()Face.remove_shades()Face.remove_sub_faces()Face.replace_apertures()Face.rotate()Face.rotate_shades()Face.rotate_xy()Face.rotate_xy_shades()Face.scale()Face.scale_shades()Face.set_adjacency()Face.to_dict()Face.BC_COLORSFace.TYPESFace.TYPE_COLORSFace.altitudeFace.aperture_areaFace.aperture_ratioFace.aperturesFace.areaFace.azimuthFace.bc_colorFace.boundary_conditionFace.can_be_groundFace.centerFace.display_nameFace.doorsFace.full_idFace.geometryFace.has_parentFace.has_sub_facesFace.identifierFace.indoor_shadesFace.maxFace.minFace.normalFace.outdoor_shadesFace.parentFace.perimeterFace.propertiesFace.punched_geometryFace.punched_verticesFace.shadesFace.sub_facesFace.tiltFace.toFace.typeFace.type_colorFace.upper_left_verticesFace.user_dataFace.verticesModelModel.ToString()Model.add_aperture()Model.add_apertures()Model.add_door()Model.add_doors()Model.add_face()Model.add_faces()Model.add_model()Model.add_prefix()Model.add_room()Model.add_rooms()Model.add_shade()Model.add_shade_mesh()Model.add_shade_meshes()Model.add_shades()Model.apertures_by_identifier()Model.assign_stories_by_floor_height()Model.check_all()Model.check_all_air_boundaries_adjacent()Model.check_degenerate_rooms()Model.check_duplicate_face_identifiers()Model.check_duplicate_room_identifiers()Model.check_duplicate_shade_identifiers()Model.check_duplicate_shade_mesh_identifiers()Model.check_duplicate_sub_face_identifiers()Model.check_matching_adjacent_areas()Model.check_missing_adjacencies()Model.check_planar()Model.check_room_volume_collisions()Model.check_rooms_solid()Model.check_self_intersecting()Model.check_sub_faces_overlapping()Model.check_sub_faces_valid()Model.check_upside_down_faces()Model.comparison_report()Model.conversion_factor_to_meters()Model.convert_to_units()Model.display_dict()Model.doors_by_identifier()Model.duplicate()Model.faces_by_identifier()Model.from_dict()Model.from_file()Model.from_hbjson()Model.from_hbpkl()Model.from_l_shaped_plan()Model.from_objects()Model.from_rectangle_plan()Model.from_shoe_box()Model.from_stl()Model.from_sync()Model.from_sync_files()Model.generate_exterior_aperture_grid()Model.generate_exterior_face_grid()Model.move()Model.rectangularize_apertures()Model.reflect()Model.remove_all_apertures()Model.remove_all_doors()Model.remove_all_shades()Model.remove_apertures()Model.remove_assigned_apertures()Model.remove_assigned_doors()Model.remove_assigned_shades()Model.remove_degenerate_geometry()Model.remove_doors()Model.remove_faces()Model.remove_rooms()Model.remove_shade_meshes()Model.remove_shades()Model.reset_ids()Model.reset_room_ids()Model.rooms_by_identifier()Model.rooms_to_orphaned()Model.rotate()Model.rotate_xy()Model.scale()Model.shade_meshes_by_identifier()Model.shades_by_identifier()Model.simplify_apertures()Model.skylight_apertures_by_ratio()Model.solve_adjacency()Model.to_dict()Model.to_hbjson()Model.to_hbpkl()Model.to_stl()Model.triangulate_non_planar_quads()Model.triangulated_apertures()Model.triangulated_doors()Model.wall_apertures_by_ratio()Model.UNITSModel.UNITS_TOLERANCESModel.angle_toleranceModel.aperturesModel.display_nameModel.doorsModel.exposed_areaModel.exterior_aperture_areaModel.exterior_roof_areaModel.exterior_skylight_aperture_areaModel.exterior_wall_aperture_areaModel.exterior_wall_areaModel.facesModel.floor_areaModel.full_idModel.grouped_shadesModel.identifierModel.indoor_shadesModel.maxModel.minModel.orphaned_aperturesModel.orphaned_doorsModel.orphaned_facesModel.orphaned_shadesModel.outdoor_shadesModel.propertiesModel.roomsModel.shade_meshesModel.shadesModel.storiesModel.toModel.toleranceModel.top_level_dictModel.unitsModel.user_dataModel.volumeAperturePropertiesApertureProperties.ToString()ApertureProperties.add_prefix()ApertureProperties.is_equivalent()ApertureProperties.move()ApertureProperties.reflect()ApertureProperties.reset_to_default()ApertureProperties.rotate()ApertureProperties.rotate_xy()ApertureProperties.scale()ApertureProperties.to_dict()ApertureProperties.hostDoorProperties
FaceProperties
ModelProperties
RoomProperties
ShadeMeshPropertiesShadeMeshProperties.ToString()ShadeMeshProperties.add_prefix()ShadeMeshProperties.is_equivalent()ShadeMeshProperties.move()ShadeMeshProperties.reflect()ShadeMeshProperties.reset_to_default()ShadeMeshProperties.rotate()ShadeMeshProperties.rotate_xy()ShadeMeshProperties.scale()ShadeMeshProperties.to_dict()ShadeMeshProperties.hostShadeProperties
RoomRoom.ToString()Room.add_indoor_furniture()Room.add_indoor_shade()Room.add_indoor_shades()Room.add_outdoor_shade()Room.add_outdoor_shades()Room.add_prefix()Room.average_orientation()Room.check_degenerate()Room.check_planar()Room.check_room_volume_collisions()Room.check_self_intersecting()Room.check_solid()Room.check_sub_faces_overlapping()Room.check_sub_faces_valid()Room.check_upside_down_faces()Room.clean_envelope()Room.coplanar_split()Room.display_dict()Room.duplicate()Room.faces_by_guide_surface()Room.find_adjacency()Room.from_box()Room.from_dict()Room.from_polyface3d()Room.generate_exterior_aperture_grid()Room.generate_exterior_face_grid()Room.generate_grid()Room.ground_by_custom_surface()Room.group_by_adjacency()Room.group_by_air_boundary_adjacency()Room.group_by_floor_height()Room.group_by_orientation()Room.grouped_horizontal_boundary()Room.horizontal_boundary()Room.horizontal_floor_boundaries()Room.intersect_adjacency()Room.is_geo_equivalent()Room.merge_coplanar_faces()Room.move()Room.move_shades()Room.rectangularize_apertures()Room.reflect()Room.reflect_shades()Room.remove_colinear_vertices_envelope()Room.remove_indoor_furniture()Room.remove_indoor_shades()Room.remove_outdoor_shades()Room.remove_shades()Room.rooms_from_footprint()Room.rooms_from_l_shaped_plan()Room.rooms_from_rectangle_plan()Room.rotate()Room.rotate_shades()Room.rotate_xy()Room.rotate_xy_shades()Room.scale()Room.scale_shades()Room.simplify_apertures()Room.skylight_apertures_by_ratio()Room.solve_adjacency()Room.stories_by_floor_height()Room.to_dict()Room.wall_apertures_by_ratio()Room.air_boundariesRoom.aperturesRoom.average_floor_heightRoom.centerRoom.display_nameRoom.doorsRoom.exclude_floor_areaRoom.exposed_areaRoom.exterior_aperture_areaRoom.exterior_aperturesRoom.exterior_roof_areaRoom.exterior_skylight_aperture_areaRoom.exterior_wall_aperture_areaRoom.exterior_wall_areaRoom.facesRoom.floor_areaRoom.floorsRoom.full_idRoom.geometryRoom.has_parentRoom.identifierRoom.indoor_furnitureRoom.indoor_shadesRoom.maxRoom.minRoom.multiplierRoom.outdoor_shadesRoom.propertiesRoom.roof_ceilingsRoom.shadesRoom.storyRoom.toRoom.user_dataRoom.volumeRoom.wallsShadeShade.ToString()Shade.add_prefix()Shade.check_planar()Shade.check_self_intersecting()Shade.display_dict()Shade.duplicate()Shade.from_dict()Shade.from_vertices()Shade.is_geo_equivalent()Shade.move()Shade.reflect()Shade.remove_colinear_vertices()Shade.rotate()Shade.rotate_xy()Shade.scale()Shade.to_dict()Shade.BC_COLORShade.TYPE_COLORSShade.altitudeShade.areaShade.azimuthShade.bc_colorShade.centerShade.display_nameShade.full_idShade.geometryShade.has_parentShade.identifierShade.is_detachedShade.is_indoorShade.maxShade.minShade.normalShade.parentShade.perimeterShade.propertiesShade.tiltShade.toShade.top_level_parentShade.type_colorShade.upper_left_verticesShade.user_dataShade.verticesShadeMeshShadeMesh.ToString()ShadeMesh.add_prefix()ShadeMesh.display_dict()ShadeMesh.duplicate()ShadeMesh.from_dict()ShadeMesh.is_geo_equivalent()ShadeMesh.move()ShadeMesh.reflect()ShadeMesh.rotate()ShadeMesh.rotate_xy()ShadeMesh.scale()ShadeMesh.to_dict()ShadeMesh.triangulate_and_remove_degenerate_faces()ShadeMesh.BC_COLORShadeMesh.TYPE_COLORSShadeMesh.areaShadeMesh.bc_colorShadeMesh.centerShadeMesh.display_nameShadeMesh.facesShadeMesh.full_idShadeMesh.geometryShadeMesh.identifierShadeMesh.is_detachedShadeMesh.maxShadeMesh.minShadeMesh.propertiesShadeMesh.toShadeMesh.type_colorShadeMesh.user_dataShadeMesh.verticesclean_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