Skip to content

Commit

Permalink
fix(analyze): Update docstring to align with core libraries
Browse files Browse the repository at this point in the history
  • Loading branch information
chriswmackey committed May 31, 2024
1 parent 90182bd commit 7c4ab2d
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 8 deletions.
Binary file modified ladybug_grasshopper/icon/LB Adaptive Comfort Parameters.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions ladybug_grasshopper/json/LB_Adaptive_Comfort_Parameters.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "1.8.0",
"version": "1.8.1",
"nickname": "AdaptPar",
"outputs": [
[
Expand All @@ -16,14 +16,14 @@
{
"access": "item",
"name": "_ashrae_or_en_",
"description": "A boolean to note whether to use the ASHRAE-55 neutral\ntemperature function (True) or the european neutral function (False),\nwhich is consistent with both EN-15251 and EN-16798. Note that this\ninput will also determine default values for many of the other\nproperties of this object.",
"description": "A boolean to note whether to use the ASHRAE-55 neutral\ntemperature function (True) or the european neutral function (False),\nwhich is consistent with EN-16798 (and the older EN-15251).\nPreference is given to EN-16798 in places where EN-16798 and\nEN-15251 differ (eg. the 1C lower cold threshold in EN-16798).\nNote that this input will also determine default values for\nmany of the other properties of this object.",
"type": "bool",
"default": null
},
{
"access": "item",
"name": "_neutral_offset_",
"description": "The number of degrees Celcius from the neutral temperature\nwhere the input operative temperature is considered acceptable.\nThe default is 2.5C when the neutral temperature function is ASHRAE-55\n(consistent with 90% PPD) and 3C when the neutral temperature\nfunction is EN (consistent with comfort class II).\n_\nFor ASHRAE-55, the following neutral offsets apply.\n* 90 PPD - 2.5C\n* 80 PPD - 3.5C\n_\nFor the EN standard, the following neutral offsets apply.\n* Class I - 2C\n* Class II - 3C\n* Class III - 4C",
"description": "The number of degrees Celcius from the neutral temperature\nwhere the input operative temperature is considered acceptable.\nThe default is 2.5C when the neutral temperature function is ASHRAE-55\n(consistent with 90% PPD) and 3C when the neutral temperature\nfunction is EN-16798 (consistent with comfort class II). Note that,\nwhen the neutral temperature function is EN-16798, one degree\nCelsius is automatically added to the offset value input here to\nget the lower temperature threshold. This accounts for the fact that\nEN-16798 does not interpret the neutral offset symmetically.\n_\nFor ASHRAE-55, the following neutral offsets apply.\n* 90 PPD - 2.5C\n* 80 PPD - 3.5C\n_\nFor the EN standard, the following neutral offsets apply.\n* Class I - 2C\n* Class II - 3C\n* Class III - 4C",
"type": "double",
"default": null
},
Expand Down
16 changes: 11 additions & 5 deletions ladybug_grasshopper/src/LB Adaptive Comfort Parameters.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,20 @@
Args:
_ashrae_or_en_: A boolean to note whether to use the ASHRAE-55 neutral
temperature function (True) or the european neutral function (False),
which is consistent with both EN-15251 and EN-16798. Note that this
input will also determine default values for many of the other
properties of this object.
which is consistent with EN-16798 (and the older EN-15251).
Preference is given to EN-16798 in places where EN-16798 and
EN-15251 differ (eg. the 1C lower cold threshold in EN-16798).
Note that this input will also determine default values for
many of the other properties of this object.
_neutral_offset_: The number of degrees Celcius from the neutral temperature
where the input operative temperature is considered acceptable.
The default is 2.5C when the neutral temperature function is ASHRAE-55
(consistent with 90% PPD) and 3C when the neutral temperature
function is EN (consistent with comfort class II).
function is EN-16798 (consistent with comfort class II). Note that,
when the neutral temperature function is EN-16798, one degree
Celsius is automatically added to the offset value input here to
get the lower temperature threshold. This accounts for the fact that
EN-16798 does not interpret the neutral offset symmetically.
_
For ASHRAE-55, the following neutral offsets apply.
* 90 PPD - 2.5C
Expand Down Expand Up @@ -71,7 +77,7 @@

ghenv.Component.Name = 'LB Adaptive Comfort Parameters'
ghenv.Component.NickName = 'AdaptPar'
ghenv.Component.Message = '1.8.0'
ghenv.Component.Message = '1.8.1'
ghenv.Component.Category = 'Ladybug'
ghenv.Component.SubCategory = '4 :: Extra'
ghenv.Component.AdditionalHelpFromDocStrings = '4'
Expand Down
Binary file not shown.

0 comments on commit 7c4ab2d

Please sign in to comment.