NREL / resstock

Highly granular modeling of residential building stocks at national, regional, and local scales using OpenStudio/EnergyPlus.
https://resstock.nrel.gov
Other
103 stars 51 forks source link

RTD: summarize lookup arguments #1146

Closed joseph-robertson closed 7 months ago

joseph-robertson commented 8 months ago

Pull Request Description

This PR:


image


image

Checklist

Not all may apply:

shorowit commented 8 months ago

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.

shorowit commented 8 months ago

Related: https://github.com/NREL/OpenStudio-HPXML/issues/1518

joseph-robertson commented 8 months ago

Suggestion from @afontani: We probably want to link to argument descriptions.

joseph-robertson commented 8 months ago

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., HVAC Heating Efficiency -> HPXML Heating Systems, HPXML Heat Pumps).

Edit: related to https://github.com/NREL/OpenStudio-HPXML/issues/1252.

joseph-robertson commented 7 months ago

Need to either (A) wait for source_report formatting updates, or (B) fix some of the list item indentation issues.