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

honeybee_grasshopper_radiance/src/HB CIE Standard Sky.py

@@ -0,0 +1,75 @@
+# 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 point-in-time standard Radiance CIE sky.
+-
+
+    Args:
+        north_: A number between 0 and 360 that represents the degrees off from
+            the y-axis to make North. This can also be a vector to set the North.
+            Default is 0. The default North direction is the Y-axis (0 degrees).
+        _location: A Ladybug location object.
+        _month_: An integer between 1 and 12 for the month of the year (default: 6).
+        _day_: An integer between 1 and 31 for the day of the month (default: 21).
+        _hour_: A number between 0 and 23.999 for the hour of the day (default: 12).
+        _type_: An integer between 0..5 to indicate CIE Sky Type (default: 0).
+            * 0 = Sunny with sun
+            * 1 = sunny without sun
+            * 2 = intermediate with sun
+            * 3 = intermediate without sun
+            * 4 = cloudy sky
+            * 5 = uniform sky
+
+    Returns:
+        sky: A honeybee sky that can be used to create a point-in-time recipe.
+"""
+
+ghenv.Component.Name = 'HB CIE Standard Sky'
+ghenv.Component.NickName = 'CIESky'
+ghenv.Component.Message = '1.9.0'
+ghenv.Component.Category = 'HB-Radiance'
+ghenv.Component.SubCategory = '2 :: Light Sources'
+ghenv.Component.AdditionalHelpFromDocStrings = '1'
+
+try:
+    from ladybug_geometry.geometry2d.pointvector import Vector2D
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug_geometry:\n\t{}'.format(e))
+
+try:
+    from honeybee_radiance.lightsource.sky import CIE
+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
+    from ladybug_rhino.togeometry import to_vector2d
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug_rhino:\n\t{}'.format(e))
+
+import math
+
+
+if all_required_inputs(ghenv.Component):
+    # process the north input
+    north_ = north_ or 0
+    try:  # it's a vector
+        north_ = math.degrees(to_vector2d(north_).angle_clockwise(Vector2D(0, 1)))
+    except AttributeError:  # north angle instead of vector
+        north_ = float(north_)
+
+    # set default values if they are not set
+    _type_ = 0 if _type_ is None else _type_
+    _month_ = 6 if _month_ is None else _month_
+    _day_ = 21 if _day_ is None else _day_
+    _hour_ = 12 if _hour_ is None else _hour_
+
+    # create the sky object
+    sky = CIE.from_location(_location, _month_, _day_, _hour_, _type_, north_)

honeybee_grasshopper_radiance/src/HB Certain Illuminance.py

@@ -0,0 +1,41 @@
+# 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 uniform sky that yields a certain illuminance.
+
+-
+    Args:
+        _value_: Desired value for sky horizontal illuminance in lux. (Default: 10000).
+
+    Returns:
+        sky: A honeybee sky that can be used to create a point-in-time recipe.
+"""
+
+ghenv.Component.Name = 'HB Certain Illuminance'
+ghenv.Component.NickName = 'CertainIllum'
+ghenv.Component.Message = '1.9.0'
+ghenv.Component.Category = 'HB-Radiance'
+ghenv.Component.SubCategory = '2 :: Light Sources'
+ghenv.Component.AdditionalHelpFromDocStrings = '1'
+
+try:
+    from honeybee_radiance.lightsource.sky import CertainIrradiance
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee_radiance:\n\t{}'.format(e))
+
+try:
+    from ladybug_rhino.grasshopper import turn_off_old_tag
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug_rhino:\n\t{}'.format(e))
+turn_off_old_tag(ghenv.Component)
+
+
+_value_ = 10000 if _value_ is None else _value_
+sky = CertainIrradiance.from_illuminance(_value_)

honeybee_grasshopper_radiance/src/HB Check Scene.py

@@ -0,0 +1,208 @@
+# 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>
+
+"""
+Run a quick view-based Radiance simulation to visualize the properties of Honeybee
+objects within Radiance.
+_
+Note that this simulation is always run on a single processor and will only show
+static Radiance properties (no dynamic Aperture or Shade properties). Accordingly, this
+component is only intended for quick checks of properties. For full customization
+of view-based simulations, the "HB Point-in-time View-based" recipe should be used.
+
+-
+    Args:
+        _hb_objs: An array of honeybee Rooms, Faces, Apertures, Doors or Shades to be
+            visualized in Radiance. This can also be an entire Model to be
+            visualized.
+        _view_: An optional Honeybee-Radiance view to specify the view to render. If
+            unspecified, the currently active Rhino viewport will be rendered.
+        _sky_: An optional Radiance sky from any of the sky components under the "Light
+            Sources" tab. If unspecified, a uniform sky with 10000 lux will be used.
+        adj_expos_: Boolean to note whether the exposure of the image should be adjusted to
+            mimic the human visual response in the output. The goal of this process
+            is to output an image that correlates more strongly with a person’s
+            subjective impression of a scene rather than the absolute birghtness
+            of the scene. (Default: True).
+        _metric_: Either an integer or the full name of a point-in-time metric to be
+            computed by the recipe. (Default: luminance). Choose from the following:
+                * 0 = illuminance
+                * 1 = irradiance
+                * 2 = luminance
+                * 3 = radiance
+        _resolution_: An integer for the maximum dimension of each image in pixels
+            (either width or height depending on the input view angle and
+            type). (Default: 800).
+        radiance_par_: Text for the radiance parameters to be used for ray
+            tracing. (Default: -ab 2 -aa 0.25 -ad 512 -ar 16).
+        _run: Set to "True" to run Radiance and get an image of the scene.
+
+    Returns:
+        report: Reports, errors, warnings, etc.
+        hdr: A High Dynamic Range (HDR) image of the scene. This can be plugged into
+            the Ladybug "Image Viewer" component to preview the image. It 
+            can also be plugged into the "HB False Color" component to convert 
+            the image into a false color version. Lastly, it can be connected to 
+            the "HB HDR to GIF" component to get a GIF image that is more portable 
+            and easily previewed by different software. Pixel values are in the
+            standard SI units of the requested input metric.
+                * illuminance = lux (aka. lm/m2)
+                * irradiance = W/m2
+                * luminance = cd/m2 (aka. lm/m2-sr)
+                * radiance = W/m2-sr
+"""
+
+ghenv.Component.Name = 'HB Check Scene'
+ghenv.Component.NickName = 'CheckScene'
+ghenv.Component.Message = '1.9.0'
+ghenv.Component.Category = 'HB-Radiance'
+ghenv.Component.SubCategory = '3 :: Recipes'
+ghenv.Component.AdditionalHelpFromDocStrings = '6'
+
+import os
+
+try:  # import honeybee_radiance dependencies
+    from ladybug.futil import write_to_file_by_name
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug:\n\t{}'.format(e))
+
+try:  # import honeybee dependencies
+    from honeybee.config import folders
+    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
+    from honeybee_radiance_command.rpict import Rpict
+    from honeybee_radiance_command.rtrace import Rtrace
+    from honeybee_radiance_command.rcalc import Rcalc
+    from honeybee_radiance_command.pcond import Pcond
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee_radiance_command:\n\t{}'.format(e))
+
+try:  # import honeybee_radiance dependencies
+    from honeybee_radiance.config import folders as rad_folders
+    from honeybee_radiance.view import View
+    from honeybee_radiance.lightsource.sky.strutil import string_to_sky
+    from honeybee_radiance.lightsource.sky import CertainIrradiance, ClimateBased
+except ImportError as e:
+    raise ImportError('\nFailed to import honeybee_radiance:\n\t{}'.format(e))
+
+try:
+    from ladybug_rhino.grasshopper import all_required_inputs
+    from ladybug_rhino.viewport import viewport_by_name, viewport_properties
+    from ladybug_rhino.config import tolerance, angle_tolerance, units_system
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug_rhino:\n\t{}'.format(e))
+
+# check the Radiance date of the installed radiance
+try:  # import lbt_recipes dependencies
+    from lbt_recipes.version import check_radiance_date
+except ImportError as e:
+    raise ImportError('\nFailed to import lbt_recipes:\n\t{}'.format(e))
+check_radiance_date()
+
+# dictionary of supported metrics
+metric_dict = {
+    '0': 'illuminance',
+    '1': 'irradiance',
+    '2': 'luminance',
+    '3': 'radiance',
+    'illuminance': 'illuminance',
+    'irradiance': 'irradiance',
+    'luminance': 'luminance',
+    'radiance': 'radiance'
+}
+
+
+if all_required_inputs(ghenv.Component) and _run:
+    # set defaults for resolution, metric and view
+    _resolution_ = 800 if _resolution_ is None else _resolution_
+    try:
+        _metric_ = metric_dict[_metric_.lower()] if _metric_ is not None else 'luminance'
+    except KeyError:
+        raise ValueError('Metric "{}" is not supported.'.format(_metric_))
+    if _view_ is None:
+        viewp = viewport_by_name(None)
+        v_props = viewport_properties(viewp, 0)
+        VIEW_TYPES = ('v', 'h', 'l', 'c', 'a')
+        _view_ = View(
+            'current_viewport', v_props['position'], v_props['direction'],
+            v_props['up_vector'], VIEW_TYPES[v_props['view_type']],
+            v_props['h_angle'], v_props['v_angle'])
+    else:
+        assert isinstance(_view_, View), 'Expected Radiance View. Got {}.'.format(type(_view_))
+
+    # process the sky input
+    if _sky_ is None:
+        _sky_ = CertainIrradiance.from_illuminance(10000)
+    elif isinstance(_sky_, str):  # convert the sky string into a sky object
+        _sky_ = string_to_sky(_sky_)
+    to_rad_int = 1 if _metric_ in ('irradiance', 'radiance') else 0
+    sky_content = _sky_.to_radiance(to_rad_int) if isinstance(_sky_, ClimateBased) \
+        else _sky_.to_radiance()
+
+    # process the _hb_objs into a Model and then a Radiance string
+    models = [obj for obj in _hb_objs if isinstance(obj, Model)]
+    other_objs = [obj for obj in _hb_objs if not isinstance(obj, Model)]
+    model = Model.from_objects('scene', other_objs, units_system(), tolerance, angle_tolerance)
+    for m in models:
+        model.add_model(m)
+    model_content, modifier_content = model.to.rad(model, minimal=True)
+
+    # set up the paths for the various files used in translation
+    scene_dir = os.path.join(folders.default_simulation_folder, 'scene_visualiztion')
+    sky_file, scene_file, mat_file = \
+        'weather.sky', 'scene.rad', 'scene.mat'
+    view_file = 'view_{}.vf'.format(_metric_)
+    write_to_file_by_name(scene_dir, sky_file, sky_content, mkdir=True)
+    write_to_file_by_name(scene_dir, scene_file, model_content)
+    write_to_file_by_name(scene_dir, mat_file, modifier_content)
+    _view_.to_file(scene_dir, view_file)
+    scene_oct, final_hdr = 'scene_visual.oct', 'scene.HDR'
+    hdr = os.path.join(scene_dir, final_hdr)
+    if os.path.isfile(hdr):
+        os.remove(hdr)
+
+    # build up the commands to render the image of the sky
+    oconv = Oconv(inputs=[sky_file, mat_file, scene_file], output=scene_oct)
+    oconv.options.f = True
+
+    rpict = Rpict(octree=scene_oct, output=final_hdr, view=view_file)
+    rpict.options.ab = 2
+    rpict.options.aa = 0.25
+    rpict.options.ad = 512
+    rpict.options.ar = 16
+    if radiance_par_:
+        rpict.options.update_from_string(radiance_par_.strip())
+    if _metric_ in ('illuminance', 'irradiance'):
+        rpict.options.i = True
+    else:
+        rpict.options.i = False
+    rpict.options.x = _resolution_
+    rpict.options.y = _resolution_
+
+    commands = [oconv, rpict]
+    if adj_expos_ or adj_expos_ is None:
+        adj_image = final_hdr.lower().replace('.hdr', '_h.HDR')
+        pcond = Pcond(input=final_hdr, output=adj_image)
+        pcond.options.h = True
+        commands.append(pcond)
+        hdr = os.path.join(scene_dir, adj_image)
+        if os.path.isfile(hdr):
+            os.remove(hdr)
+
+    # run the commands in series and load the global horizontal irradiance
+    env = None
+    if rad_folders.env != {}:
+        env = rad_folders.env
+    env = dict(os.environ, **env) if env else None
+    for r_cmd in commands:
+        r_cmd.run(env, cwd=scene_dir)

honeybee_grasshopper_radiance/src/HB Climatebased Sky.py

@@ -0,0 +1,75 @@
+# 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 point-in-time climate-based sky from a Wea.
+-
+
+    Args:
+        north_: A number between 0 and 360 that represents the degrees off from
+            the y-axis to make North. This can also be a vector to set the North.
+            Default is 0. The default North direction is the Y-axis (0 degrees).
+        _wea: A Ladybug Wea object.
+        _month_: An integer between 1 and 12 for the month of the year (default: 6).
+        _day_: An integer between 1 and 31 for the day of the month (default: 21).
+        _hour_: A number between 0 and 23.999.. for the hour of the day (default: 12).
+        colored_: Boolean to note whether the sky will be rendered in full
+            color (True) or it will simple be a grey sky with the same average
+            value as the colored sky (False). (Default: False).
+
+    Returns:
+        sky: A Honeybee sky that can be used to create a point-in-time recipe.
+"""
+
+ghenv.Component.Name = 'HB Climatebased Sky'
+ghenv.Component.NickName = 'ClimateBased'
+ghenv.Component.Message = '1.9.0'
+ghenv.Component.Category = 'HB-Radiance'
+ghenv.Component.SubCategory = '2 :: Light Sources'
+ghenv.Component.AdditionalHelpFromDocStrings = '1'
+
+try:
+    from ladybug_geometry.geometry2d.pointvector import Vector2D
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug_geometry:\n\t{}'.format(e))
+
+try:
+    from honeybee_radiance.lightsource.sky import ClimateBased
+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
+    from ladybug_rhino.togeometry import to_vector2d
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug_rhino:\n\t{}'.format(e))
+
+import math
+
+
+if all_required_inputs(ghenv.Component):
+    # process the north input
+    north_ = north_ or 0
+    try:  # it's a vector
+        north_ = math.degrees(to_vector2d(north_).angle_clockwise(Vector2D(0, 1)))
+    except AttributeError:  # north angle instead of vector
+        north_ = float(north_)
+
+    # set default values
+    _month_ = _month_ or 6
+    _day_ = _day_ or 21
+    _hour_ = 12 if _hour_ is None else _hour_
+
+    # ensure the sun position is aligned with the Wea timestep
+    if _wea.timestep == 1 and int(_hour_) == _hour_:
+        _hour_ += 0.5
+
+    # create the sky object
+    sky = ClimateBased.from_wea(
+        _wea, _month_, _day_, _hour_, north_, is_colored=colored_)

honeybee_grasshopper_radiance/src/HB Cumulative Radiation.py

@@ -0,0 +1,98 @@
+# 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>
+
+"""
+Run a cumulative radiation study for a Honeybee model.
+_
+This recipe calculates cumulative radiation (kWh/m2) and average irradiance (W/m2)
+over the time period of a specified Wea.
+_
+The fundamental calculation of this recipe is the same as that of the "LB Incident
+Radiation" component except that this recipe uses Radiance and can therefore
+account for ambient reflections. Like LB Incident Radiation, the direct sun in this
+recipe is diffused between several sky patches and so the precise line between shadow
+and sun for each hour is blurred. This approximation is acceptable for studies
+where one is only concerned about the average/total conditions over time and the
+timestep-by-timestep irradiance values do not need to be exact. For accurate
+modeling of direct irradiance on a timestep-by-timestep basis, see the "HB Annual
+Irradiance" recipe.
+
+-
+    Args:
+        _model: A Honeybee Model for which Cumulative Radiation will be simulated.
+            Note that this model should have grids assigned to it.
+        _wea: A Wea object produced from the Wea components that are under the Light
+            Sources tab. This can also be the path to a .wea or a .epw file.
+        _timestep_: An integer for the timestep of the inpput _wea. (Default: 1)
+        _sky_density_: An integer for the number of times that that the original Tregenza
+            sky patches are subdivided. 1 indicates that 145 patches are used
+            to describe the sky hemisphere, 2 indicates that 577 patches describe
+            the hemisphere, and each successive value will roughly quadruple the
+            number of patches used. Setting this to a high value will result in
+            a more accurate analysis but will take longer to run. (Default: 1).
+        north_: A number between -360 and 360 for the counterclockwise difference
+            between the North and the positive Y-axis in degrees. This can
+            also be Vector for the direction to North. (Default: 0).
+        grid_filter_: Text for a grid identifer or a pattern to filter the sensor grids of
+            the model that are simulated. For instance, first_floor_* will simulate
+            only the sensor grids that have an identifier that starts with
+            first_floor_. By default, all grids in the model will be simulated.
+        radiance_par_: Text for the radiance parameters to be used for ray
+            tracing. (Default: -ab 2 -ad 5000 -lw 2e-05).
+        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.
+        _run: Set to True to run the recipe and get results. This input can also be
+            the integer "2" to run the recipe silently.
+
+    Returns:
+        report: Reports, errors, warnings, etc.
+        avg_irr: The average irradiance in W/m2 for each sensor over the Wea time period.
+        radiation: The cumulative radiation in kWh/m2 over the Wea time period.
+"""
+
+ghenv.Component.Name = 'HB Cumulative Radiation'
+ghenv.Component.NickName = 'CumulativeRadiation'
+ghenv.Component.Message = '1.9.0'
+ghenv.Component.Category = 'HB-Radiance'
+ghenv.Component.SubCategory = '3 :: Recipes'
+ghenv.Component.AdditionalHelpFromDocStrings = '3'
+
+try:
+    from lbt_recipes.recipe import Recipe
+except ImportError as e:
+    raise ImportError('\nFailed to import lbt_recipes:\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) and _run:
+    # create the recipe and set the input arguments
+    recipe = Recipe('cumulative-radiation')
+    recipe.input_value_by_name('model', _model)
+    recipe.input_value_by_name('wea', _wea)
+    recipe.input_value_by_name('timestep', _timestep_)
+    recipe.input_value_by_name('sky-density', _sky_density_)
+    recipe.input_value_by_name('north', north_)
+    recipe.input_value_by_name('grid-filter', grid_filter_)
+    recipe.input_value_by_name('radiance-parameters', radiance_par_)
+
+    # run the recipe
+    silent = True if _run > 1 else False
+    project_folder = recipe.run(run_settings_, radiance_check=True, silent=silent)
+
+    # load the results
+    try:
+        avg_irr = recipe_result(recipe.output_value_by_name('average-irradiance', project_folder))
+        radiation = recipe_result(recipe.output_value_by_name('cumulative-radiation', project_folder))
+    except Exception:
+        raise Exception(recipe.failure_message(project_folder))

honeybee_grasshopper_radiance/src/HB Custom Sky.py

@@ -0,0 +1,74 @@
+# 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 Custom sky from direct and diffuse irradiance.
+-
+
+    Args:
+        north_: A number between 0 and 360 that represents the degrees off from
+            the y-axis to make North. This can also be a vector to set the North.
+            Default is 0. The default North direction is the Y-axis (0 degrees).
+        _location: A Ladybug location object.
+        _dir_rad: Direct normal irradiance (W/m2).
+        _diff_rad: Diffuse horizontal irradiance (W/m2).
+        _month_: An integer between 1 and 12 for the month of the year (default: 6).
+        _day_: An integer between 1 and 31 for the day of the month (default: 21).
+        _hour_: A number between 0 and 23.999 for the hour of the day (default: 12).
+        colored_: Boolean to note whether the sky will be rendered in full
+            color (True) or it will simple be a grey sky with the same average
+            value as the colored sky (False). (Default: False).
+
+    Returns:
+        sky: Honeybee sky. You can use this sky to create a daylight recipe.
+"""
+
+ghenv.Component.Name = 'HB Custom Sky'
+ghenv.Component.NickName = 'CustomSky'
+ghenv.Component.Message = '1.9.0'
+ghenv.Component.Category = 'HB-Radiance'
+ghenv.Component.SubCategory = '2 :: Light Sources'
+ghenv.Component.AdditionalHelpFromDocStrings = '1'
+
+try:
+    from ladybug_geometry.geometry2d.pointvector import Vector2D
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug_geometry:\n\t{}'.format(e))
+
+try:
+    from honeybee_radiance.lightsource.sky import ClimateBased
+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
+    from ladybug_rhino.togeometry import to_vector2d
+except ImportError as e:
+    raise ImportError('\nFailed to import ladybug_rhino:\n\t{}'.format(e))
+
+import math
+
+
+if all_required_inputs(ghenv.Component):
+    # process the north input
+    north_ = north_ or 0
+    try:  # it's a vector
+        north_ = math.degrees(to_vector2d(north_).angle_clockwise(Vector2D(0, 1)))
+    except AttributeError:  # north angle instead of vector
+        north_ = float(north_)
+
+    # set default values if they are not set
+    _month_ = _month_ or 6
+    _day_ = _day_ or 21
+    _hour_ = 12 if _hour_ is None else _hour_
+
+    # create the sky object
+    sky = ClimateBased.from_location(
+        _location, _month_, _day_, _hour_, _dir_rad, _diff_rad, north_,
+        is_colored=colored_)