ResStock-HPXML: timeseries end convention

[joseph-robertson]

Pull Request Description

Adds support for new timeseries_timestamp_convention argument of the ReportSimulationOutput measure. See NREL/resstock#999 for context.

Checklist

Not all may apply

• Code changes (must work)
• Tests exercising your feature/bug fix (check coverage report on Checks -> BuildStockBatch Tests -> Artifacts)
• Coverage has increased or at least not decreased. Update minimum_coverage in .github/workflows/ci.yml as necessary.
• All other unit tests passing
• Update validation for project config yaml file changes
• Update existing documentation
• Run a small batch run to make sure it all works (local is fine, unless an Eagle specific feature)
• Add to the changelog_dev.rst file and propose migration text in the pull request

[github-actions]

File	Coverage
All files	81%	✅
base.py	81%	✅
eagle.py	74%	✅
exc.py	57%	✅
localdocker.py	44%	✅
postprocessing.py	84%	✅
utils.py	96%	✅
sampler/base.py	69%	✅
sampler/downselect.py	33%	✅
sampler/precomputed.py	93%	✅
sampler/residential_quota.py	50%	✅
test/test_validation.py	96%	✅
workflow_generator/base.py	90%	✅
workflow_generator/commercial.py	53%	✅
workflow_generator/residential.py	96%	✅
workflow_generator/residential_hpxml.py	36%	✅

Minimum allowed coverage is 24%

Generated by 🐒 cobertura-action against 10ae5c3

[afontani]

@joseph-robertson: How does this relate to this PR in buildstockbatch: #301

[joseph-robertson]

@joseph-robertson: How does this relate to this PR in buildstockbatch: #301

NREL/OpenStudio-HPXML#1198 changed default to start of timestamp convention. This PR will maintain (existing) behavior of the end of timestamp convention.

So I believe instead of #301 you'd be able to control timestamp convention from the yml.

[joseph-robertson]

@afontani Confimed. We can use timeseries_timestamp_convention set to start (instead of default end) to achieve what #301 does: NREL/resstock@965b1a4. Supports ResStock, not ComStock.

[afontani]

So it looks like the new YAML argument is not required and defaulted to end. This would maintain the current behavior which is good.

[afontani]

@joseph-robertson :

• Do we need to update the changelog docs/changelog/changelog_dev.rst?
• Is this the corresponding resstock PR #999 that needs to be merged along with this PR?

[joseph-robertson]

@joseph-robertson :

• Do we need to update the changelog docs/changelog/changelog_dev.rst? I updated it.
• Is this the corresponding resstock PR #999 that needs to be merged along with this PR? Correct. I updated the PR description.

[joseph-robertson]

Where did we land with this? Can we get this merged?

[afontani]

@joseph-robertson : I am good to merge this, but I am less aware of what needs to be done for the checklist in this repo.

@nmerket are you okay to merge this?