-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(docs): Fix docstrings so the input description shows up
- Loading branch information
1 parent
e4c5caa
commit f8f2fcc
Showing
4 changed files
with
29 additions
and
29 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 26 additions & 26 deletions
52
honeybee_grasshopper_energy/json/HB_Sizing_Parameter.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,71 +1,71 @@ | ||
| { | ||
| "description": "Create parameters with criteria for sizing the heating and cooling system.\n-", | ||
| "version": "1.7.2", | ||
| "nickname": "SizingPar", | ||
| "outputs": [ | ||
| [ | ||
| { | ||
| "type": null, | ||
| "access": "None", | ||
| "name": "sizing", | ||
| "description": "Parameters with criteria for sizing the heating and cooling system.\nThese can be connected to the \"HB Simulation Parameter\" component in\norder to specify settings for the EnergyPlus simulation.", | ||
| "access": "None", | ||
| "type": null, | ||
| "default": null | ||
| } | ||
| ] | ||
| ], | ||
| "code": "\ntry:\n from honeybee_energy.simulation.sizing import SizingParameter\nexcept ImportError as e:\n raise ImportError('\\nFailed to import honeybee_energy:\\n\\t{}'.format(e))\n\ntry:\n from ladybug_{{cad}}.{{plugin}} import turn_off_old_tag\nexcept ImportError as e:\n raise ImportError('\\nFailed to import ladybug_{{cad}}:\\n\\t{}'.format(e))\nturn_off_old_tag(ghenv.Component)\n\n\n# dictionary to get correct efficiency standards\nEFF_STANDARDS = {\n 'DOE_Ref_Pre_1980': 'DOE_Ref_Pre_1980',\n 'DOE_Ref_1980_2004': 'DOE_Ref_1980_2004',\n 'ASHRAE_2004': 'ASHRAE_2004',\n 'ASHRAE_2007': 'ASHRAE_2007',\n 'ASHRAE_2010': 'ASHRAE_2010',\n 'ASHRAE_2013': 'ASHRAE_2013',\n 'ASHRAE_2016': 'ASHRAE_2016',\n 'ASHRAE_2019': 'ASHRAE_2019',\n 'pre_1980': 'DOE_Ref_Pre_1980',\n '1980_2004': 'DOE_Ref_1980_2004',\n '2004': 'ASHRAE_2004',\n '2007': 'ASHRAE_2007',\n '2010': 'ASHRAE_2010',\n '2013': 'ASHRAE_2013',\n '2016': 'ASHRAE_2016',\n '2019': 'ASHRAE_2019'\n}\n\n# set default sizing factors\nheating_fac = 1.25 if _heating_fac_ is None else _heating_fac_\ncooling_fac = 1.15 if _cooling_fac_ is None else _cooling_fac_\n\n# create the object\nsizing = SizingParameter(None, heating_fac, cooling_fac)\n\n# apply design days from ddy\nif ddy_file_ is not None:\n if filter_ddays_ == 1:\n sizing.add_from_ddy_996_004(ddy_file_)\n elif filter_ddays_ == 2:\n sizing.add_from_ddy_990_010(ddy_file_)\n else:\n sizing.add_from_ddy(ddy_file_)\n\n# set the efficiency standard if provided\nif eff_standard_ is not None:\n sizing.efficiency_standard = EFF_STANDARDS[eff_standard_]\nif climate_zone_ is not None:\n sizing.climate_zone = climate_zone_\nif bldg_type_ is not None:\n sizing.building_type = bldg_type_\n", | ||
| "name": "HB Sizing Parameter", | ||
| "version": "1.7.1", | ||
| "category": "HB-Energy", | ||
| "subcategory": "5 :: Simulate", | ||
| "nickname": "SizingPar", | ||
| "inputs": [ | ||
| { | ||
| "type": "string", | ||
| "access": "item", | ||
| "name": "ddy_file_", | ||
| "description": "An optional path to a .ddy file on your system, which contains\ninformation about the design days used to size the hvac system. If None,\nhoneybee will look for a .ddy file next to the .epw and extract all\n99.6% and 0.4% design days.", | ||
| "access": "item", | ||
| "type": "string", | ||
| "default": null | ||
| }, | ||
| { | ||
| "type": "int", | ||
| "access": "item", | ||
| "name": "filter_ddays_", | ||
| "description": "Boolean to note whether the design days in the ddy_file_\nshould be filtered to only include 99.6% and 0.4% design days. If None\nor False, all design days in the ddy_file_ will be incorporated into\nthe sizing parameters. This can also be the integer 2 to filter for\n99.0% and 1.0% design days.", | ||
| "access": "item", | ||
| "type": "int", | ||
| "default": null | ||
| }, | ||
| { | ||
| "type": "double", | ||
| "access": "item", | ||
| "name": "_heating_fac_", | ||
| "description": "A number that will get multiplied by the peak heating load\nfor each zone in the model in order to size the heating system for\nthe model. Must be greater than 0. (Default: 1.25).", | ||
| "access": "item", | ||
| "type": "double", | ||
| "default": null | ||
| }, | ||
| { | ||
| "type": "double", | ||
| "access": "item", | ||
| "name": "_cooling_fac_", | ||
| "description": "A number that will get multiplied by the peak cooling load\nfor each zone in the model in order to size the cooling system for\nthe model. Must be greater than 0. (Default: 1.15).", | ||
| "access": "item", | ||
| "type": "double", | ||
| "default": null | ||
| }, | ||
| { | ||
| "type": "string", | ||
| "access": "item", | ||
| "name": "eff_standard_", | ||
| "description": "Text to specify the efficiency standard, which will automatically\nset the efficiencies of all HVAC equipment when provided. Note that\nproviding a standard here will cause the OpenStudio translation\nprocess to perform an additional sizing calculation with EnergyPlus,\nwhich is needed since the default efficiencies of equipment vary\ndependingon their size. THIS WILL SIGNIFICANTLY INCREASE\nTRANSLATION TIME TO OPENSTUDIO. However, it is often\nworthwhile when the goal is to match the HVAC specification with a\nparticular standard. The \"HB Building Vintages\" component has a full\nlist of supported HVAC efficiency standards. You can also choose\nfrom the following.\n* DOE_Ref_Pre_1980\n* DOE_Ref_1980_2004\n* ASHRAE_2004\n* ASHRAE_2007\n* ASHRAE_2010\n* ASHRAE_2013\n* ASHRAE_2016\n* ASHRAE_2019", | ||
| "access": "item", | ||
| "type": "string", | ||
| "default": null | ||
| }, | ||
| { | ||
| "type": "string", | ||
| "name": "climate_zone_", | ||
| "description": "Script variable SizingPar", | ||
| "access": "item", | ||
| "name": "climate_zone_", | ||
| "description": "Text indicating the ASHRAE climate zone to be used with the\nefficiency_standard. When unspecified, the climate zone will be\ninferred from the design days. This input can be a single\ninteger (in which case it is interpreted as A) or it can include the\nA, B, or C qualifier (eg. 3C). Typically, the \"LB Import STAT\"\ncomponent can yield the climate zone for a particular location.", | ||
| "type": "string", | ||
| "default": null | ||
| }, | ||
| { | ||
| "type": "string", | ||
| "name": "bldg_type_", | ||
| "description": "Script variable SizingPar", | ||
| "access": "item", | ||
| "name": "bldg_type_", | ||
| "description": "Text for the building type to be used in the efficiency_standard.\nIf the type is not recognized or is None, it will be assumed that the\nbuilding is a generic NonResidential. The following have meaning\nfor the standard.\n* NonResidential\n* Residential\n* MidriseApartment\n* HighriseApartment\n* LargeOffice\n* MediumOffice\n* SmallOffice\n* Retail\n* StripMall\n* PrimarySchool\n* SecondarySchool\n* SmallHotel\n* LargeHotel\n* Hospital\n* Outpatient\n* Warehouse\n* SuperMarket\n* FullServiceRestaurant\n* QuickServiceRestaurant\n* Laboratory\n* Courthouse", | ||
| "type": "string", | ||
| "default": null | ||
| } | ||
| ] | ||
| ], | ||
| "subcategory": "5 :: Simulate", | ||
| "code": "\ntry:\n from honeybee_energy.simulation.sizing import SizingParameter\nexcept ImportError as e:\n raise ImportError('\\nFailed to import honeybee_energy:\\n\\t{}'.format(e))\n\ntry:\n from ladybug_{{cad}}.{{plugin}} import turn_off_old_tag\nexcept ImportError as e:\n raise ImportError('\\nFailed to import ladybug_{{cad}}:\\n\\t{}'.format(e))\nturn_off_old_tag(ghenv.Component)\n\n\n# dictionary to get correct efficiency standards\nEFF_STANDARDS = {\n 'DOE_Ref_Pre_1980': 'DOE_Ref_Pre_1980',\n 'DOE_Ref_1980_2004': 'DOE_Ref_1980_2004',\n 'ASHRAE_2004': 'ASHRAE_2004',\n 'ASHRAE_2007': 'ASHRAE_2007',\n 'ASHRAE_2010': 'ASHRAE_2010',\n 'ASHRAE_2013': 'ASHRAE_2013',\n 'ASHRAE_2016': 'ASHRAE_2016',\n 'ASHRAE_2019': 'ASHRAE_2019',\n 'pre_1980': 'DOE_Ref_Pre_1980',\n '1980_2004': 'DOE_Ref_1980_2004',\n '2004': 'ASHRAE_2004',\n '2007': 'ASHRAE_2007',\n '2010': 'ASHRAE_2010',\n '2013': 'ASHRAE_2013',\n '2016': 'ASHRAE_2016',\n '2019': 'ASHRAE_2019'\n}\n\n# set default sizing factors\nheating_fac = 1.25 if _heating_fac_ is None else _heating_fac_\ncooling_fac = 1.15 if _cooling_fac_ is None else _cooling_fac_\n\n# create the object\nsizing = SizingParameter(None, heating_fac, cooling_fac)\n\n# apply design days from ddy\nif ddy_file_ is not None:\n if filter_ddays_ == 1:\n sizing.add_from_ddy_996_004(ddy_file_)\n elif filter_ddays_ == 2:\n sizing.add_from_ddy_990_010(ddy_file_)\n else:\n sizing.add_from_ddy(ddy_file_)\n\n# set the efficiency standard if provided\nif eff_standard_ is not None:\n sizing.efficiency_standard = EFF_STANDARDS[eff_standard_]\nif climate_zone_ is not None:\n sizing.climate_zone = climate_zone_\nif bldg_type_ is not None:\n sizing.building_type = bldg_type_\n", | ||
| "category": "HB-Energy", | ||
| "name": "HB Sizing Parameter", | ||
| "description": "Create parameters with criteria for sizing the heating and cooling system.\n-" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file modified
BIN
+32 Bytes
(100%)
honeybee_grasshopper_energy/user_objects/HB Sizing Parameter.ghuser
Binary file not shown.