honeybee-core 1.62.6__py3-none-any.whl → 1.62.7__py3-none-any.whl

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.dist-info → honeybee_core-1.62.7.dist-info}/METADATA

@@ -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.dist-info → honeybee_core-1.62.7.dist-info}/RECORD

@@ -19,7 +19,7 @@ honeybee/logutil.py,sha256=2gn-6RcWqFLvwdFzBHPqUwFqTj_R3iwHKALrl-2eL7M,2564
 honeybee/model.py,sha256=YbTZJddBiLzeoivdR4QY7SqeZ_kIMVfWtuR_YwDG-j8,181203
 honeybee/orientation.py,sha256=GogGblASW9OU-fobfDaQ7w5yRbEAFdJJuHwg2fadhKI,5046
 honeybee/properties.py,sha256=ok976fbUdXzLDR2XiPNf8Q5ejfOM-PArqm5CVUbFiCc,34316
-honeybee/room.py,sha256=7_oLBQ0JJEQz55N57pqwL9HdVjtST4rHtcCkbupgrgs,157054
+honeybee/room.py,sha256=UYusFfJVHW5LBReuk1bSJDPAzjHqXaQRZdcGEjijb1k,158808
 honeybee/search.py,sha256=KOIeQjYdj0yhRWPmF5kiFiH8Ei0WbzuiU-capnwYVeM,5060
 honeybee/shade.py,sha256=HwLkOqvPpluLMXzicWXmKl4fMVJHmkqqehntT69e00Q,21026
 honeybee/shademesh.py,sha256=oldugnwhu-ibX9f0hfxpO-DvgM8U7S-dYwUjBSVzo4g,13273
@@ -40,9 +40,9 @@ honeybee/writer/model.py,sha256=N7F_jksf-5TrdVecuxTaFWxnPVFLmQs7k8g27TsdB7Q,177
 honeybee/writer/room.py,sha256=kFghgStTU1SEJSLigXB0VjOWhZtgs4uXuAqdwd4yRQo,174
 honeybee/writer/shade.py,sha256=EpgX-vMc-s21TnMvNWvWTKyT8iAnxu1nFVXzjY1oyF8,177
 honeybee/writer/shademesh.py,sha256=Y41bLogJ7dwpvMe5cAWVRDRVqJEwo9e5hFJQjlt6UX8,189
-honeybee_core-1.62.6.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-honeybee_core-1.62.6.dist-info/METADATA,sha256=UwPIpQX11k9oOLpyIcj3Cc3sw9O1IpjGSn1qEkRUS08,3729
-honeybee_core-1.62.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-honeybee_core-1.62.6.dist-info/entry_points.txt,sha256=r3YqOm40goBroH3ccUhpwQjvTwu10JWLd0HIRHI1J8E,47
-honeybee_core-1.62.6.dist-info/top_level.txt,sha256=8ve7puCRLUA9XDEGc1Mcs-UX9sFjpPV8MeTaIMwQ_Tg,9
-honeybee_core-1.62.6.dist-info/RECORD,,
+honeybee_core-1.62.7.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+honeybee_core-1.62.7.dist-info/METADATA,sha256=e0rzDj1uNs1-Dzzdw6y9l7Wd8VOXXEVAwDB9a4tc7wo,3729
+honeybee_core-1.62.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+honeybee_core-1.62.7.dist-info/entry_points.txt,sha256=r3YqOm40goBroH3ccUhpwQjvTwu10JWLd0HIRHI1J8E,47
+honeybee_core-1.62.7.dist-info/top_level.txt,sha256=8ve7puCRLUA9XDEGc1Mcs-UX9sFjpPV8MeTaIMwQ_Tg,9
+honeybee_core-1.62.7.dist-info/RECORD,,