honeybee-core 1.62.6__tar.gz → 1.62.7__tar.gz

{honeybee_core-1.62.6/honeybee_core.egg-info → honeybee_core-1.62.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: honeybee-core
-Version: 1.62.6
+Version: 1.62.7
 Summary: A library to create 3D building geometry for various types of environmental simulation.
 Home-page: https://github.com/ladybug-tools/honeybee-core
 Author: Ladybug Tools

{honeybee_core-1.62.6 → honeybee_core-1.62.7}/honeybee/room.py

@@ -2339,6 +2339,49 @@ class Room(_BaseWithShade):
                 floor_heights.append(flrh)
         return grouped_rooms, floor_heights
 
+    @staticmethod
+    def group_by_story(rooms):
+        """Group Rooms according to their story property.
+
+        The returned room groups will be sorted from the lowest average floor
+        to the highest average floor height.
+
+        Args:
+            rooms: A list of honeybee rooms to be grouped by story.
+
+        Returns:
+            A tuple with three items.
+
+            -   grouped_rooms - A list of lists of honeybee rooms with each sub-list
+                representing a different story.
+
+            -   story_names - A list of story names with one value for each
+                sub-list of the output grouped_rooms.
+
+            -   floor_heights - A list of floor heights with one floor height
+                for each sub-list of the output grouped_rooms.
+        """
+        # group the rooms by story
+        story_dict = {}
+        for room in rooms:
+            try:
+                story_dict[room.story].append(room)
+            except KeyError:
+                story_dict[room.story] = [room]
+        # sort the stories by average floor height
+        grouped_rooms, story_names, floor_heights = [], [], []
+        for s_name, g_rooms in story_dict.items():
+            grouped_rooms.append(g_rooms)
+            story_names.append(s_name)
+            weighted_sum = sum(r.average_floor_height * r.floor_area for r in g_rooms)
+            total_area = sum(r.floor_area for r in g_rooms)
+            avg_flr = weighted_sum / total_area
+            floor_heights.append(avg_flr)
+        zip_obj = zip(floor_heights, grouped_rooms, story_names)
+        floor_heights, grouped_rooms, story_names = \
+            (list(t) for t in zip(*sorted(zip_obj, key=lambda x: x[0])))
+        return grouped_rooms, story_names, floor_heights
+
     @staticmethod
     def stories_by_floor_height(rooms, min_difference=2.0):
         """Assign story properties to a set of Rooms using their floor heights.

{honeybee_core-1.62.6 → honeybee_core-1.62.7/honeybee_core.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: honeybee-core
-Version: 1.62.6
+Version: 1.62.7
 Summary: A library to create 3D building geometry for various types of environmental simulation.
 Home-page: https://github.com/ladybug-tools/honeybee-core
 Author: Ladybug Tools

{honeybee_core-1.62.6 → honeybee_core-1.62.7}/tests/room_test.py

@@ -714,6 +714,41 @@ def test_group_by_orientation():
     assert orientations == [0.0, 90.0, 180.0, 270.0]
 
 
+def test_group_by_story():
+    """Test the group_by_story method."""
+    pts_1 = (Point3D(0, 0), Point3D(15, 0), Point3D(10, 5), Point3D(5, 5))
+    pts_2 = (Point3D(15, 0), Point3D(15, 15), Point3D(10, 10), Point3D(10, 5))
+    pts_3 = (Point3D(0, 15), Point3D(5, 10), Point3D(10, 10), Point3D(15, 15))
+    pts_4 = (Point3D(0, 0), Point3D(5, 5), Point3D(5, 10), Point3D(0, 15))
+    pts_5 = (Point3D(5, 5), Point3D(10, 5), Point3D(10, 10), Point3D(5, 10))
+    pf_1 = Polyface3D.from_offset_face(Face3D(pts_1), 3)
+    pf_2 = Polyface3D.from_offset_face(Face3D(pts_2), 3)
+    pf_3 = Polyface3D.from_offset_face(Face3D(pts_3), 3)
+    pf_4 = Polyface3D.from_offset_face(Face3D(pts_4), 3)
+    pf_5 = Polyface3D.from_offset_face(Face3D(pts_5), 3)
+    room_1 = Room.from_polyface3d('Zone1', pf_1)
+    room_2 = Room.from_polyface3d('Zone2', pf_2)
+    room_3 = Room.from_polyface3d('Zone3', pf_3)
+    room_4 = Room.from_polyface3d('Zone4', pf_4)
+    room_5 = Room.from_polyface3d('Zone5', pf_5)
+    rooms = [room_1, room_2, room_3, room_4, room_5]
+    for rm in rooms:
+        rm.story = 'Ground Floor'
+
+    rooms_basement = [rm.duplicate() for rm in rooms]
+    for rm in rooms_basement:
+        rm.move(Vector3D(0, 0, -3))
+        rm.add_prefix('Basement')
+        rm.story = 'Basement'
+    Room.solve_adjacency(rooms, 0.01)
+    all_rooms = rooms + rooms_basement
+
+    grouped_rooms, story_names, floor_heights = Room.group_by_story(all_rooms)
+    assert floor_heights == [-3.0, 0.0]
+    assert story_names == ['Basement', 'Ground Floor']
+    assert len(grouped_rooms[0]) == 5
+
+
 def test_horizontal_boundary():
     """Test the horizontal_boundary method for a variety of shapes."""
     geo_file = './tests/json/complex_polyfaces.json'