honeybee-grasshopper-radiance 1.30.14__tar.gz → 1.32.0__tar.gz

{honeybee-grasshopper-radiance-1.30.14 → honeybee-grasshopper-radiance-1.32.0}/PKG-INFO

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

{honeybee-grasshopper-radiance-1.30.14 → honeybee-grasshopper-radiance-1.32.0}/honeybee_grasshopper_radiance/src/HB Annual Average Values.py

@@ -19,6 +19,11 @@ hour/timestep of the simulation.
             or the "HB Annual Irradiance" 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
@@ -41,7 +46,7 @@ hour/timestep of the simulation.
 
 ghenv.Component.Name = 'HB Annual Average Values'
 ghenv.Component.NickName = 'AvgValues'
-ghenv.Component.Message = '1.6.1'
+ghenv.Component.Message = '1.6.2'
 ghenv.Component.Category = 'HB-Radiance'
 ghenv.Component.SubCategory = '4 :: Results'
 ghenv.Component.AdditionalHelpFromDocStrings = '2'
@@ -64,13 +69,19 @@ try:
 except ImportError as e:
     raise ImportError('\nFailed to import honeybee_radiance:\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
+    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))
 
@@ -133,6 +144,17 @@ if all_required_inputs(ghenv.Component):
             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)
         use_shell = True if os.name == 'nt' else False
         process = subprocess.Popen(
             cmds, cwd=res_folder, shell=use_shell,
@@ -147,6 +169,11 @@ if all_required_inputs(ghenv.Component):
             values = list_to_data_tree(values)
 
     else:
+        if len(dyn_sch_) != 0:
+            msg = 'Dynamic Schedules are currently only supported for Annual Daylight ' \
+                'simulations.\nThe input schedules will be ignored.'
+            print(msg)
+            give_warning(ghenv.Component, msg)
         if median_:
             raise ValueError('The median values can only be calculated for a '
                              'results folder from the "HB Annual Daylight" '

{honeybee-grasshopper-radiance-1.30.14 → honeybee-grasshopper-radiance-1.32.0}/honeybee_grasshopper_radiance/src/HB Annual Cumulative Values.py

@@ -19,6 +19,11 @@ hour/timestep of the simulation.
             or the "HB Annual Irradiance" 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
@@ -39,7 +44,7 @@ hour/timestep of the simulation.
 
 ghenv.Component.Name = 'HB Annual Cumulative Values'
 ghenv.Component.NickName = 'CumulValues'
-ghenv.Component.Message = '1.6.0'
+ghenv.Component.Message = '1.6.1'
 ghenv.Component.Category = 'HB-Radiance'
 ghenv.Component.SubCategory = '4 :: Results'
 ghenv.Component.AdditionalHelpFromDocStrings = '2'
@@ -62,13 +67,19 @@ try:
 except ImportError as e:
     raise ImportError('\nFailed to import honeybee_radiance:\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
+    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))
 
@@ -112,7 +123,8 @@ if all_required_inputs(ghenv.Component):
         else _results[0]
 
     # check to see if results use the newer numpy arrays
-    if os.path.isdir(os.path.join(res_folder, '__static_apertures__')):
+    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', 'cumulative-values', res_folder, '-sf', 'metrics']
         if len(_hoys_) != 0:
@@ -122,6 +134,17 @@ if all_required_inputs(ghenv.Component):
             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)
         use_shell = True if os.name == 'nt' else False
         process = subprocess.Popen(
             cmds, cwd=res_folder, shell=use_shell,
@@ -136,17 +159,23 @@ if all_required_inputs(ghenv.Component):
             values = list_to_data_tree(values)
 
     else:
+        if len(dyn_sch_) != 0:
+            msg = 'Dynamic Schedules are currently only supported for Annual Daylight ' \
+                'simulations.\nThe input schedules will be ignored.'
+            print(msg)
+            give_warning(ghenv.Component, msg)
+
         # extract the timestep if it exists
         timestep = 1
         tstep_file = os.path.join(res_folder, 'timestep.txt')
         if os.path.isfile(tstep_file):
             with open(tstep_file) as tf:
                 timestep = int(tf.readline())
-    
+
         # parse the sun-up-hours
         grids, sun_up_hours = _process_input_folder(res_folder, grid_filter_)
         su_pattern = parse_sun_up_hours(sun_up_hours, _hoys_, timestep)
-    
+
         # compute the average values
         values = []
         for grid_info in grids:

{honeybee-grasshopper-radiance-1.30.14 → honeybee-grasshopper-radiance-1.32.0}/honeybee_grasshopper_radiance/src/HB Annual Daylight Metrics.py

@@ -16,6 +16,11 @@ Calculate Annual Daylight Metrics from a result (.ill) files.
             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.
         _occ_sch_: An annual occupancy schedule as a Ladybug Data Collection or a HB-Energy
             schedule object. This can also be the identifier of a schedule in
             your HB-Energy schedule library. Any value in this schedule that is
@@ -60,7 +65,7 @@ Calculate Annual Daylight Metrics from a result (.ill) files.
 
 ghenv.Component.Name = "HB Annual Daylight Metrics"
 ghenv.Component.NickName = 'DaylightMetrics'
-ghenv.Component.Message = '1.6.0'
+ghenv.Component.Message = '1.6.2'
 ghenv.Component.Category = 'HB-Radiance'
 ghenv.Component.SubCategory = '4 :: Results'
 ghenv.Component.AdditionalHelpFromDocStrings = '1'
@@ -84,6 +89,11 @@ try:
 except ImportError as e:
     raise ImportError('\nFailed to import honeybee_radiance:\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 honeybee_energy.lib.schedules import schedule_by_identifier
 except ImportError as e:  # honeybee schedule library is not available
@@ -96,7 +106,8 @@ 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
+    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))
 
@@ -142,7 +153,8 @@ if all_required_inputs(ghenv.Component):
     # compute the annual metrics
     res_folder = os.path.dirname(_results[0]) if os.path.isfile(_results[0]) \
         else _results[0]
-    if os.path.isdir(os.path.join(res_folder, '__static_apertures__')):
+    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-daylight', res_folder, '-sf', 'metrics',
@@ -150,6 +162,17 @@ if all_required_inputs(ghenv.Component):
         ]
         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 schedule is not None:
             sch_str = '\n'.join(str(h) for h in schedule)
             sch_file = os.path.join(res_folder, 'schedule.txt')
@@ -170,6 +193,11 @@ if all_required_inputs(ghenv.Component):
         UDI_low = list_to_data_tree(read_udi_from_folder(os.path.join(metric_dir, 'udi_lower')))
         UDI_up = list_to_data_tree(read_udi_from_folder(os.path.join(metric_dir, 'udi_upper')))
     else:
+        if len(dyn_sch_) != 0:
+            msg = 'Dynamic Schedules are currently only supported for Annual Daylight ' \
+                'simulations.\nThe input schedules will be ignored.'
+            print(msg)
+            give_warning(ghenv.Component, msg)
         DA, cDA, UDI_low, UDI, UDI_up = metrics_from_folder(
             res_folder, schedule, _threshold_, min_t, max_t, grid_filter_)
         DA = list_to_data_tree(DA)

{honeybee-grasshopper-radiance-1.30.14 → honeybee-grasshopper-radiance-1.32.0}/honeybee_grasshopper_radiance/src/HB Annual Daylight.py

@@ -11,13 +11,16 @@
 Run an annual daylight study for a Honeybee model to compute hourly illuminance
 for each sensor in a model's sensor grids.
 _
-By default, this recipe uses a standard 2-phase method for simulation, which
-determines the relationship between each sensor and sky patch and then multiplies
-the value of each sky patch at each hour by the relationship coefficient.
+By default, this recipe uses an enhanced 2-phase method, which accurately models
+direct sun by tracing rays from each sensor to the solar position at each hour
+of the calculation. This makes the result suitable for computing Annual Sun
+Exposure (ASE) and for modeling the effects of dynamic shades and apertures.
 _
-When the enhanced_ option is selected, this recipe uses an enhanced 2-phase method,
-which accurately models direct sun by tracing rays from each sensor to the solar
-position at each hour of the calculation.
+When the enhanced_ option is set to False, a standard 2-phase method for simulation,
+which is much faster because it simply determines the relationship between each
+sensor and sky patch and then multiplies the value of each sky patch at each
+hour by the relationship coefficient. However, this means that the direct sun
+is spread out across a few sky patches, making it unsuitable for ASE.
 _
 The resulting illuminance is used to compute the following metrics:
 _
@@ -60,7 +63,10 @@ _
             tracing. (Default: -ab 2 -ad 5000 -lw 2e-05).
         enhanced_: Boolean to note whether an enhanced version of the 2-phase ray tracing
             simulation should be used, which will more accurately account for
-            direct sun at each time step. (Default:False).
+            direct sun at each time step. If False, only a 2-phase daylight
+            coefficient calculation with sky patches will be used, which is
+            much faster but spreads the direct sun out across a few sky
+            patches, making it unsuitable for ASE. (Default: True).
         run_settings_: Settings from the "HB Recipe Settings" component that specify
             how the recipe should be run. This can also be a text string of
             recipe settings.
@@ -103,7 +109,7 @@ _
 
 ghenv.Component.Name = 'HB Annual Daylight'
 ghenv.Component.NickName = 'AnnualDaylight'
-ghenv.Component.Message = '1.6.1'
+ghenv.Component.Message = '1.6.2'
 ghenv.Component.Category = 'HB-Radiance'
 ghenv.Component.SubCategory = '3 :: Recipes'
 ghenv.Component.AdditionalHelpFromDocStrings = '1'
@@ -121,7 +127,8 @@ except ImportError as e:
 
 if all_required_inputs(ghenv.Component) and _run:
     # create the recipe and set the input arguments
-    recipe = Recipe('annual-daylight-enhanced') if enhanced_ else Recipe('annual-daylight')
+    recipe = Recipe('annual-daylight') if enhanced_ is False else \
+        Recipe('annual-daylight-enhanced')
     recipe.input_value_by_name('model', _model)
     recipe.input_value_by_name('wea', _wea)
     recipe.input_value_by_name('north', north_)

{honeybee-grasshopper-radiance-1.30.14 → honeybee-grasshopper-radiance-1.32.0}/honeybee_grasshopper_radiance/src/HB Annual Peak Values.py

@@ -19,6 +19,11 @@ hour/timestep of the simulation.
             or the "HB Annual Irradiance" 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
@@ -45,7 +50,7 @@ hour/timestep of the simulation.
 
 ghenv.Component.Name = 'HB Annual Peak Values'
 ghenv.Component.NickName = 'PeakValues'
-ghenv.Component.Message = '1.6.2'
+ghenv.Component.Message = '1.6.3'
 ghenv.Component.Category = 'HB-Radiance'
 ghenv.Component.SubCategory = '4 :: Results'
 ghenv.Component.AdditionalHelpFromDocStrings = '2'
@@ -68,13 +73,19 @@ try:
 except ImportError as e:
     raise ImportError('\nFailed to import honeybee_radiance:\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
+    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))
 
@@ -132,7 +143,8 @@ if all_required_inputs(ghenv.Component):
         else _results[0]
 
     # check to see if results use the newer numpy arrays
-    if os.path.isdir(os.path.join(res_folder, '__static_apertures__')):
+    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', 'peak-values', res_folder, '-sf', 'metrics']
         if len(_hoys_) != 0:
@@ -144,6 +156,17 @@ if all_required_inputs(ghenv.Component):
             cmds.extend(['--grids-filter', grid_filter_])
         if coincident_:
             cmds.append('--coincident')
+        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)
         use_shell = True if os.name == 'nt' else False
         process = subprocess.Popen(
             cmds, cwd=res_folder, shell=use_shell,
@@ -164,13 +187,19 @@ if all_required_inputs(ghenv.Component):
                 hoys = [None] * len(hoys)
 
     else:
+        if len(dyn_sch_) != 0:
+            msg = 'Dynamic Schedules are currently only supported for Annual Daylight ' \
+                'simulations.\nThe input schedules will be ignored.'
+            print(msg)
+            give_warning(ghenv.Component, msg)
+
         # extract the timestep if it exists
         timestep = 1
         tstep_file = os.path.join(res_folder, 'timestep.txt')
         if os.path.isfile(tstep_file):
             with open(tstep_file) as tf:
                 timestep = int(tf.readline())
-    
+
         # parse the sun-up-hours
         grids, sun_up_hours = _process_input_folder(res_folder, grid_filter_)
         su_pattern = parse_sun_up_hours(sun_up_hours, _hoys_, timestep)

{honeybee-grasshopper-radiance-1.30.14 → honeybee-grasshopper-radiance-1.32.0}/honeybee_grasshopper_radiance/src/HB Annual Results to Data.py

@@ -19,6 +19,11 @@ deconstructed for detailed analysis with native Grasshopper math components.
             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.
         _sel_pts: A point or list of points, which will be used to filter the sensors
             for which data collections will be imported.
         _all_pts: The data tree of all sensor points that were used in the simulation.
@@ -40,7 +45,7 @@ deconstructed for detailed analysis with native Grasshopper math components.
 
 ghenv.Component.Name = 'HB Annual Results to Data'
 ghenv.Component.NickName = 'AnnualToData'
-ghenv.Component.Message = '1.6.0'
+ghenv.Component.Message = '1.6.1'
 ghenv.Component.Category = 'HB-Radiance'
 ghenv.Component.SubCategory = '4 :: Results'
 ghenv.Component.AdditionalHelpFromDocStrings = '2'
@@ -71,11 +76,16 @@ try:
 except ImportError as e:
     raise ImportError('\nFailed to import honeybee_radiance:\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 ladybug_rhino.config import tolerance
     from ladybug_rhino.togeometry import to_point3d, to_vector3d
     from ladybug_rhino.grasshopper import all_required_inputs, list_to_data_tree, \
-        data_tree_to_list
+        data_tree_to_list, give_warning
 except ImportError as e:
     raise ImportError('\nFailed to import ladybug_rhino:\n\t{}'.format(e))
 
@@ -159,7 +169,8 @@ if all_required_inputs(ghenv.Component):
         pt_filter = new_pt_filter
 
     # check to see if results use the newer numpy arrays
-    if os.path.isdir(os.path.join(res_folder, '__static_apertures__')):
+    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-to-data', res_folder]
         if pt_filter[0] is not None:
@@ -167,6 +178,17 @@ if all_required_inputs(ghenv.Component):
             si_file = os.path.join(res_folder, 'sensor_indices.json')
             write_to_file(si_file, json.dumps(sen_dict))
             cmds.extend(['--sensor-index', si_file])
+        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)
         use_shell = True if os.name == 'nt' else False
         process = subprocess.Popen(
             cmds, cwd=res_folder, shell=use_shell,
@@ -181,6 +203,12 @@ if all_required_inputs(ghenv.Component):
         data = list_to_data_tree(data)
 
     else:
+        if len(dyn_sch_) != 0:
+            msg = 'Dynamic Schedules are currently only supported for Annual Daylight ' \
+                'simulations.\nThe input schedules will be ignored.'
+            print(msg)
+            give_warning(ghenv.Component, msg)
+
         # extract the timestep if it exists
         timestep, has_t_step = 1, False
         tstep_file = os.path.join(res_folder, 'timestep.txt')

honeybee-grasshopper-radiance-1.32.0/honeybee_grasshopper_radiance/src/HB Aperture Group Schedule.py

@@ -0,0 +1,69 @@
+# Honeybee: A Plugin for Environmental Analysis (GPL)
+# This file is part of Honeybee.
+#
+# Copyright (c) 2023, 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>
+
+"""
+Create a Dynamic Aperture Group Schedule, which can be used to process any dynamic
+aperture geometry that was run in an annual simulation.
+
+-
+    Args:
+        _group_aps: Honeybee Apertures that are a part of the same dynamic group and will
+            be assigned the same schedule for postprocessing. Typically, this is
+            the output of the "HB Dynamic Aperture Group" component but it can
+            also be the output of the "HB Get Dynamic Groups" component, which
+            returns all of the dynamic groups on a particular Model.
+        _schedule: A list of 8760 integers refering to the index of the aperture group state
+            to be used at each hour of the simulation. This can also be a single integer
+            for a static state to be used for the entire period of the simulation
+            or a pattern of integers that is less than 8760 in length and will be
+            repeated until the 8760 is reached. Note that 0 refers to the first
+            state, 1 refers to the second state, and so on. -1 can be used to
+            completely discout the aperture from the simulation for a given hour.
+
+    Returns:
+        dyn_sch: A dynamic schedule object for the input aperture group, which can be plugged
+            into any of the Results components with a syn_sch input.
+"""
+
+ghenv.Component.Name = 'HB Aperture Group Schedule'
+ghenv.Component.NickName = 'GroupSch'
+ghenv.Component.Message = '1.6.0'
+ghenv.Component.Category = 'HB-Radiance'
+ghenv.Component.SubCategory = '4 :: Results'
+ghenv.Component.AdditionalHelpFromDocStrings = '1'
+
+try:
+    from honeybee.aperture import Aperture
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee:\n\t{}'.format(e))
+
+try:
+    from honeybee_radiance_postprocess.dynamic import ApertureGroupSchedule
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee_radiance:\n\t{}'.format(e))
+
+try:
+    from ladybug_rhino.grasshopper import all_required_inputs, recipe_result
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug_rhino:\n\t{}'.format(e))
+
+
+if all_required_inputs(ghenv.Component):
+    dyn_sch = []
+    dyn_ids = set()
+    for ap in _group_aps:
+        assert isinstance(ap, Aperture), 'Expected Aperture. Got {}.'.format(type(ap))
+        dyn_grp_id = ap.properties.radiance.dynamic_group_identifier
+        if dyn_grp_id is None:
+            raise ValueError(
+                'Input Aperture "{}" is not a part of a dynamic group.'.format(ap.display_name))
+        if dyn_grp_id not in dyn_ids:
+            dyn_ids.add(dyn_grp_id)
+            _ap_group_sch = ApertureGroupSchedule(dyn_grp_id, _schedule)
+            dyn_sch.append(_ap_group_sch)

{honeybee-grasshopper-radiance-1.30.14 → honeybee-grasshopper-radiance-1.32.0}/honeybee_grasshopper_radiance/src/HB Automatic Aperture Group.py

@@ -42,16 +42,21 @@ Model.
             If the vertical distance between two Apertures is larger than this
             tolerance the Apertures cannot be grouped. If no value is given the
             vertical grouping will be skipped. (Default: None).
+        states_: An optional list of Honeybee State objects to be applied to all the generated groups.
+            These states should be ordered based on how they will be switched on.
+            The first state is the default state and, typically, higher states
+            are more shaded. If the objects in the group have no states, the
+            modifiers already assigned the apertures will be used for all states.
         _run: Set to True to run the automatic Aperture grouping.
 
     Returns:
-        model: A Honeybee Model object where all Apertures with Outdoors
+        model: The input Honeybee Model object where all Apertures with Outdoors
             boundary condition have been assigned a dynamic group identifier.
 """
 
 ghenv.Component.Name = 'HB Automatic Aperture Group'
 ghenv.Component.NickName = 'AutoGroup'
-ghenv.Component.Message = '1.6.2'
+ghenv.Component.Message = '1.6.4'
 ghenv.Component.Category = 'HB-Radiance'
 ghenv.Component.SubCategory = '0 :: Basic Properties'
 ghenv.Component.AdditionalHelpFromDocStrings = '2'
@@ -78,8 +83,8 @@ except ImportError as e:
 
 try:
     from honeybee_radiance.config import folders as rad_folders
-    from honeybee_radiance.cli.multiphase import _aperture_view_factor, \
-        _aperture_view_factor_postprocess, cluster_view_factor, \
+    from honeybee_radiance.dynamic.multiphase import aperture_view_factor, \
+        aperture_view_factor_postprocess, cluster_view_factor, \
         cluster_orientation, cluster_output
     from honeybee_radiance.lightsource.sky.skydome import SkyDome
 except ImportError as e:
@@ -152,11 +157,11 @@ if all_required_inputs(ghenv.Component) and _run:
         rflux_sky = rflux_sky.to_file(folder_dir, name='rflux_sky.sky')
         
         # calculate view factor
-        mtx_file, ap_dict = _aperture_view_factor(
+        mtx_file, ap_dict = aperture_view_factor(
             folder_dir, apertures, size=size, ambient_division=1000,
             receiver=rflux_sky, octree=octree, calc_folder=folder_dir
         )
-        rmse = _aperture_view_factor_postprocess(
+        rmse = aperture_view_factor_postprocess(
             mtx_file, ap_dict, room_apertures, room_based
         )
 
@@ -184,6 +189,7 @@ if all_required_inputs(ghenv.Component) and _run:
         json.dump(group_dict, fp, indent=2)
 
     # assign dynamic group identifiers for each aperture
+    group_ap_dict = {}
     for room in model.rooms:
         for face in room.faces:
             for ap in face.apertures:
@@ -191,3 +197,22 @@ if all_required_inputs(ghenv.Component) and _run:
                     dyn_group_id = group_dict[ap.identifier]
                     ap.properties.radiance.dynamic_group_identifier = \
                         dyn_group_id
+                    try:
+                        group_ap_dict[dyn_group_id].append(ap)
+                    except KeyError:
+                        group_ap_dict[dyn_group_id] = [ap]
+
+    # assign any states if they are connected
+    if len(states_) != 0:
+        for group_aps in group_ap_dict.values():
+            # assign states (including shades) to the first aperture
+            group_aps[0].properties.radiance.states = [state.duplicate() for state in states_]
+            # remove shades from following apertures to ensure they aren't double-counted
+            states_wo_shades = []
+            for state in states_:
+                new_state = state.duplicate()
+                new_state.remove_shades()
+                states_wo_shades.append(new_state)
+            for ap in group_aps[1:]:
+                ap.properties.radiance.states = \
+                    [state.duplicate() for state in states_wo_shades]