fix(visualize): Improve the description of radiation benefit sky

ladybug_grasshopper/json/LB_Benefit_Sky_Matrix.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.6.0", 
+  "version": "1.6.1", 
   "nickname": "BenefitMatrix", 
   "outputs": [
     [
@@ -95,5 +95,5 @@
   "code": "\nimport math\n\ntry:\n    from ladybug_geometry.geometry2d.pointvector import Vector2D\nexcept ImportError as e:\n    raise ImportError('\\nFailed to import ladybug_geometry:\\n\\t{}'.format(e))\n\ntry:\n    from ladybug_radiance.skymatrix import SkyMatrix\nexcept ImportError as e:\n    raise ImportError('\\nFailed to import ladybug:\\n\\t{}'.format(e))\n\ntry:\n    from ladybug_{{cad}}.togeometry import to_vector2d\n    from ladybug_{{cad}}.{{plugin}} import all_required_inputs\nexcept ImportError as e:\n    raise ImportError('\\nFailed to import ladybug_{{cad}}:\\n\\t{}'.format(e))\n\ntry:\n    from lbt_recipes.version import check_radiance_date\nexcept ImportError as e:\n    raise ImportError('\\nFailed to import honeybee_radiance:\\n\\t{}'.format(e))\n\n# check the istalled Radiance date and get the path to the gemdaymtx executable\ncheck_radiance_date()\n\n\nif all_required_inputs(ghenv.Component):\n    # process and set defaults for all of the global inputs\n    _bal_temp_ = 15 if _bal_temp_ is None else _bal_temp_\n    _bal_offset_ = 2 if _bal_offset_ is None else _bal_offset_\n    if north_ is not None:  # process the north_\n        try:\n            north_ = math.degrees(\n                to_vector2d(north_).angle_clockwise(Vector2D(0, 1)))\n        except AttributeError:  # north angle instead of vector\n            north_ = float(north_)\n    else:\n        north_ = 0\n    ground_r = 0.2 if _ground_ref_ is None else _ground_ref_\n\n    # create the sky matrix object\n    sky_mtx = SkyMatrix.from_components_benefit(\n        _location, _direct_rad, _diffuse_rad, _temperature, _bal_temp_, _bal_offset_,\n        _hoys_, north_, high_density_, ground_r)\n    if _folder_:\n        sky_mtx.folder = _folder_\n", 
   "category": "Ladybug", 
   "name": "LB Benefit Sky Matrix", 
-  "description": "Get a matrix representing the benefit/harm of radiation based on temperature data.\n_\nRadiation benefit matrices are helpful for evaluating building massing and facade\ndesigns in terms of passive solar heat gain vs. cooling energy increase.\n_\nThis component uses Radiance's gendaymtx function to calculate the radiation\nfor each patch of the sky. Gendaymtx is written by Ian Ashdown and Greg Ward.\nMorere information can be found in Radiance manual at:\nhttp://www.radiance-online.org/learning/documentation/manual-pages/pdfs/gendaymtx.pdf\n-"
+  "description": "Get a matrix representing the benefit/harm of radiation based on temperature data.\n_\nWhen this sky matrix is used in radiation studies or to produce radiation graphics,\npositive values represent helpful wintertime sun energy that can offset heating loads\nduring cold temperatures while negative values represent harmful summertime sun\nenergy that can increase cooling loads during hot temperatures.\n_\nRadiation benefit skies are particularly helpful for evaluating building massing\nand facade designs in terms of passive solar heat gain vs. cooling energy increase.\n_\nThis component uses Radiance's gendaymtx function to calculate the radiation\nfor each patch of the sky. Gendaymtx is written by Ian Ashdown and Greg Ward.\nMorere information can be found in Radiance manual at:\nhttp://www.radiance-online.org/learning/documentation/manual-pages/pdfs/gendaymtx.pdf\n-"
 }

ladybug_grasshopper/src/LB Benefit Sky Matrix.py

@@ -10,8 +10,13 @@
 """
 Get a matrix representing the benefit/harm of radiation based on temperature data.
 _
-Radiation benefit matrices are helpful for evaluating building massing and facade
-designs in terms of passive solar heat gain vs. cooling energy increase.
+When this sky matrix is used in radiation studies or to produce radiation graphics,
+positive values represent helpful wintertime sun energy that can offset heating loads
+during cold temperatures while negative values represent harmful summertime sun
+energy that can increase cooling loads during hot temperatures.
+_
+Radiation benefit skies are particularly helpful for evaluating building massing
+and facade designs in terms of passive solar heat gain vs. cooling energy increase.
 _
 This component uses Radiance's gendaymtx function to calculate the radiation
 for each patch of the sky. Gendaymtx is written by Ian Ashdown and Greg Ward.
@@ -69,7 +74,7 @@
 
 ghenv.Component.Name = 'LB Benefit Sky Matrix'
 ghenv.Component.NickName = 'BenefitMatrix'
-ghenv.Component.Message = '1.6.0'
+ghenv.Component.Message = '1.6.1'
 ghenv.Component.Category = 'Ladybug'
 ghenv.Component.SubCategory = '2 :: Visualize Data'
 ghenv.Component.AdditionalHelpFromDocStrings = '3'