RTD: summarize lookup arguments #1146
Conversation
joseph-robertson
changed the title
|
I realize you've already gone down a certain path and I'm coming to it late, but I can't help but wonder if it would be simpler to just include every argument in the options_lookup.tsv somewhere. Could even write a test to make sure they are all covered. |
|
Related: NREL/OpenStudio-HPXML#1518 |
|
We need to better orient readers of the Housing Characteristics page to the idea of "auto" and what that means, how things connect to OS-HPXML documentation and HPXML fields, etc. We should have a paragraph up front on "auto", and then for each ResStock parameter we should have link(s) to the related OS-HPXML documentation sections (e.g., Edit: related to NREL/OpenStudio-HPXML#1252. |
…4f5ab e4788c4f5ab Update build measure argument descriptions with links to docs. 02207f7a83c Merge pull request #1540 from NREL/deprecation-msgs b251c34b737 Adds error messages for all extension elements that have been moved/deprecated since v1.0, so that the input is not silently ignored. No need to do this for non-extension elements since the XSD Schema will report errors for these situations. 5889de415f7 Update unit tests. 0f813a83fe1 Hotfix for recirc energy when multiple water heaters. 51f9d2fde58 Merge pull request #1537 from NREL/ground_temperatures2 c45fa9de0fb Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into ground_temperatures2 6598ab6059d Merge pull request #1539 from NREL/fix_system_use 053e9130f24 Fix CI failures. 54280437497 Run update_measures. fb2bf8fb803 Merge branch 'ground_temperatures2' of github.com:NREL/OpenStudio-HPXML into ground_temperatures2 4063887f5d0 Accept nearest station in xing lookup. 9d9ad3647d7 Add comment [ci skip] 1043ac2d1b9 Fix comment [ci skip] 2b0d89bf4ba Fix possible incorrect value for system use, bug introduced in #1456. Adds error-checking to prevent this going forward. Some other minor misc cleanup. d4ed83b6688 Merge branch 'ground_temperatures2' of github.com:NREL/OpenStudio-HPXML into ground_temperatures2 54d28d2ce6b Skip deep ground temp calcs if no gshp. b00bb924031 Add test for defaulting xing values. 3a783ad4a25 Respond to review. 23f6e542ea5 Latest results. 71ac84dff44 Merge branch 'master' into ground_temperatures2 98ace8d4ac0 Update the changelog. [ci skip] 9cd53e49d11 Merge pull request #1538 from NREL/misc_cleanup e24568fd749 Latest results. 951dc933449 Misc cleanup. 092d4981415 Latest results. 3370a534320 Convert new csv to utf8. cde1f9aaab2 Get the units right. 27148f692cf Missed a return. 533d2926d78 Update the changelog. 4a6174d571f Assign deep ground variables and use throughout. 1fbc7087565 Add deep temperature lookup based on xing model. 6c91ec33ac5 Revert shallow and deep ground temperature conflation. 4127a5dcb4a Merge pull request #1536 from NREL/split_workflow_tests 00b8d21b992 Remove old files. [ci skip] fd88b9696ce Latest results. 004c05172b3 Fix CI failure d2a87c7e3aa Update pull_request_template.md [ci skip] ab259ce187a Split workflow tests, so they can be parallelized on the CI for faster turnaround time. git-subtree-dir: resources/hpxml-measures git-subtree-split: e4788c4f5ab76ae809a1a008a97d6fe85889396e
…ca1ee 2cd420ca1ee Few more href updates. 445d7a40a43 Replace all measure descriptions with href. a2fcdf2c809 Update readme erb to convert href to markdown. 1c6fd3dce40 Try an argument description with href. git-subtree-dir: resources/hpxml-measures git-subtree-split: 2cd420ca1ee40655527889d048afa833f2be67d2
…f2692 111190f2692 Fix a few typos. git-subtree-dir: resources/hpxml-measures git-subtree-split: 111190f2692bca07a219d40e1e175e8365ec1aa8
| - **Name** | ||
| - **Units** | ||
| - **Choices** | ||
| - **Description** |
There was a problem hiding this comment.
Look at BuildResHPXML/measure.xml to get: either (A) Choices gets updated with "auto" and "type" or (B) Type, and then (C) Required (Yes or No, so that we can populate "auto" when it's not a choice argument). Optional here is to populate "true" and "false" in the Choices column for bool arguments.
There was a problem hiding this comment.
I'm writing the following columns to the Arguments table, in the following order:
- Name
- Required (comes from BuildResidentialHPXML)
- Units
- Type (comes from BuildResidentialHPXML)
- Choices
- all optional choice arguments have "auto" in addition to all other choices
- all optional boolean arguments have "auto", "true", "false"
- add "auto" choice if "OS-HPXML default" string in the Description and Type is string/double/integer
- Description
| @@ -46,4 +112,46 @@ def to_underscore_case | |||
| write_subsection(f, row, 'Created by', '*') | |||
| write_subsection(f, row, 'Source', '*') | |||
| write_subsection(f, row, 'Assumption', '*') | |||
There was a problem hiding this comment.
Assumptions? Handle this on the resstock-estimation side. These should probably not be hard-coded here.
|
Need to either (A) wait for source_report formatting updates, or (B) fix some of the list item indentation issues. |
Pull Request Description
This PR:
<arg_name>=auto) tooptions_lookup.tsvso that every ResStockArguments argument is included.options_lookup.tsv.options_lookup.tsv(including Name, Required, Units, Type, Choices, Description). See below for example.README.md.erbto all ResStock measures so thatREADME.mddocumentation is automatically generated.Housing Characteristicsfor describing subsections and the "auto" argument choice. See below.Checklist
Not all may apply:
Tests (and test files) have been updatedIf related to resstock-estimation, checklist includes data dictionary, source report, options saturation, options_lookup.openstudio tasks.rb update_measureshas been run