honeybee-grasshopper-radiance 1.35.2__py3-none-any.whl → 1.35.3__py3-none-any.whl

honeybee_grasshopper_radiance/src/HB Annual Statistics.py

@@ -0,0 +1,187 @@
+# Honeybee: A Plugin for Environmental Analysis (GPL)
+# This file is part of Honeybee.
+#
+# Copyright (c) 2025, Ladybug Tools.
+# You should have received a copy of the GNU Affero General Public License
+# along with Honeybee; If not, see <http://www.gnu.org/licenses/>.
+# 
+# @license AGPL-3.0-or-later <https://spdx.org/licenses/AGPL-3.0-or-later>
+
+"""
+Calculate typical statistics (Average, median, minimum, maximum, sum) for an
+annual daylight or irradiance simulation.
+
+Statistics can either be computed per sensor or per timestep.
+
+-
+    Args:
+        _results: An list of annual Radiance result files from the "HB Annual Daylight"
+            component (containing the .ill files and the sun-up-hours.txt).
+            This can also be just the path to the folder containing these
+            result files.
+        dyn_sch_: Optional dynamic Aperture Group Schedules from the "HB Aperture Group
+            Schedule" component, which will be used to customize the behavior
+            of any dyanmic aperture geometry in the output metrics. If unsupplied,
+            all dynamic aperture groups will be in their default state in for
+            the output metrics.
+        _hoys_: An optional numbers or list of numbers to select the hours of the year (HOYs)
+            for which results will be computed. These HOYs can be obtained from the
+            "LB Calculate HOY" or the "LB Analysis Period" components. If None, all
+            hours of the results will be used.
+        grid_filter_: The name of a grid or a pattern to filter the grids. For instance,
+            first_floor_* will simulate only the sensor grids that have an
+            identifier that starts with first_floor_. By default all the grids
+            will be processed.
+        per_timestep_: Set to True to calculate statistics per-timestep instead of per-sensor.
+            (Default: False)
+
+    Returns:
+        report: Reports, errors, warnings, etc.
+        average: Average illuminance or irradiance values for each sensor or timestep
+            in lux or W/m2. This is either a list of values or a list of data collections
+            if per_timestep_ is True.
+        median: Median illuminance or irradiance values for each sensor or timestep
+            in lux or W/m2. This is either a list of values or a list of data collections
+            if per_timestep_ is True.
+        minimum: Minimum illuminance or irradiance values for each sensor or timestep
+            in lux or W/m2. This is either a list of values or a list of data collections
+            if per_timestep_ is True.
+        maximum: Maximum illuminance or irradiance values for each sensor or timestep
+            in lux or W/m2. This is either a list of values or a list of data collections
+            if per_timestep_ is True.
+        cumulative: Cumulative illuminance or irradiance values for each sensor or timestep
+            in lux or W/m2. This is either a list of values or a list of data collections
+            if per_timestep_ is True.
+"""
+
+ghenv.Component.Name = "HB Annual Statistics"
+ghenv.Component.NickName = 'AnnualStatistics'
+ghenv.Component.Message = '1.9.0'
+ghenv.Component.Category = 'HB-Radiance'
+ghenv.Component.SubCategory = '4 :: Results'
+ghenv.Component.AdditionalHelpFromDocStrings = '2'
+
+import os
+import json
+import subprocess
+
+try:
+    from ladybug.datacollection import HourlyContinuousCollection
+    from ladybug.futil import write_to_file
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug:\n\t{}'.format(e))
+
+try:
+    from honeybee.config import folders
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee:\n\t{}'.format(e))
+
+try:
+    from honeybee_radiance_postprocess.dynamic import DynamicSchedule
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee_radiance:\n\t{}'.format(e))
+
+try:
+    from pollination_handlers.outputs.helper import read_sensor_grid_result
+except ImportError as e:
+    raise ImportError('\nFailed to import pollination_handlers:\n\t{}'.format(e))
+
+try:
+    from ladybug_rhino.grasshopper import all_required_inputs, list_to_data_tree,   \
+        give_warning
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug_rhino:\n\t{}'.format(e))
+
+
+if all_required_inputs(ghenv.Component):
+    # compute the annual summary
+    grid_filter_ = '*' if grid_filter_ is None else grid_filter_
+    res_folder = _results
+    per_timestep = False if per_timestep_ is None else per_timestep_
+    
+    # check to see if results use the newer numpy arrays
+    if os.path.isdir(os.path.join(res_folder, '__static_apertures__')) or \
+        os.path.isfile(os.path.join(res_folder, 'grid_states.json')):
+        cmds = [folders.python_exe_path, '-m', 'honeybee_radiance_postprocess',
+                'post-process', 'annual-statistics', res_folder, '-sf',
+                'statistics']
+        if len(_hoys_) != 0:
+            hoys_str = '\n'.join(str(h) for h in _hoys_)
+            hoys_file = os.path.join(res_folder, 'hoys.txt')
+            write_to_file(hoys_file, hoys_str)
+            cmds.extend(['--hoys-file', hoys_file])
+        if grid_filter_ != '*':
+            cmds.extend(['--grids-filter', grid_filter_])
+        if len(dyn_sch_) != 0:
+            if os.path.isfile(os.path.join(res_folder, 'grid_states.json')):
+                dyn_sch = dyn_sch_[0] if isinstance(dyn_sch_[0], DynamicSchedule) else \
+                    DynamicSchedule.from_group_schedules(dyn_sch_)
+                dyn_sch_file = dyn_sch.to_json(folder=res_folder)
+                cmds.extend(['--states', dyn_sch_file])
+            else:
+                msg = 'No dynamic aperture groups were found in the Model.\n' \
+                    'The input dynamic schedules will be ignored.'
+                print(msg)
+                give_warning(ghenv.Component, msg)
+        
+        if per_timestep:
+            cmds.extend(['--timestep'])
+        
+        use_shell = True if os.name == 'nt' else False
+        custom_env = os.environ.copy()
+        custom_env['PYTHONHOME'] = ''
+        process = subprocess.Popen(
+            cmds, cwd=res_folder, shell=use_shell, env=custom_env,
+            stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        stdout = process.communicate()  # wait for the process to finish
+        if stdout[-1] != '':
+            print(stdout[-1])
+            raise ValueError('Failed to compute {} values.'.format(res_type))
+        
+        res_dir = os.path.join(res_folder, 'statistics')
+        average_values_dir = os.path.join(res_dir, 'average_values')
+        median_values_dir = os.path.join(res_dir, 'median_values')
+        minimum_values_dir = os.path.join(res_dir, 'minimum_values')
+        maximum_values_dir = os.path.join(res_dir, 'maximum_values')
+        cumulative_values_dir = os.path.join(res_dir, 'cumulative_values')
+        
+        if per_timestep is False:
+            average = list_to_data_tree(read_sensor_grid_result(average_values_dir, 'average', 'full_id', False))
+            median = list_to_data_tree(read_sensor_grid_result(median_values_dir, 'median', 'full_id', False))
+            minimum = list_to_data_tree(read_sensor_grid_result(minimum_values_dir, 'minimum', 'full_id', False))
+            maximum = list_to_data_tree(read_sensor_grid_result(maximum_values_dir, 'maximum', 'full_id', False))
+            cumulative = list_to_data_tree(read_sensor_grid_result(cumulative_values_dir, 'cumulative', 'full_id', False))
+        else:
+            with open(os.path.join(average_values_dir, 'grids_info.json')) as json_file:
+                grids_info = json.load(json_file)
+            average = []
+            median = []
+            minimum = []
+            maximum = []
+            cumulative = []
+            for grid_info in grids_info:
+                with open(os.path.join(average_values_dir, '{}_average.json'.format(grid_info['full_id']))) as json_file:
+                    data_dict = json.load(json_file)
+                average.append(HourlyContinuousCollection.from_dict(data_dict))
+                with open(os.path.join(median_values_dir, '{}_median.json'.format(grid_info['full_id']))) as json_file:
+                    data_dict = json.load(json_file)
+                median.append(HourlyContinuousCollection.from_dict(data_dict))
+                with open(os.path.join(minimum_values_dir, '{}_minimum.json'.format(grid_info['full_id']))) as json_file:
+                    data_dict = json.load(json_file)
+                minimum.append(HourlyContinuousCollection.from_dict(data_dict))
+                with open(os.path.join(maximum_values_dir, '{}_maximum.json'.format(grid_info['full_id']))) as json_file:
+                    data_dict = json.load(json_file)
+                maximum.append(HourlyContinuousCollection.from_dict(data_dict))
+                with open(os.path.join(cumulative_values_dir, '{}_cumulative.json'.format(grid_info['full_id']))) as json_file:
+                    data_dict = json.load(json_file)
+                cumulative.append(HourlyContinuousCollection.from_dict(data_dict))
+            average = list_to_data_tree(average)
+            median = list_to_data_tree(median)
+            minimum = list_to_data_tree(minimum)
+            maximum = list_to_data_tree(maximum)
+            cumulative = list_to_data_tree(cumulative)
+    else:
+        msg = 'Summary is only only supported for Annual Daylight and Annual Irradiance ' \
+            'simulations with NumPy arrays.'
+        print(msg)
+        give_warning(ghenv.Component, msg)

{honeybee_grasshopper_radiance-1.35.2.dist-info → honeybee_grasshopper_radiance-1.35.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: honeybee-grasshopper-radiance
-Version: 1.35.2
+Version: 1.35.3
 Summary: Honeybee Radiance plugin for Grasshopper.
 Home-page: https://github.com/ladybug-tools/honeybee-grasshopper-radiance
 Author: Ladybug Tools

{honeybee_grasshopper_radiance-1.35.2.dist-info → honeybee_grasshopper_radiance-1.35.3.dist-info}/RECORD

@@ -9,6 +9,7 @@ honeybee_grasshopper_radiance/src/HB Annual Glare Metrics.py,sha256=Uu-aqGjt3jlI
 honeybee_grasshopper_radiance/src/HB Annual Irradiance.py,sha256=siIRkhWb2i_wgZamlJGKktkgZ7CPi7qsML13Slti3Y4,6032
 honeybee_grasshopper_radiance/src/HB Annual Peak Values.py,sha256=x-q1Y6tUTsOovB5C6Y2E47L9XpSPE-Jv0WAY5Rdtim0,10002
 honeybee_grasshopper_radiance/src/HB Annual Results to Data.py,sha256=4HeXXyOFVQEBz60g4vC4f404BKjqmowUX6YZWNKzhvA,11021
+honeybee_grasshopper_radiance/src/HB Annual Statistics.py,sha256=HGDZuvqHjjv77yA0HDjYdYESoXEQ5XRqkDE6498b1YQ,9526
 honeybee_grasshopper_radiance/src/HB Annual Sunlight Exposure.py,sha256=NlJefTSQofAIZrlG_PClFhYdXhfE_rChH81mRW9Gr0w,6393
 honeybee_grasshopper_radiance/src/HB Aperture Group Schedule.py,sha256=nL0lSzHEDI9iBGRSJODFAC1xDPu-GxTNIxGKa4qu7a8,3052
 honeybee_grasshopper_radiance/src/HB Apply Face Modifier.py,sha256=Hl73JhJpvQR052x0TRjJvp0CQ84VwaBBeQijVw9QhWY,4475
@@ -90,6 +91,7 @@ honeybee_grasshopper_radiance/user_objects/HB Annual Glare Metrics.ghuser,sha256
 honeybee_grasshopper_radiance/user_objects/HB Annual Irradiance.ghuser,sha256=w1r_ZZqRwsjTv6hw06xjc86uD_-mCIO-y9rbQS09eL4,7347
 honeybee_grasshopper_radiance/user_objects/HB Annual Peak Values.ghuser,sha256=9OM0F7Po7CuKPbxLNIvh-G_IxDKddhdelIYaq6K7j8Y,7127
 honeybee_grasshopper_radiance/user_objects/HB Annual Results to Data.ghuser,sha256=bQ9T5VAVir1Cb7CynWMNmJSAz-bk6S57z0IwKILq6hs,7147
+honeybee_grasshopper_radiance/user_objects/HB Annual Statistics.ghuser,sha256=4IY2aovV99kob3iPTTlVgLJ9ZjFaY_sN2Y5ZX1OLomQ,6733
 honeybee_grasshopper_radiance/user_objects/HB Annual Sunlight Exposure.ghuser,sha256=SoeX9wjEJH1BJbDwGpdyuqeJO8EK2LLjskYRprIL_xI,5578
 honeybee_grasshopper_radiance/user_objects/HB Aperture Group Schedule.ghuser,sha256=7-tSPfPcf4DkuQGBv3MruJOnlffX8g0pf5_GRW1brHw,5178
 honeybee_grasshopper_radiance/user_objects/HB Apply Face Modifier.ghuser,sha256=tDRYfk6OGwxzvkilbeLX7QwY95W-l9sveozSc2Xb2Ys,4978
@@ -163,8 +165,8 @@ honeybee_grasshopper_radiance/user_objects/HB Wea From EPW.ghuser,sha256=PcjwWzO
 honeybee_grasshopper_radiance/user_objects/HB Wea From Tau Clear Sky.ghuser,sha256=du9nzM95d3uL2-1sf1fFll_QfRloVaL4Q_JGd7Nb5NI,5367
 honeybee_grasshopper_radiance/user_objects/HB Wea from Zhang-Huang.ghuser,sha256=9KMXIDn5sfhk0h4QfZoKfFuHvI6x0bXVDJ3Ozd2CWNg,4678
 honeybee_grasshopper_radiance/user_objects/__init__.py,sha256=7BOscRVupILqwFUBWP6nAsMNgNN8lXQPsQ_zYUvGEr8,50
-honeybee_grasshopper_radiance-1.35.2.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-honeybee_grasshopper_radiance-1.35.2.dist-info/METADATA,sha256=8TYb6KCe8f2gnDYLNMyXCk-9Ve745Ka3iVCJJ6BuzIk,2879
-honeybee_grasshopper_radiance-1.35.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-honeybee_grasshopper_radiance-1.35.2.dist-info/top_level.txt,sha256=BBzJ4nJKMDfzWMqymIH91kdsQlHSptnGHSk8i6_KZ_4,30
-honeybee_grasshopper_radiance-1.35.2.dist-info/RECORD,,
+honeybee_grasshopper_radiance-1.35.3.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+honeybee_grasshopper_radiance-1.35.3.dist-info/METADATA,sha256=a6l_szw6CKFQ9-6QPyz4r6KPhFLNZ5FSO3rMDr1JV6A,2879
+honeybee_grasshopper_radiance-1.35.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+honeybee_grasshopper_radiance-1.35.3.dist-info/top_level.txt,sha256=BBzJ4nJKMDfzWMqymIH91kdsQlHSptnGHSk8i6_KZ_4,30
+honeybee_grasshopper_radiance-1.35.3.dist-info/RECORD,,