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

Move BuildResidentialHPXML measure to option-based arguments #1351

Draft
wants to merge 18 commits into
base: develop
Choose a base branch
from

Conversation

Sashadf1
Copy link
Collaborator

Pull Request Description

[description here]

Related Pull Requests

[related PRs from different repositories]

Related Issues

[What issue(s) is the PR addressing]

Checklist

Required:

Optional (not all items may apply):

Sashadf1 and others added 10 commits February 14, 2025 14:52
73d527084e Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into buildresidentialhpxml-options-based-args
84c5626d49 Proof of concept implementation for enclosure roof material argument.
REVERT: a784be6aa4 Merge pull request #1757 from NREL/ev_schedules
REVERT: 3e45c34722 Latest results.
REVERT: 1a72648ab5 Update changelog, docs, sample file name.
REVERT: 90948d52dc Some cleanup and formatting.
REVERT: d84d5e86d6 Latest results.
REVERT: 26c6b0d832 Latest results.
REVERT: a0cd8eb338 Merge pull request #1915 from NREL/schedules_v2
REVERT: 93fe562377 Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into ev_schedules
REVERT: 2b84101c75 Merge branch 'ev_schedules' into schedules_v2
REVERT: 8aba2a12c4 Merge branch 'ev_batteries' into ev_schedules
REVERT: de91252a8f Latest results.
REVERT: 4d479fb4a6 Combine EV charging and discharging together
REVERT: 41d4f35f28 Add stochastic ev schededule to sample files
REVERT: 5d06aca861 Latest results.
REVERT: f7f00d9953 Merge branch 'ev_schedules' into schedules_v2
REVERT: 49adc61564 Typo fix and column name fix
REVERT: dd268492b0 Update xml file name
REVERT: 8c3d3307e4 Merge branch 'ev_schedules' into schedules_v2
REVERT: 80e4d97b62 Merge branch 'ev_batteries' into ev_schedules
REVERT: 6fd4f4fce8 Update hpxml and schedule for mf building
REVERT: 776d85574f Merge branch 'ev_schedules' into schedules_v2
REVERT: 916d87d1a6 Merge branch 'ev_batteries' into ev_schedules
REVERT: 4eb1ca1f16 Merge branch 'ev_schedules' into schedules_v2
REVERT: 543db3801d Latest results.
REVERT: d8db876042 Remove byebug and fix tests
REVERT: 6fd196899d Ceiling fan bug fix
REVERT: 9281736746 Fix BuildResidentialScheduleFile/tests
REVERT: b6f4d12e47 Merge branch 'ev_batteries' into ev_schedules
REVERT: 45fca622e5 more test fixes
REVERT: 885c8ba5ef Merge branch 'ev_batteries' into ev_schedules
REVERT: 564bfb768e Update tests
REVERT: 3c76f69351 Remove hardcoded index from test
REVERT: d488e4cfad Create occupancy schedule upfront
REVERT: b360063bad remove bybug and update schedules
REVERT: c448160ab9 Conditionally generate plug load and garage lighting schedule
REVERT: 9a02a07c64 Commit schedule file changes
REVERT: 57613bfcc0 Generate schedules only for things that exist
REVERT: 1970d68117 Merge branch 'ev_batteries' of https://github.com/NREL/OpenStudio-HPXML into ev_schedules
REVERT: c6bd4677a3 Only generate EV related schedule columns if EV is present
REVERT: 5769f964a7 Fix git diff command
REVERT: c592ec74a4 --stat overrides --exit-code, so need to use two separate calls
REVERT: 48a5fd4499 Final cleanup/revert.
REVERT: 112553b93e Add checks for schedule CSVs
REVERT: ec7b7902bc sigh
REVERT: addc070a67 Updated the wrong one
REVERT: 06b6e44ee4 Oops.
REVERT: f18ec530f1 Debug CI failure
REVERT: 45d14051a9 Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into ev_schedules
REVERT: b81f29d34b Rever allowing duplicate columns
REVERT: 6e963ae58f Fix schedule test
REVERT: 7b37014102 update measures
REVERT: d4bcffa95f Merge branch 'ev_batteries' into ev_schedules
REVERT: 7b192742f6 Final cleanup and verified restoration of functionality
REVERT: 2f1f76d131 Rename and reorder
REVERT: bea57ba859 Rename and reorder
REVERT: 30ff4a7c50 Refactor schedule generator
REVERT: 127e47cf90 Update warning message
REVERT: 40ad8e8916 Merge branch 'ev_batteries' into ev_schedules
REVERT: 30da3d89f4 Allow override when duplicate column names exist.
REVERT: 1150640698 Fill in function signatures
REVERT: 313b6d6187 Add unavailable periods entry for new columns
REVERT: bcd352f078 Merge branch 'ev_batteries' of https://github.com/NREL/OpenStudio-HPXML into ev_schedules
REVERT: 57e820f750 Update measures, fix CI error.
REVERT: 8c2182566f Merge remote-tracking branch 'origin/ev_batteries' into ev_schedules
REVERT: 41ec1dbc1e No EV bug fix and formatting
REVERT: 2204599f2b Use floating division to prevent rounding to zero
REVERT: 3026165dee Merge branch 'ev_batteries' into ev_schedules
REVERT: bffc05be12 Schedule aggregation bug fix
REVERT: bb2036facf Merge branch 'ev_batteries' into ev_schedules
REVERT: 997fbeec56 Merge branch 'ev_batteries' into ev_schedules
REVERT: 8131ce2f33 Remove byebug line
REVERT: 9e03d1d0f3 Merge branch 'ev_batteries' into ev_schedules
REVERT: b077dcc504 Bug fixes and enhancement
REVERT: 86144f9da7 Merge branch 'ev_batteries' into ev_schedules
REVERT: d15baa1866 Output EV occupant occupancy
REVERT: b102371faf Handle hours per week
REVERT: 3c867be6e4 Remove epw arguments
REVERT: 5230cc0ad3 fix bug from merge conflict
REVERT: d78b0aed6c Merge remote-tracking branch 'origin/ev_batteries' into ev_schedules
REVERT: 25d24d5a84 Merge branch 'ev_batteries' into ev_schedules
REVERT: fd0dd492de Binary occupancy
REVERT: d08ba63913 Merge branch 'ev_batteries' into ev_schedules
REVERT: d44e1bcfea Handle schedule conflict
REVERT: ce9ff761e0 Merge branch 'ev_batteries' into ev_schedules
REVERT: d377d3c678 Merge branch 'ev_batteries' into ev_schedules
REVERT: d5db465f20 Fix test and read from HPXML
REVERT: be21d3c021 Merge branch 'ev_batteries' into ev_schedules
REVERT: 19740a71b2 Generate EV schedules

git-subtree-dir: resources/hpxml-measures
git-subtree-split: 73d527084efe40e7b208a8c5a3fb0ca5b434fb9a
8d9a7cd234 Revert walls change in hpxml_inputs.json
cbd9f63393 fixed merge conflicts
24ef961cb1 more options added to roof_material.tsv. wall_enclosure_siding commented out
663f682c22 Merge pull request #1930 from NREL/peak_electricity
4375a85e64 Update changelog [ci skip]
140dfe3443 Replace error-check with unit tests. Allow PV w/ MaxPowerOutput=0 to run successfully.
cac762051e Add total vs net error checking.
fabdb1a838 Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into peak_electricity
1527bcde40 Merge pull request #1933 from NREL/schedules_performance
1ccdbe91d5 Latest results.
486ffc3276 Apply HPXML defaults for the entire building rather than calling individual defaulting methods. Should help prevent future bugs like vehicle.hours_per_week.
e1e98cd1df Merge branch 'peak_electricity' of https://github.com/NREL/OpenStudio-HPXML into peak_electricity
cf13591667 Revert this, it was needed.
cc5a9f20c8 Latest results.
8df6436ac5 Changes based on review comments. And a little cleanup.
5436664e9a A little more cleanup.
ce6c4e3b21 First pass on improving the runtime performance of generating stochastic schedules.
603a1ad5d2 Code simplification. This no longer needs to be an array.
f571428e4d Clean up changelog. [ci skip]
24f728e2df Update changelog [ci skip]
85d0402104 Latest results.
83071279c2 Merge branch 'peak_electricity' of https://github.com/NREL/OpenStudio-HPXML into peak_electricity
47362761af Add net peak electricity outputs.
9885ad83ac Latest results.
3cab4aaed5 Simplify outputs/meters.
46b801fe85 Latest results.
c57810266a Bugfix.
53924f95fc Bugfix.
3de1e19913 Revert debug
20714172b8 Bugfixes.
f11c534258 Bugfix.
692477bc80 Simplify ReportUtilityBills too.
dd1d6bdd6f Use custom meters for total electricity and net electricity, simplify code.
a784be6aa4 Merge pull request #1757 from NREL/ev_schedules
3e45c34722 Latest results.
1a72648ab5 Update changelog, docs, sample file name.
182306cbc5 saving WIP on enclosure_wall_siding before computer restart
7580416109 progress before exiting VScode to reset environment variable
90948d52dc Some cleanup and formatting.
d84d5e86d6 Latest results.
26c6b0d832 Latest results.
a0cd8eb338 Merge pull request #1915 from NREL/schedules_v2
93fe562377 Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into ev_schedules
2b84101c75 Merge branch 'ev_schedules' into schedules_v2
8aba2a12c4 Merge branch 'ev_batteries' into ev_schedules
de91252a8f Latest results.
4d479fb4a6 Combine EV charging and discharging together
41d4f35f28 Add stochastic ev schededule to sample files
5d06aca861 Latest results.
f7f00d9953 Merge branch 'ev_schedules' into schedules_v2
49adc61564 Typo fix and column name fix
dd268492b0 Update xml file name
8c3d3307e4 Merge branch 'ev_schedules' into schedules_v2
80e4d97b62 Merge branch 'ev_batteries' into ev_schedules
6fd4f4fce8 Update hpxml and schedule for mf building
776d85574f Merge branch 'ev_schedules' into schedules_v2
916d87d1a6 Merge branch 'ev_batteries' into ev_schedules
4eb1ca1f16 Merge branch 'ev_schedules' into schedules_v2
543db3801d Latest results.
d8db876042 Remove byebug and fix tests
6fd196899d Ceiling fan bug fix
9281736746 Fix BuildResidentialScheduleFile/tests
b6f4d12e47 Merge branch 'ev_batteries' into ev_schedules
45fca622e5 more test fixes
885c8ba5ef Merge branch 'ev_batteries' into ev_schedules
564bfb768e Update tests
3c76f69351 Remove hardcoded index from test
d488e4cfad Create occupancy schedule upfront
b360063bad remove bybug and update schedules
c448160ab9 Conditionally generate plug load and garage lighting schedule
9a02a07c64 Commit schedule file changes
57613bfcc0 Generate schedules only for things that exist
1970d68117 Merge branch 'ev_batteries' of https://github.com/NREL/OpenStudio-HPXML into ev_schedules
c6bd4677a3 Only generate EV related schedule columns if EV is present
5769f964a7 Fix git diff command
c592ec74a4 --stat overrides --exit-code, so need to use two separate calls
48a5fd4499 Final cleanup/revert.
112553b93e Add checks for schedule CSVs
ec7b7902bc sigh
addc070a67 Updated the wrong one
06b6e44ee4 Oops.
f18ec530f1 Debug CI failure
45d14051a9 Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into ev_schedules
b81f29d34b Rever allowing duplicate columns
6e963ae58f Fix schedule test
7b37014102 update measures
d4bcffa95f Merge branch 'ev_batteries' into ev_schedules
7b192742f6 Final cleanup and verified restoration of functionality
2f1f76d131 Rename and reorder
bea57ba859 Rename and reorder
30ff4a7c50 Refactor schedule generator
127e47cf90 Update warning message
40ad8e8916 Merge branch 'ev_batteries' into ev_schedules
30da3d89f4 Allow override when duplicate column names exist.
1150640698 Fill in function signatures
313b6d6187 Add unavailable periods entry for new columns
bcd352f078 Merge branch 'ev_batteries' of https://github.com/NREL/OpenStudio-HPXML into ev_schedules
57e820f750 Update measures, fix CI error.
8c2182566f Merge remote-tracking branch 'origin/ev_batteries' into ev_schedules
41ec1dbc1e No EV bug fix and formatting
2204599f2b Use floating division to prevent rounding to zero
3026165dee Merge branch 'ev_batteries' into ev_schedules
bffc05be12 Schedule aggregation bug fix
bb2036facf Merge branch 'ev_batteries' into ev_schedules
997fbeec56 Merge branch 'ev_batteries' into ev_schedules
8131ce2f33 Remove byebug line
9e03d1d0f3 Merge branch 'ev_batteries' into ev_schedules
b077dcc504 Bug fixes and enhancement
86144f9da7 Merge branch 'ev_batteries' into ev_schedules
d15baa1866 Output EV occupant occupancy
b102371faf Handle hours per week
3c867be6e4 Remove epw arguments
5230cc0ad3 fix bug from merge conflict
d78b0aed6c Merge remote-tracking branch 'origin/ev_batteries' into ev_schedules
25d24d5a84 Merge branch 'ev_batteries' into ev_schedules
fd0dd492de Binary occupancy
d08ba63913 Merge branch 'ev_batteries' into ev_schedules
d44e1bcfea Handle schedule conflict
ce9ff761e0 Merge branch 'ev_batteries' into ev_schedules
d377d3c678 Merge branch 'ev_batteries' into ev_schedules
d5db465f20 Fix test and read from HPXML
be21d3c021 Merge branch 'ev_batteries' into ev_schedules
19740a71b2 Generate EV schedules

git-subtree-dir: resources/hpxml-measures
git-subtree-split: 8d9a7cd2343c47e1f0f90cfc0fd49989025c4f5f
@Sashadf1 Sashadf1 self-assigned this Feb 18, 2025
Sashadf1 and others added 6 commits February 18, 2025 16:21
…to buildresidentialhpxml-options-based-args
…ed-args

merging latest-os-hpxml into buildresidentialhpxml-options-based-args due to CI pointing to buildstockbatch.git@output-meters instead of buildstockbatch.git@develop
- Choice
- auto, dark, light, medium, medium dark, reflective
- The color of the roof. If not provided, the OS-HPXML default (see `HPXML Roofs <https://openstudio-hpxml.readthedocs.io/en/v1.10.0/workflow_inputs.html#hpxml-roofs>`_) is used.
- auto, Asphalt/Fiberglass Shingles, Dark, Asphalt/Fiberglass Shingles, Medium Dark, Asphalt/Fiberglass Shingles, Medium, Asphalt/Fiberglass Shingles, Light, Asphalt/Fiberglass Shingles, Reflective, Tile/Slate, Dark, Tile/Slate, Medium Dark, Tile/Slate, Medium, Tile/Slate, Light, Tile/Slate, Reflective, Metal, Dark, Metal, Medium Dark, Metal, Medium, Metal, Light, Metal, Reflective, Wood Shingles/Shakes, Dark, Wood Shingles/Shakes, Medium Dark, Wood Shingles/Shakes, Medium, Wood Shingles/Shakes, Light, Wood Shingles/Shakes, Reflective, Shingles, Dark, Shingles, Medium Dark, Shingles, Medium, Shingles, Light, Shingles, Reflective, Synthetic Sheeting, Dark, Synthetic Sheeting, Medium Dark, Synthetic Sheeting, Medium, Synthetic Sheeting, Light, Synthetic Sheeting, Reflective, EPS Sheathing, Dark, EPS Sheathing, Medium Dark, EPS Sheathing, Medium, EPS Sheathing, Light, EPS Sheathing, Reflective, Concrete, Dark, Concrete, Medium Dark, Concrete, Medium, Concrete, Light, Concrete, Reflective, Cool Roof
Copy link
Contributor

@shorowit shorowit Feb 19, 2025

Choose a reason for hiding this comment

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

@joseph-robertson We're going to want to do something about the documentation here. For starters, choices can have commas and so the current convention of separating options by comma doesn't work. We could consider using a different delimeter ("|"?) or surrounding options by quotes, but it can still be a long, daunting list. Although we could potentially wrap text in the cell. Another option is to put each choice on a separate line, though it makes the documentation longer.

Here's what it currently looks like:
image

Copy link
Contributor

Choose a reason for hiding this comment

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

So currently in OS-HPXML we have no choice arguments with comma(s) in any of the choices?

I think at one point we tried putting quotes around each option. Wrapped text with cell width max (with different delimiter) sounds like it might be good. Can you try that so we can see what that looks like?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'm going to push forward on the rest of the refactor and make sure CI passes. docs prettying can happen after. Thanks for the tip @joseph-robertson.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@joseph-robertson @shorowit is there a separate step to update the technical development guide? or does this happen automatically through C.I. or a CLI command?

Base automatically changed from latest-os-hpxml to develop February 20, 2025 22:46
cccaeb5a0b Automatically determine datatypes of TSV data. Add caching of TSV files. Remove HPXMLFile module.
b0cf68b380 pulling master for CI to run
b1ef25bc79 fix trailing comma in hpxml_inputs.json
eb9cab7dc8 first pass at heating_system. TODO: diff hpxml directories
ddf3e5f5f0 heating_system.tsv first pass finished, should support OS-HPXML and ResStock options
e222dcbc69 Update unit in docs [ci skip]
d9e1aff055 Merge pull request #1935 from NREL/neep_ashp_sample_files2
d2fde3254d Latest results.
245ce30576 Update HPXMLs.
9d59ea2226 Update sample files to use NEEP products that pass data quality checks.

git-subtree-dir: resources/hpxml-measures
git-subtree-split: cccaeb5a0bfb3783182b65a5645768caf729e9eb
…73fc' into buildresidentialhpxml-options-based-args
@Sashadf1 Sashadf1 force-pushed the buildresidentialhpxml-options-based-args branch from b424a58 to e043cc8 Compare February 28, 2025 01:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants