8000 RTD: summarize lookup arguments · Issue #203 · Test-Cloned-Org/resstock · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

RTD: summarize lookup arguments #203

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

Open
4 of 6 tasks
willf opened this issue Feb 12, 2025 · 0 comments
Open
4 of 6 tasks

RTD: summarize lookup arguments #203

willf opened this issue Feb 12, 2025 · 0 comments
Labels

Comments

@willf
Copy link
willf commented Feb 12, 2025

Pull Request Description

This PR:

  • Adds remaining arguments (i.e., <arg_name>=auto) to options_lookup.tsv so that every ResStockArguments argument is included.
  • Adds a unit test to ensure that all ResStock arguments are called out in options_lookup.tsv.
  • By housing characteristic parameter, automates summarizing Arguments sets used in options_lookup.tsv (including Name, Required, Units, Type, Choices, Description). See below for example.
  • Adds a README.md.erb to all ResStock measures so that README.md documentation is automatically generated.
  • Adds introduction in Housing Characteristics for describing subsections and the "auto" argument choice. See below.

image


image

Checklist

Not all may apply:

  • Tests (and test files) have been updated
  • Documentation has been updated
  • Changelog has been updated
  • openstudio tasks.rb update_measures has been run
  • No unexpected regression test changes on CI (checked comparison artifacts)

Source: NREL on 2023-10-12.

@willf willf added the docs label Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant
0