honeybee-grasshopper-radiance 1.35.1__py3-none-any.whl

honeybee_grasshopper_radiance/src/HB Apply Face Modifier.py

@@ -0,0 +1,107 @@
+# 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>
+
+"""
+Apply a Modifier to Honeybee Faces, Doors or Room walls.
+_
+This component supports the assigning of different modifiers based on cardinal
+orientation, provided that a list of Modifiers are input to the _mod. 
+-
+
+    Args:
+        _hb_objs: Honeybee Faces, Doors, Rooms or a Model to which the input _mod should
+            be assigned. For the case of Rooms or a Model, the modifier
+            will only be applied to the Room's outdoor walls. Note that, if you
+            need to assign a modifier to all the roofs, floors, etc. of a
+            Room, the best practice is to create a ModifierSet and assing that
+            to the Room.
+        _mod: A Honeybee Modifier to be applied to the input _hb_objs.
+            This can also be text for a modifier to be looked up in the
+            modifier library. If an array of text or modifier objects
+            are input here, different modifiers will be assigned based on
+            cardinal direction, starting with north and moving clockwise.
+
+    Returns:
+        hb_objs: The input honeybee objects with their modifiers edited.
+"""
+
+ghenv.Component.Name = 'HB Apply Face Modifier'
+ghenv.Component.NickName = 'ApplyFaceMod'
+ghenv.Component.Message = '1.9.0'
+ghenv.Component.Category = 'HB-Radiance'
+ghenv.Component.SubCategory = '1 :: Modifiers'
+ghenv.Component.AdditionalHelpFromDocStrings = '6'
+
+
+try:  # import the honeybee-radiance extension
+    from honeybee_radiance.lib.modifiers import modifier_by_identifier
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee_radiance:\n\t{}'.format(e))
+
+try:  # import the core honeybee dependencies
+    from honeybee.boundarycondition import Outdoors
+    from honeybee.facetype import Wall
+    from honeybee.model import Model
+    from honeybee.room import Room
+    from honeybee.face import Face
+    from honeybee.door import Door
+    from honeybee.orientation import angles_from_num_orient, face_orient_index
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee:\n\t{}'.format(e))
+
+try:  # import the ladybug_rhino dependencies
+    from ladybug_rhino.grasshopper import all_required_inputs
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug_rhino:\n\t{}'.format(e))
+
+
+def is_exterior_wall(face):
+    """Check whether a given Face is an exterior Wall."""
+    return isinstance(face.boundary_condition, Outdoors) and \
+        isinstance(face.type, Wall)
+
+
+if all_required_inputs(ghenv.Component):
+    # duplicate the initial objects
+    hb_objs = [obj.duplicate() for obj in _hb_objs]
+
+    # process the input modifiers
+    for i, constr in enumerate(_mod):
+        if isinstance(constr, str):
+            _mod[i] = modifier_by_identifier(constr)
+
+    # error message for unrecognized object
+    error_msg = 'Input _hb_objs must be a Room, Face, or Door. Not {}.'
+
+    # assign the modifiers
+    if len(_mod) == 1:  # assign indiscriminately, even if it's horizontal
+        for obj in hb_objs:
+            if isinstance(obj, (Face, Door)):
+                obj.properties.radiance.modifier = _mod[0]
+            elif isinstance(obj, (Room, Model)):
+                for face in obj.faces:
+                    if is_exterior_wall(face):
+                        face.properties.radiance.modifier = _mod[0]
+            else:
+                raise TypeError(error_msg.format(type(obj)))
+    else:  # assign modifiers based on cardinal direction
+        angles = angles_from_num_orient(len(_mod))
+        for obj in hb_objs:
+            if isinstance(obj, (Face, Door)):
+                orient_i = face_orient_index(obj, angles)
+                if orient_i is not None:
+                    obj.properties.radiance.modifier = _mod[orient_i]
+            elif isinstance(obj, (Room, Model)):
+                 for face in obj.faces:
+                     if is_exterior_wall(face):
+                         orient_i = face_orient_index(face, angles)
+                         if orient_i is not None:
+                            face.properties.radiance.modifier = _mod[orient_i]
+            else:
+                raise TypeError(error_msg.format(type(obj)))

honeybee_grasshopper_radiance/src/HB Apply ModifierSet.py

@@ -0,0 +1,71 @@
+# 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>
+
+"""
+Apply ModifierSet to Honeybee Rooms.
+-
+
+    Args:
+        _rooms: Honeybee Rooms to which the input _mod_set should be assigned.
+            This can also be a Honeybee Model for which all Rooms
+            will be assigned the ModifierSet.
+        _mod_set: A Honeybee ModifierSet to be applied to the input _room.
+            This can also be text for a modifier set to be looked up in the
+            modifier set library.
+
+    Returns:
+        rooms: The input Rooms with their modifier sets edited.
+"""
+
+ghenv.Component.Name = 'HB Apply ModifierSet'
+ghenv.Component.NickName = 'ApplyModSet'
+ghenv.Component.Message = '1.9.0'
+ghenv.Component.Category = 'HB-Radiance'
+ghenv.Component.SubCategory = '1 :: Modifiers'
+ghenv.Component.AdditionalHelpFromDocStrings = '6'
+
+try:  # import the honeybee extension
+    from honeybee.model import Model
+    from honeybee.room import Room
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee:\n\t{}'.format(e))
+
+try:  # import the honeybee-radiance extension
+    from honeybee_radiance.lib.modifiersets import modifier_set_by_identifier
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee_radiance:\n\t{}'.format(e))
+
+try:  # import the ladybug_rhino dependencies
+    from ladybug_rhino.grasshopper import all_required_inputs
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug_rhino:\n\t{}'.format(e))
+
+
+if all_required_inputs(ghenv.Component):
+    # duplicate the initial objects
+    rooms = [obj.duplicate() for obj in _rooms]
+
+    # extract any rooms from the input Models
+    hb_objs = []
+    for hb_obj in rooms:
+        if isinstance(hb_obj, Model):
+            hb_objs.extend(hb_obj.rooms)
+        elif isinstance(hb_obj, Room):
+            hb_objs.append(hb_obj)
+        else:
+            raise ValueError(
+                'Expected Honeybee Room or Model. Got {}.'.format(type(hb_obj)))
+
+    # process the input modifier set if it's a string
+    if isinstance(_mod_set, str):
+        _mod_set = modifier_set_by_identifier(_mod_set)
+
+    # assign the modifier set
+    for rm in hb_objs:
+        rm.properties.radiance.modifier_set = _mod_set

honeybee_grasshopper_radiance/src/HB Apply Shade Modifier.py

@@ -0,0 +1,110 @@
+# 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>
+
+"""
+Apply a Modifier to Honeybee Shade objects. Alternatively, it can assign a Modifier
+to all of the child shades of an Aperture, Door, Face, or a Room.
+_
+This component supports the assigning of different modifiers based on cardinal
+orientation, provided that a list of Modifiers are input to the _mod. 
+-
+
+    Args:
+        _hb_objs: Honeybee Shades, Apertures, Doors, Faces, Rooms, or a Model to which the
+            input _mod should be assigned. For the case of a Honeybee Aperture,
+            Door, Face, Room or Model, the Modifier will be assigned to only the
+            child shades directly assigned to that object. So passing in a Room
+            will not change the modifier of shades assigned to Apertures
+            of the Room's Faces. If this is the desired outcome, then the Room
+            should be deconstructed into its child objects before using
+            this component.
+        _mod: A Honeybee Modifier to be applied to the input _hb_objs.
+            This can also be text for a modifier to be looked up in the shade
+            modifier library. If an array of text or modifier objects
+            are input here, different modifiers will be assigned based on
+            cardinal direction, starting with north and moving clockwise.
+
+    Returns:
+        hb_objs: The input honeybee objects with their modifiers edited.
+"""
+
+ghenv.Component.Name = 'HB Apply Shade Modifier'
+ghenv.Component.NickName = 'ApplyShadeMod'
+ghenv.Component.Message = '1.9.0'
+ghenv.Component.Category = 'HB-Radiance'
+ghenv.Component.SubCategory = '1 :: Modifiers'
+ghenv.Component.AdditionalHelpFromDocStrings = '6'
+
+
+try:  # import the honeybee-radiance extension
+    from honeybee_radiance.lib.modifiers import modifier_by_identifier
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee_radiance:\n\t{}'.format(e))
+
+try:  # import the core honeybee dependencies
+    from honeybee.shade import Shade
+    from honeybee.model import Model
+    from honeybee.room import Room
+    from honeybee.face import Face
+    from honeybee.aperture import Aperture
+    from honeybee.door import Door
+    from honeybee.orientation import angles_from_num_orient, face_orient_index
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee:\n\t{}'.format(e))
+
+try:  # import the ladybug_rhino dependencies
+    from ladybug_rhino.grasshopper import all_required_inputs
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug_rhino:\n\t{}'.format(e))
+
+
+if all_required_inputs(ghenv.Component):
+    # duplicate the initial objects
+    hb_objs = [obj.duplicate() for obj in _hb_objs]
+
+    # process the input modifiers
+    for i, mod in enumerate(_mod):
+        if isinstance(mod, str):
+            _mod[i] = modifier_by_identifier(mod)
+
+    # error message for unrecognized object
+    error_msg = 'Input _hb_objs must be a Room, Face, Aperture, Door, or Shade. Not {}.'
+
+    # assign the modifiers
+    if len(_mod) == 1:
+        for obj in hb_objs:
+            if isinstance(obj, Shade):
+                obj.properties.radiance.modifier = _mod[0]
+            elif isinstance(obj, (Aperture, Face, Room, Door)):
+                for shd in obj.shades:
+                    shd.properties.radiance.modifier = _mod[0]
+            elif isinstance(obj, Model):
+                for shd in obj.orphaned_shades:
+                    shd.properties.radiance.modifier = _mod[0]
+            else:
+                raise TypeError(error_msg.format(type(obj)))
+    else:  # assign modifiers based on cardinal direction
+        angles = angles_from_num_orient(len(_mod))
+        for obj in hb_objs:
+            if isinstance(obj, (Aperture, Face, Door)):
+                orient_i = face_orient_index(obj, angles)
+                if orient_i is not None:
+                    for shd in obj.shades:
+                        shd.properties.radiance.modifier = _mod[orient_i]
+            elif isinstance(obj, Shade):
+                obj.properties.radiance.modifier = _mod[0]
+            elif isinstance(obj, Room):
+                 for shd in obj.shades:
+                    shd.properties.radiance.modifier = _mod[0]
+            elif isinstance(obj, Model):
+                 for shd in obj.orphaned_shades:
+                    shd.properties.radiance.modifier = _mod[0]
+            else:
+                raise TypeError(error_msg.format(type(obj)))
+

honeybee_grasshopper_radiance/src/HB Apply Window Modifier.py

@@ -0,0 +1,120 @@
+# 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>
+
+"""
+Apply Modifier to Honeybee Apertures or glass Doors. Alternatively, it can assign
+Modifiers to the child apertures of input Faces or the apertures within Room walls.
+_
+This component supports the assigning of different modifiers based on cardinal
+orientation, provided that a list of Modifiers are input to the _mod. 
+-
+
+    Args:
+        _hb_objs: Honeybee Apertures, Faces, Doors, Rooms or a Model to which the input
+            _mod should be assigned. For the case of Rooms or a Model, the
+            modifier will only be applied to the apertures in the the
+            Room's outdoor walls. Note that, if you need to assign a modifier
+            to all the skylights, glass doors, etc. of a Room, the best practice
+            is to create a ModifierSet and assing that to the Room.
+        _mod: A Honeybee Modifier to be applied to the input _hb_objs.
+            This can also be text for a modifier to be looked up in the window
+            modifier library. If an array of text or modifier objects
+            are input here, different modifiers will be assigned based on
+            cardinal direction, starting with north and moving clockwise.
+
+    Returns:
+        hb_objs: The input honeybee objects with their modifiers edited.
+"""
+
+ghenv.Component.Name = 'HB Apply Window Modifier'
+ghenv.Component.NickName = 'ApplyWindowMod'
+ghenv.Component.Message = '1.9.0'
+ghenv.Component.Category = 'HB-Radiance'
+ghenv.Component.SubCategory = '1 :: Modifiers'
+ghenv.Component.AdditionalHelpFromDocStrings = '6'
+
+
+try:  # import the honeybee-radiance extension
+    from honeybee_radiance.lib.modifiers import modifier_by_identifier
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee_radiance:\n\t{}'.format(e))
+
+try:  # import the core honeybee dependencies
+    from honeybee.boundarycondition import Outdoors
+    from honeybee.facetype import Wall
+    from honeybee.model import Model
+    from honeybee.room import Room
+    from honeybee.face import Face
+    from honeybee.aperture import Aperture
+    from honeybee.door import Door
+    from honeybee.orientation import angles_from_num_orient, face_orient_index
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee:\n\t{}'.format(e))
+
+try:  # import the ladybug_rhino dependencies
+    from ladybug_rhino.grasshopper import all_required_inputs
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug_rhino:\n\t{}'.format(e))
+
+
+def is_exterior_wall(face):
+    """Check whether a given Face is an exterior Wall."""
+    return isinstance(face.boundary_condition, Outdoors) and \
+        isinstance(face.type, Wall)
+
+
+if all_required_inputs(ghenv.Component):
+    # duplicate the initial objects
+    hb_objs = [obj.duplicate() for obj in _hb_objs]
+
+    # process the input modifiers
+    for i, constr in enumerate(_mod):
+        if isinstance(constr, str):
+            _mod[i] = modifier_by_identifier(constr)
+
+    # error message for unrecognized object
+    error_msg = 'Input _hb_objs must be a Room, Face, Aperture, or Door. Not {}.'
+
+    # assign the modifiers
+    if len(_mod) == 1:  # assign indiscriminately, even if it's a horizontal object
+        for obj in hb_objs:
+            if isinstance(obj, (Aperture, Door)):
+                obj.properties.radiance.modifier = _mod[0]
+            elif isinstance(obj, Face):
+                for ap in obj.apertures:
+                    ap.properties.radiance.modifier = _mod[0]
+            elif isinstance(obj, (Room, Model)):
+                for face in obj.faces:
+                    if is_exterior_wall(face):
+                        for ap in face.apertures:
+                            ap.properties.radiance.modifier = _mod[0]
+            else:
+                raise TypeError(error_msg.format(type(obj)))
+    else:  # assign modifiers only to non-horizontal objects based on cardinal direction
+        angles = angles_from_num_orient(len(_mod))
+        for obj in hb_objs:
+            if isinstance(obj, (Aperture, Door)):
+                orient_i = face_orient_index(obj, angles)
+                if orient_i is not None:
+                    obj.properties.radiance.modifier = _mod[orient_i]
+            elif isinstance(obj, Face):
+                orient_i = face_orient_index(obj, angles)
+                if orient_i is not None:
+                    for ap in obj.apertures:
+                        ap.properties.radiance.modifier = _mod[orient_i]
+            elif isinstance(obj, (Room, Model)):
+                 for face in obj.faces:
+                     if is_exterior_wall(face):
+                         orient_i = face_orient_index(face, angles)
+                         if orient_i is not None:
+                            for ap in face.apertures:
+                                ap.properties.radiance.modifier = _mod[orient_i]
+            else:
+                raise TypeError(error_msg.format(type(obj)))
+

honeybee_grasshopper_radiance/src/HB Assign Grids and Views.py

@@ -0,0 +1,58 @@
+# 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>
+
+"""
+Add radiance Sensor Grids and/or Views to a Honeybee Model.
+_
+This assignment is necessary for any Radiance study, though whether a grid or a
+view is required for a particular type of study is depenednet upon the recipe
+used.
+_
+Multiple copies of this component can be used in series and each will add the
+grids or views to any that already exist.
+
+-
+
+    Args:
+        _model: A Honeybee Model to which the input grids_ and views_ will be assigned.
+        grids_: A list of Honeybee-Radiance SensorGrids, which will be assigned to
+            the input _model.
+        views_: A list of Honeybee-Radiance Views, which will be assigned to the
+            input _model.
+
+    Returns:
+        model: The input Honeybee Model with the grids_ and views_ assigned to it.
+"""
+
+ghenv.Component.Name = 'HB Assign Grids and Views'
+ghenv.Component.NickName = 'AssignGridsViews'
+ghenv.Component.Message = '1.9.0'
+ghenv.Component.Category = 'HB-Radiance'
+ghenv.Component.SubCategory = '0 :: Basic Properties'
+ghenv.Component.AdditionalHelpFromDocStrings = '5'
+
+try:  # import core honeybee dependencies
+    from honeybee.model import Model
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee:\n\t{}'.format(e))
+
+try:  # import ladybug_rhino dependencies
+    from ladybug_rhino.grasshopper import all_required_inputs
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug_rhino:\n\t{}'.format(e))
+
+
+if all_required_inputs(ghenv.Component):
+    assert isinstance(_model, Model), \
+        'Expected Honeybee Model. Got {}.'.format(type(_model))
+    model = _model.duplicate()  # duplicate to avoid editing the input
+    if len(grids_) != 0:
+        model.properties.radiance.add_sensor_grids(grids_)
+    if len(views_) != 0:
+        model.properties.radiance.add_views(views_)

honeybee_grasshopper_radiance/src/HB Automatic Aperture Group.py

@@ -0,0 +1,100 @@
+# 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 Aperture groups for exterior Apertures.
+_
+The Apertures are grouped by orientation unless _view_factor_ is set to True.
+_
+If grouping based on view factor the component calculates view factor from
+Apertures to sky patches (rfluxmtx). Each Aperture is represented by a sensor
+grid, and the view factor for the whole Aperture is the average of the grid. The
+RMSE of the view factor to each sky patch is calculated between all Apertures.
+Agglomerative hierarchical clustering (with complete-linkage method) is used to
+group the Apertures by using a distance matrix of the RMSE values.
+
+The view factor approach is Radiance-based (and slower) and will likely group
+Apertures more accurately considering the context geometry of the Honeybee
+Model.
+-
+
+    Args:
+        _model: A Honeybee Model for which Apertures will be grouped automatically.
+            Note that this model must have Apertures with Outdoors boundary
+            condition assigned to it.
+        _room_based_: A boolean to note whether the Apertures should be grouped on a
+            room basis. If grouped on a room basis Apertures from different
+            room cannot be in the same group. (Default: True).
+        _view_factor_: A boolean to note whether the Apertures should be grouped by
+            calculating view factors for the Apertures to a discretized sky or
+            simply by the normal orientation of the Apertures. (Default: False).
+        _size_: Aperture grid size for view factor calculation. A lower number
+            will give a finer grid and more accurate results but the calculation
+            time will increase. This option is only used if _view_factor_ is set
+            to True. (Default: 0.2).
+        vert_tolerance_: A float value for vertical tolerance between two Apertures.
+            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: 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.9.0'
+ghenv.Component.Category = 'HB-Radiance'
+ghenv.Component.SubCategory = '0 :: Basic Properties'
+ghenv.Component.AdditionalHelpFromDocStrings = '2'
+
+try:
+    from honeybee.model import Model
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee:\n\t{}'.format(e))
+
+try:  # import honeybee_radiance_command dependencies
+    from honeybee_radiance_command.oconv import Oconv
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee_radiance_command:\n\t{}'.format(e))
+
+try:
+    from honeybee_radiance.dynamic.multiphase import automatic_aperture_grouping
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee_radiance:\n\t{}'.format(e))
+
+try:
+    from ladybug_rhino.grasshopper import all_required_inputs
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug_rhino:\n\t{}'.format(e))
+
+
+if all_required_inputs(ghenv.Component) and _run:
+    assert isinstance(_model, Model), \
+        'Input _model must be a Model. Got {}'.format(type(_model))
+    # duplicate model
+    model = _model.duplicate()
+
+    # set defaults
+    room_based = True if _room_based_ is None else _room_based_
+    view_factor = False if _view_factor_ is None else _view_factor_
+    size = 0.2 if _size_ is None else _size_
+    vertical_tolerance = None if vert_tolerance_ is None else vert_tolerance_
+
+    # automatically assign groups
+    automatic_aperture_grouping(
+        model, size=size, room_based=room_based, view_factor_or_orientation=view_factor,
+        vertical_tolerance=vertical_tolerance, states=states_)

honeybee_grasshopper_radiance/src/HB BSDF Modifier.py

@@ -0,0 +1,78 @@
+# 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>
+
+"""
+Create a Bidirectional Scattering Distribution Function (BSDF) radiance modifier
+from an XML file.
+-
+
+    Args:
+        _xml_file: Path to an XML file contining BSDF data. These files can
+            be produced using the LBNL WINDOW software among other sources.
+        _up_vec_: A vector that sets the hemisphere that the BSDF modifier faces.
+            For materials that are symmetrical about the face plane (like
+            non-angled venetian blinds), this can be any vector that is not
+            perfectly normal/perpendicular to the face. For asymmetrica
+            materials like angled venetian blinds, this variable should be
+            coordinated with the direction that the geometry is facing.
+            The default is set to (0.01, 0.01, 1.00), which should hopefully
+            not be normal to any typical face.
+        thickness_: Optional number to set the thickness of the BSDF. Thickness
+            is not supported for aBSDF type. (Default: 0).
+        _bsdf_type_: An integer to set the bsdf type. Choose from the choices
+            below. (Default: 0).
+                * 0 BSDF
+                * 1 aBSDF
+            Choose aBSDF (peak extraction) for systems with a strong specular
+            transmission component. A proposed guideline for when to use aBSDF
+            can be found in chapter 6 in "BSDF generation procedures for
+            daylighting systems". Find the white paper at:
+            * https://task61.iea-shc.org/publications
+
+    Returns:
+        modifier: A BSDF modifier that can be assigned to a Honeybee geometry
+            or Modifier Sets.
+"""
+
+ghenv.Component.Name = 'HB BSDF Modifier'
+ghenv.Component.NickName = 'BSDFMod'
+ghenv.Component.Message = '1.9.0'
+ghenv.Component.Category = 'HB-Radiance'
+ghenv.Component.SubCategory = '1 :: Modifiers'
+ghenv.Component.AdditionalHelpFromDocStrings = '2'
+
+try:  # import the honeybee-radiance dependencies
+    from honeybee_radiance.modifier.material import BSDF, aBSDF
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee_radiance:\n\t{}'.format(e))
+
+try:  # import ladybug_rhino dependencies
+    from ladybug_rhino.grasshopper import all_required_inputs
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug_rhino:\n\t{}'.format(e))
+
+BSDF_TYPES = ('bsdf', 'absdf')
+
+if all_required_inputs(ghenv.Component):
+    # process the vector input
+    if _up_vec_ is not None:
+        _up_vec_ = (_up_vec_.X, _up_vec_.Y, _up_vec_.Z)
+
+    if _bsdf_type_ is None:
+        _type_= 'bsdf'
+    else:
+        _type_= _bsdf_type_ if _bsdf_type_ in BSDF_TYPES else BSDF_TYPES[int(_bsdf_type_)]
+
+    # create the modifier
+    if _type_ == 'bsdf':
+        modifier = BSDF(
+            _xml_file, up_orientation=_up_vec_, thickness=thickness_)
+    else:
+        modifier = aBSDF(
+            _xml_file, up_orientation=_up_vec_)