honeybee package

Subpackages

• honeybee.cli package
  • Submodules
    • honeybee.cli.compare module
    • honeybee.cli.create module
    • honeybee.cli.edit module
    • honeybee.cli.lib module
    • honeybee.cli.setconfig module
    • honeybee.cli.validate module
  • Module contents
• honeybee.writer package
  • Submodules
    • honeybee.writer.aperture module
    • honeybee.writer.door module
    • honeybee.writer.face module
    • honeybee.writer.model module
    • honeybee.writer.room module
    • honeybee.writer.shade module
    • honeybee.writer.shademesh module
  • Module contents

Submodules

• honeybee.altnumber module
  • Autocalculate
    • Autocalculate.ToString()
    • Autocalculate.to_dict()
    • Autocalculate.name
  • NoLimit
    • NoLimit.ToString()
    • NoLimit.to_dict()
    • NoLimit.name
• honeybee.aperture module
  • Aperture
    • Aperture.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_COLORS
    • Aperture.TYPE_COLOR
    • Aperture.altitude
    • Aperture.area
    • Aperture.azimuth
    • Aperture.bc_color
    • Aperture.boundary_condition
    • Aperture.center
    • Aperture.display_name
    • Aperture.full_id
    • Aperture.geometry
    • Aperture.has_parent
    • Aperture.identifier
    • Aperture.indoor_shades
    • Aperture.is_operable
    • Aperture.max
    • Aperture.min
    • Aperture.normal
    • Aperture.outdoor_shades
    • Aperture.parent
    • Aperture.perimeter
    • Aperture.properties
    • Aperture.shades
    • Aperture.to
    • Aperture.top_level_parent
    • Aperture.triangulated_mesh3d
    • Aperture.type_color
    • Aperture.upper_left_vertices
    • Aperture.user_data
    • Aperture.vertices
• honeybee.boundarycondition module
  • Ground
    • Ground.ToString()
    • Ground.from_dict()
    • Ground.to_dict()
    • Ground.name
    • Ground.sun_exposure_idf
    • Ground.view_factor
    • Ground.wind_exposure_idf
  • Outdoors
    • Outdoors.ToString()
    • Outdoors.from_dict()
    • Outdoors.to_dict()
    • Outdoors.name
    • Outdoors.sun_exposure
    • Outdoors.sun_exposure_idf
    • Outdoors.view_factor
    • Outdoors.wind_exposure
    • Outdoors.wind_exposure_idf
  • Surface
    • Surface.ToString()
    • Surface.from_dict()
    • Surface.from_other_object()
    • Surface.to_dict()
    • Surface.boundary_condition_object
    • Surface.boundary_condition_objects
    • Surface.name
    • Surface.sun_exposure_idf
    • Surface.view_factor
    • Surface.wind_exposure_idf
  • get_bc_from_position()
• honeybee.checkdup module
  • check_duplicate_identifiers()
  • check_duplicate_identifiers_parent()
  • is_equivalent()
• honeybee.colorobj module
  • ColorFace
    • ColorFace.ToString()
    • ColorFace.attr_name
    • ColorFace.attr_name_end
    • ColorFace.attributes
    • ColorFace.attributes_original
    • ColorFace.attributes_unique
    • ColorFace.faces
    • ColorFace.flat_faces
    • ColorFace.flat_geometry
    • ColorFace.graphic_container
    • ColorFace.legend_parameters
    • ColorFace.max_point
    • ColorFace.min_point
  • ColorRoom
    • ColorRoom.ToString()
    • ColorRoom.attr_name
    • ColorRoom.attr_name_end
    • ColorRoom.attributes
    • ColorRoom.attributes_original
    • ColorRoom.attributes_unique
    • ColorRoom.floor_faces
    • ColorRoom.graphic_container
    • ColorRoom.legend_parameters
    • ColorRoom.max_point
    • ColorRoom.min_point
    • ColorRoom.rooms
• honeybee.config module
  • Folders
    • Folders.config_file
    • Folders.default_simulation_folder
    • Folders.default_standards_folder
    • Folders.honeybee_core_version
    • Folders.honeybee_core_version_str
    • Folders.honeybee_schema_version
    • Folders.honeybee_schema_version_str
    • Folders.python_exe_path
    • Folders.python_package_path
    • Folders.python_scripts_path
    • Folders.python_version
    • Folders.python_version_str
• honeybee.dictutil module
  • dict_to_object()
• honeybee.door module
  • Door
    • Door.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_COLORS
    • Door.TYPE_COLORS
    • Door.altitude
    • Door.area
    • Door.azimuth
    • Door.bc_color
    • Door.boundary_condition
    • Door.center
    • Door.display_name
    • Door.full_id
    • Door.geometry
    • Door.has_parent
    • Door.identifier
    • Door.indoor_shades
    • Door.is_glass
    • Door.max
    • Door.min
    • Door.normal
    • Door.outdoor_shades
    • Door.parent
    • Door.perimeter
    • Door.properties
    • Door.shades
    • Door.to
    • Door.top_level_parent
    • Door.triangulated_mesh3d
    • Door.type_color
    • Door.upper_left_vertices
    • Door.user_data
    • Door.vertices
• honeybee.extensionutil module
  • aperture_extension_dicts()
  • door_extension_dicts()
  • face_extension_dicts()
  • model_extension_dicts()
  • room_extension_dicts()
  • shade_extension_dicts()
• honeybee.face module
  • Face
    • Face.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.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.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_COLORS
    • Face.TYPES
    • Face.TYPE_COLORS
    • Face.altitude
    • Face.aperture_area
    • Face.aperture_ratio
    • Face.apertures
    • Face.area
    • Face.azimuth
    • Face.bc_color
    • Face.boundary_condition
    • Face.can_be_ground
    • Face.center
    • Face.display_name
    • Face.doors
    • Face.full_id
    • Face.geometry
    • Face.has_parent
    • Face.has_sub_faces
    • Face.identifier
    • Face.indoor_shades
    • Face.max
    • Face.min
    • Face.normal
    • Face.outdoor_shades
    • Face.parent
    • Face.perimeter
    • Face.properties
    • Face.punched_geometry
    • Face.punched_vertices
    • Face.shades
    • Face.sub_faces
    • Face.to
    • Face.type
    • Face.type_color
    • Face.upper_left_vertices
    • Face.user_data
    • Face.vertices
• honeybee.facetype module
  • AirBoundary
    • AirBoundary.ToString()
    • AirBoundary.name
  • Floor
    • Floor.ToString()
    • Floor.name
  • RoofCeiling
    • RoofCeiling.ToString()
    • RoofCeiling.name
  • Wall
    • Wall.ToString()
    • Wall.name
  • get_type_from_normal()
• honeybee.logutil module
  • get_logger()
• honeybee.model module
  • Model
    • Model.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_room_ids()
    • Model.rooms_by_identifier()
    • 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.UNITS
    • Model.UNITS_TOLERANCES
    • Model.angle_tolerance
    • Model.apertures
    • Model.display_name
    • Model.doors
    • Model.exposed_area
    • Model.exterior_aperture_area
    • Model.exterior_roof_area
    • Model.exterior_skylight_aperture_area
    • Model.exterior_wall_aperture_area
    • Model.exterior_wall_area
    • Model.faces
    • Model.floor_area
    • Model.full_id
    • Model.identifier
    • Model.indoor_shades
    • Model.max
    • Model.min
    • Model.orphaned_apertures
    • Model.orphaned_doors
    • Model.orphaned_faces
    • Model.orphaned_shades
    • Model.outdoor_shades
    • Model.properties
    • Model.rooms
    • Model.shade_meshes
    • Model.shades
    • Model.stories
    • Model.to
    • Model.tolerance
    • Model.top_level_dict
    • Model.units
    • Model.user_data
    • Model.volume
• honeybee.orientation module
  • angles_from_num_orient()
  • check_matching_inputs()
  • face_orient_index()
  • inputs_by_index()
  • orient_index()
• honeybee.properties module
  • ApertureProperties
    • ApertureProperties.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.host
  • DoorProperties
    • DoorProperties.ToString()
    • DoorProperties.add_prefix()
    • DoorProperties.is_equivalent()
    • DoorProperties.move()
    • DoorProperties.reflect()
    • DoorProperties.reset_to_default()
    • DoorProperties.rotate()
    • DoorProperties.rotate_xy()
    • DoorProperties.scale()
    • DoorProperties.to_dict()
    • DoorProperties.host
  • FaceProperties
    • FaceProperties.ToString()
    • FaceProperties.add_prefix()
    • FaceProperties.is_equivalent()
    • FaceProperties.move()
    • FaceProperties.reflect()
    • FaceProperties.reset_to_default()
    • FaceProperties.rotate()
    • FaceProperties.rotate_xy()
    • FaceProperties.scale()
    • FaceProperties.to_dict()
    • FaceProperties.host
  • ModelProperties
    • ModelProperties.ToString()
    • ModelProperties.apply_properties_from_dict()
    • ModelProperties.is_equivalent()
    • ModelProperties.move()
    • ModelProperties.reflect()
    • ModelProperties.rotate()
    • ModelProperties.rotate_xy()
    • ModelProperties.scale()
    • ModelProperties.to_dict()
    • ModelProperties.host
  • RoomProperties
    • RoomProperties.ToString()
    • RoomProperties.add_prefix()
    • RoomProperties.is_equivalent()
    • RoomProperties.move()
    • RoomProperties.reflect()
    • RoomProperties.reset_to_default()
    • RoomProperties.rotate()
    • RoomProperties.rotate_xy()
    • RoomProperties.scale()
    • RoomProperties.to_dict()
    • RoomProperties.host
  • ShadeMeshProperties
    • ShadeMeshProperties.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.host
  • ShadeProperties
    • ShadeProperties.ToString()
    • ShadeProperties.add_prefix()
    • ShadeProperties.is_equivalent()
    • ShadeProperties.move()
    • ShadeProperties.reflect()
    • ShadeProperties.reset_to_default()
    • ShadeProperties.rotate()
    • ShadeProperties.rotate_xy()
    • ShadeProperties.scale()
    • ShadeProperties.to_dict()
    • ShadeProperties.host
• honeybee.room module
  • Room
    • Room.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_boundaries
    • Room.apertures
    • Room.average_floor_height
    • Room.center
    • Room.display_name
    • Room.doors
    • Room.exclude_floor_area
    • Room.exposed_area
    • Room.exterior_aperture_area
    • Room.exterior_apertures
    • Room.exterior_roof_area
    • Room.exterior_skylight_aperture_area
    • Room.exterior_wall_aperture_area
    • Room.exterior_wall_area
    • Room.faces
    • Room.floor_area
    • Room.floors
    • Room.full_id
    • Room.geometry
    • Room.has_parent
    • Room.identifier
    • Room.indoor_furniture
    • Room.indoor_shades
    • Room.max
    • Room.min
    • Room.multiplier
    • Room.outdoor_shades
    • Room.properties
    • Room.roof_ceilings
    • Room.shades
    • Room.story
    • Room.to
    • Room.user_data
    • Room.volume
    • Room.walls
• honeybee.search module
  • any_keywords_in_string()
  • filter_array_by_keywords()
  • get_attr_nested()
• honeybee.shade module
  • Shade
    • Shade.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_COLOR
    • Shade.TYPE_COLORS
    • Shade.altitude
    • Shade.area
    • Shade.azimuth
    • Shade.bc_color
    • Shade.center
    • Shade.display_name
    • Shade.full_id
    • Shade.geometry
    • Shade.has_parent
    • Shade.identifier
    • Shade.is_detached
    • Shade.is_indoor
    • Shade.max
    • Shade.min
    • Shade.normal
    • Shade.parent
    • Shade.perimeter
    • Shade.properties
    • Shade.to
    • Shade.top_level_parent
    • Shade.type_color
    • Shade.upper_left_vertices
    • Shade.user_data
    • Shade.vertices
• honeybee.shademesh module
  • ShadeMesh
    • ShadeMesh.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_COLOR
    • ShadeMesh.TYPE_COLORS
    • ShadeMesh.area
    • ShadeMesh.bc_color
    • ShadeMesh.center
    • ShadeMesh.display_name
    • ShadeMesh.faces
    • ShadeMesh.full_id
    • ShadeMesh.geometry
    • ShadeMesh.identifier
    • ShadeMesh.is_detached
    • ShadeMesh.max
    • ShadeMesh.min
    • ShadeMesh.properties
    • ShadeMesh.to
    • ShadeMesh.type_color
    • ShadeMesh.user_data
    • ShadeMesh.vertices
• honeybee.typing module
  • clean_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_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()
  • truncate_and_id_string()
  • tuple_with_length()
  • valid_ep_string()
  • valid_rad_string()
  • valid_string()
  • wrapper
• honeybee.units module
  • conversion_factor_to_meters()
  • parse_distance_string()

Module contents

Honeybee core library.