Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add to the workflow_inputs section of RTD #1193

Open
wants to merge 15 commits into
base: develop
Choose a base branch
from

Conversation

lixiliu
Copy link
Contributor

@lixiliu lixiliu commented Jan 19, 2024

Pull Request Description

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

  • ACS data for num_buildings_represented
  • Utility bill calculation methodology and data sources
  • Emissions scenarios

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

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

@lixiliu lixiliu self-assigned this Jan 19, 2024
@lixiliu lixiliu requested a review from afontani January 19, 2024 01:30
@lixiliu lixiliu added the docs label Jan 19, 2024
@afontani
Copy link
Contributor

@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.

@lixiliu
Copy link
Contributor Author

lixiliu commented Jan 26, 2024

@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.

Copy link
Contributor

@afontani afontani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we move the documentation to the Read-the-Docs instead of the Readme?

@afontani afontani changed the title add Census dwelling unit count table as a resource Add to the workflow_inputs section of RTD Mar 1, 2024
@joseph-robertson joseph-robertson self-requested a review May 29, 2024 19:54
Copy link
Contributor

@joseph-robertson joseph-robertson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the plan/status for this PR?

Should we open a new ticket for addressing the Emissions and Utility Bills updates in the future? (Note that the Workflow Outputs section already contains Emissions and Utility Bills subsections.)

Comment on lines +8 to +10
<<<<<<< HEAD
- Add Census dwelling unit count by state table in resstock/resources/ folder ([#1193](https://github.com/NREL/resstock/pull/1193))
=======
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some merge conflicts going on here.

@@ -1,6 +1,6 @@
.. _housing_characteristics:

Housing Characteristics
Housing Characteristics Distributions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you need to make this change instead in docs/read_the_docs/source/workflow_inputs/create_characteristics_rst.rb -- this script automatically generates characteristics.rst.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants