honeybee
  • Site
      • CLI Docs
        • Installation
        • Commands
          • main
            • honeybee
              • config
              • viz
          • compare
            • honeybee compare
              • models
          • validate
            • honeybee validate
              • model
              • room-collisions
              • rooms-solid
          • setconfig
            • honeybee set-config
              • default-simulation-folder
          • edit
            • honeybee edit
              • convert-units
              • extruded-border
              • louvers-by-count
              • louvers-by-spacing
              • overhang
              • reset-resource-ids
              • solve-adjacency
              • windows-by-ratio
              • windows-by-ratio-rect
          • create
            • honeybee create
              • from-sync
              • l-shaped-plan
              • merge-models
              • rectangle-plan
              • shoe-box
          • lib
            • honeybee lib
              • purge
      • honeybee
        • 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
                  • validate_model()
                  • validate_room_collisions()
                  • validate_rooms_solid()
              • 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
                • ToString()
                • to_dict()
                • name
              • NoLimit
                • ToString()
                • to_dict()
                • name
            • honeybee.aperture module
              • Aperture
                • ToString()
                • add_indoor_shade()
                • add_indoor_shades()
                • add_outdoor_shade()
                • add_outdoor_shades()
                • add_prefix()
                • cardinal_direction()
                • check_degenerate()
                • 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_COLORS
                • TYPE_COLOR
                • altitude
                • area
                • azimuth
                • bc_color
                • boundary_condition
                • center
                • display_name
                • full_id
                • geometry
                • has_parent
                • identifier
                • indoor_shades
                • is_exterior
                • is_operable
                • max
                • min
                • normal
                • outdoor_shades
                • parent
                • perimeter
                • properties
                • shades
                • tilt
                • to
                • top_level_parent
                • triangulated_mesh3d
                • type_color
                • upper_left_vertices
                • user_data
                • vertices
            • honeybee.boundarycondition module
              • Ground
                • ToString()
                • from_dict()
                • to_dict()
                • name
                • sun_exposure_idf
                • view_factor
                • wind_exposure_idf
              • Outdoors
                • ToString()
                • from_dict()
                • to_dict()
                • name
                • sun_exposure
                • sun_exposure_idf
                • view_factor
                • wind_exposure
                • wind_exposure_idf
              • Surface
                • ToString()
                • from_dict()
                • from_other_object()
                • to_dict()
                • boundary_condition_object
                • boundary_condition_objects
                • name
                • sun_exposure_idf
                • view_factor
                • wind_exposure_idf
              • get_bc_from_position()
            • honeybee.checkdup module
              • check_duplicate_identifiers()
              • check_duplicate_identifiers_parent()
              • is_equivalent()
            • honeybee.colorobj module
              • ColorFace
                • ToString()
                • attr_name
                • attr_name_end
                • attributes
                • attributes_original
                • attributes_unique
                • faces
                • flat_faces
                • flat_geometry
                • graphic_container
                • legend_parameters
                • max_point
                • min_point
              • ColorRoom
                • ToString()
                • attr_name
                • attr_name_end
                • attributes
                • attributes_original
                • attributes_unique
                • floor_faces
                • graphic_container
                • legend_parameters
                • max_point
                • min_point
                • rooms
            • honeybee.config module
              • Folders
                • config_file
                • default_simulation_folder
                • default_standards_folder
                • honeybee_core_version
                • honeybee_core_version_str
                • honeybee_schema_version
                • honeybee_schema_version_str
                • python_exe_path
                • python_package_path
                • python_scripts_path
                • python_version
                • python_version_str
            • honeybee.dictutil module
              • dict_to_object()
            • honeybee.door module
              • Door
                • ToString()
                • add_indoor_shade()
                • add_indoor_shades()
                • add_outdoor_shade()
                • add_outdoor_shades()
                • add_prefix()
                • cardinal_direction()
                • check_degenerate()
                • 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_COLORS
                • TYPE_COLORS
                • altitude
                • area
                • azimuth
                • bc_color
                • boundary_condition
                • center
                • display_name
                • full_id
                • geometry
                • has_parent
                • identifier
                • indoor_shades
                • is_exterior
                • is_glass
                • max
                • min
                • normal
                • outdoor_shades
                • parent
                • perimeter
                • properties
                • shades
                • tilt
                • to
                • top_level_parent
                • triangulated_mesh3d
                • type_color
                • upper_left_vertices
                • user_data
                • 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
                • ToString()
                • 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_degenerate()
                • 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_COLORS
                • TYPES
                • TYPE_COLORS
                • altitude
                • aperture_area
                • aperture_ratio
                • apertures
                • area
                • azimuth
                • bc_color
                • boundary_condition
                • can_be_ground
                • center
                • display_name
                • doors
                • full_id
                • geometry
                • has_parent
                • has_sub_faces
                • identifier
                • indoor_shades
                • is_exterior
                • max
                • min
                • normal
                • outdoor_shades
                • parent
                • perimeter
                • properties
                • punched_geometry
                • punched_vertices
                • shades
                • sub_faces
                • tilt
                • to
                • type
                • type_color
                • upper_left_vertices
                • user_data
                • vertices
            • honeybee.facetype module
              • AirBoundary
                • ToString()
                • name
              • Floor
                • ToString()
                • name
              • RoofCeiling
                • ToString()
                • name
              • Wall
                • ToString()
                • name
              • get_type_from_normal()
            • honeybee.logutil module
              • get_logger()
            • honeybee.model module
              • Model
                • ToString()
                • 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()
                • UNITS
                • UNITS_TOLERANCES
                • angle_tolerance
                • apertures
                • display_name
                • doors
                • exposed_area
                • exterior_aperture_area
                • exterior_roof_area
                • exterior_skylight_aperture_area
                • exterior_wall_aperture_area
                • exterior_wall_area
                • faces
                • floor_area
                • full_id
                • grouped_shades
                • has_zones
                • identifier
                • indoor_shades
                • max
                • min
                • orphaned_apertures
                • orphaned_doors
                • orphaned_faces
                • orphaned_shades
                • outdoor_shades
                • properties
                • rooms
                • shade_meshes
                • shades
                • stories
                • to
                • tolerance
                • top_level_dict
                • units
                • user_data
                • volume
                • zone_dict
            • honeybee.orientation module
              • angles_from_num_orient()
              • check_matching_inputs()
              • face_orient_index()
              • inputs_by_index()
              • orient_index()
            • honeybee.properties module
              • ApertureProperties
                • ToString()
                • add_prefix()
                • is_equivalent()
                • move()
                • reflect()
                • reset_to_default()
                • rotate()
                • rotate_xy()
                • scale()
                • to_dict()
                • host
              • DoorProperties
                • ToString()
                • add_prefix()
                • is_equivalent()
                • move()
                • reflect()
                • reset_to_default()
                • rotate()
                • rotate_xy()
                • scale()
                • to_dict()
                • host
              • FaceProperties
                • ToString()
                • add_prefix()
                • is_equivalent()
                • move()
                • reflect()
                • reset_to_default()
                • rotate()
                • rotate_xy()
                • scale()
                • to_dict()
                • host
              • ModelProperties
                • ToString()
                • apply_properties_from_dict()
                • is_equivalent()
                • move()
                • reflect()
                • rotate()
                • rotate_xy()
                • scale()
                • to_dict()
                • host
              • RoomProperties
                • ToString()
                • add_prefix()
                • is_equivalent()
                • move()
                • reflect()
                • reset_to_default()
                • rotate()
                • rotate_xy()
                • scale()
                • to_dict()
                • host
              • ShadeMeshProperties
                • ToString()
                • add_prefix()
                • is_equivalent()
                • move()
                • reflect()
                • reset_to_default()
                • rotate()
                • rotate_xy()
                • scale()
                • to_dict()
                • host
              • ShadeProperties
                • ToString()
                • add_prefix()
                • is_equivalent()
                • move()
                • reflect()
                • reset_to_default()
                • rotate()
                • rotate_xy()
                • scale()
                • to_dict()
                • host
            • honeybee.room module
              • Room
                • ToString()
                • add_indoor_furniture()
                • add_indoor_shade()
                • add_indoor_shades()
                • add_outdoor_shade()
                • add_outdoor_shades()
                • add_prefix()
                • automatically_zone()
                • 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_attribute()
                • 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_boundaries
                • apertures
                • average_floor_height
                • center
                • display_name
                • doors
                • exclude_floor_area
                • exposed_area
                • exterior_aperture_area
                • exterior_apertures
                • exterior_roof_area
                • exterior_skylight_aperture_area
                • exterior_wall_aperture_area
                • exterior_wall_area
                • faces
                • floor_area
                • floors
                • full_id
                • geometry
                • has_parent
                • identifier
                • indoor_furniture
                • indoor_shades
                • max
                • min
                • multiplier
                • outdoor_shades
                • properties
                • roof_ceilings
                • shades
                • story
                • to
                • user_data
                • volume
                • walls
                • zone
            • honeybee.search module
              • any_keywords_in_string()
              • filter_array_by_keywords()
              • get_attr_nested()
            • honeybee.shade module
              • Shade
                • ToString()
                • 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_COLOR
                • TYPE_COLORS
                • altitude
                • area
                • azimuth
                • bc_color
                • center
                • display_name
                • full_id
                • geometry
                • has_parent
                • identifier
                • is_detached
                • is_indoor
                • max
                • min
                • normal
                • parent
                • perimeter
                • properties
                • tilt
                • to
                • top_level_parent
                • type_color
                • upper_left_vertices
                • user_data
                • vertices
            • honeybee.shademesh module
              • ShadeMesh
                • ToString()
                • add_prefix()
                • display_dict()
                • duplicate()
                • from_dict()
                • is_geo_equivalent()
                • move()
                • reflect()
                • rotate()
                • rotate_xy()
                • scale()
                • to_dict()
                • triangulate_and_remove_degenerate_faces()
                • BC_COLOR
                • TYPE_COLORS
                • area
                • bc_color
                • center
                • display_name
                • faces
                • full_id
                • geometry
                • identifier
                • is_detached
                • max
                • min
                • properties
                • to
                • type_color
                • user_data
                • 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_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
            • honeybee.units module
              • conversion_factor_to_meters()
              • parse_distance_string()
          • Module contents
  • Page
      • CLI Docs
      • honeybee
  • CLI Docs
  • honeybee

Python Module Index

h
 
h
- honeybee
    honeybee.altnumber
    honeybee.aperture
    honeybee.boundarycondition
    honeybee.checkdup
    honeybee.cli
    honeybee.cli.compare
    honeybee.cli.create
    honeybee.cli.edit
    honeybee.cli.lib
    honeybee.cli.setconfig
    honeybee.cli.validate
    honeybee.colorobj
    honeybee.config
    honeybee.dictutil
    honeybee.door
    honeybee.extensionutil
    honeybee.face
    honeybee.facetype
    honeybee.logutil
    honeybee.model
    honeybee.orientation
    honeybee.properties
    honeybee.room
    honeybee.search
    honeybee.shade
    honeybee.shademesh
    honeybee.typing
    honeybee.units
    honeybee.writer
    honeybee.writer.aperture
    honeybee.writer.door
    honeybee.writer.face
    honeybee.writer.model
    honeybee.writer.room
    honeybee.writer.shade
    honeybee.writer.shademesh

Back to top

© Copyright 2025, Ladybug Tools.
Created using Sphinx 8.0.2.