Adding options and option arguments to Read the Docs

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

Adding options and option arguments to Read the Docs #1249

Closed afontani closed 4 weeks ago

afontani commented 1 month ago

Pull Request Description

Adding to the read the docs documentation by articulating the options in project national and the arguments specified. One can now look at the descriptions of the arguments and documentation linked to OS-HPXML and see what arguments are currently being used in the baseline stock.

The updates combines two files automatically: "options_lookup.tsv" and the "project_national/resuources/options_saturations.csv"

Screenshot of the new options being rendered for Clothes Dryer. Screenshot 2024-05-31 at 3 45 41 PM

Checklist

Not all may apply:

[x] Tests (and test files) have been updated
[x] Documentation has been updated
- [x] If related to resstock-estimation, checklist includes data dictionary, source report, options saturation, options_lookup.
[x] Changelog has been updated ~~- [ ] openstudio tasks.rb update_measures has been run~~ ~~- [ ] No unexpected regression test changes on CI (checked comparison artifacts)~~

joseph-robertson commented 1 month ago

Suggest we bold the Name entries in the Arguments section instead of inline literals (?). Also suggest we remove double quotes around Choices entries in the Arguments section (maybe there'd be some challenges around any choices with commas in them?).

afontani commented 1 month ago

Suggest we bold the Name entries in the Arguments section instead of inline literals (?). Also suggest we remove double quotes around Choices entries in the Arguments section (maybe there'd be some challenges around any choices with commas in them?).

addressed in c90b692

joseph-robertson commented 1 month ago

I like the idea of distinguishing "Option name" and "Stock saturation" in the Options table from the other columns (which are argument variables) by bold vs inline literals. But too bad the arguments are bold since they are column headers; maybe they could also be bold in the Arguments table.

afontani commented 1 month ago

I like the idea of distinguishing "Option name" and "Stock saturation" in the Options table from the other columns (which are argument variables) by bold vs inline literals. But too bad the arguments are bold since they are column headers; maybe they could also be bold in the Arguments table.

Addressed: a8c51ab

joseph-robertson commented 3 weeks ago

Late comment, but I'm now realizing that we didn't include anything in the Housing Characteristics intro about the new Options table.