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

Add to the workflow_inputs section of RTD #1193

Open lixiliu opened 5 months ago

lixiliu commented 5 months ago

Pull Request Description

This PR updates the RTD workflow_inputs documentation. The section now specifically provides resources for:

This PR removes details about modifying and writing TSVs as this is done automatically in the resstock-estimation repository.

Checklist

Not all may apply:

- [ ] Tests (and test files) have been updated

afontani commented 5 months ago

@lixiliu : Thinking about this a little. I have a few thoughts:

Let me know what path you prefer.

lixiliu commented 5 months ago

@lixiliu : Thinking about this a little. I have a few thoughts:

  • This information is available with our spatial lookup tables and then scaled to the n_buildings_represented value in the project yaml or the ACS vintages.
  • If the above resource is not good enough for your uses, I would like for this file to get automatically generated in CI and committed in the "latest commit".
  • Also why State level, what about for every "County and PUMA", this way County, PUMA, and State Counts can easily be aggregated.

Let me know what path you prefer.

Summary of our discussion offline: The table is meant as a lookup for n_buildings_represented, not duplicating our spatial tables or tsvs. A "resources" section will be added to README to highlight this file as well as other useful things we've been adding to ResStock to enhance understanding or workflow.