Allow simulating whole SFA/MF buildings: `SchedulesFilePath` for each building #1478

joseph-robertson · 2023-09-05T19:47:35Z

Pull Request Description

Instead of storing this on header SoftwareInfo/extension/SchedulesFilePath, this PR allows for different sets of schedules across units of a building by storing on Building/BuildingDetails/BuildingSummary/extension/SchedulesFilePath. Therefore, SoftwareInfo/extension/SchedulesFilePath is deprecated.

Checklist

PR Author: Check these when they're done. Not all may apply. ~~strikethrough~~ and check any that do not apply.

PR Reviewer: Verify each has been completed.

Schematron validator (EPvalidator.xml) has been updated
Sample files have been added/updated (via tasks.rb)
Tests have been added/updated (e.g., HPXMLtoOpenStudio/tests and/or workflow/tests/hpxml_translator_test.rb)
Documentation has been updated
~~Changelog has been updated~~
openstudio tasks.rb update_measures has been run
No unexpected changes to simulation results of sample files

…models_unit_multiplier_schedules

shorowit · 2023-09-06T14:30:16Z

I think we should add the same Building ID argument as the HPXMLtoOS measure:

OpenStudio-HPXML/HPXMLtoOpenStudio/measure.rb

Lines 64 to 67 in 11f5ffa

    
           arg = OpenStudio::Measure::OSArgument.makeStringArgument('building_id', false) 
        
           arg.setDisplayName('BuildingID') 
        
           arg.setDescription("The ID of the HPXML Building. Only required if there are multiple Building elements in the HPXML file. Use 'ALL' to run all the HPXML Buildings (dwelling units) of a multifamily building in a single model.") 
        
           args << arg

If the HPXML has multiple buildings and a single Building ID is specified, only create schedules for that one dwelling unit. If the HPXML has multiple buildings and 'ALL' is specified, create unique schedules for each dwelling unit where the random seed is multiplied by the building index (1..n), which ensures that the results are deterministic.

"Do we want to continue to support SchedulesFilePath at the header level SoftwareInfo/extension?" Ideally yes, so that it's not a breaking change for software tools.

HPXMLtoOpenStudio/resources/hpxml.rb

…models_unit_multiplier_schedules

BuildResidentialHPXML/measure.rb

BuildResidentialScheduleFile/measure.rb

BuildResidentialScheduleFile/tests/build_residential_schedule_file_test.rb

HPXMLtoOpenStudio/measure.rb

HPXMLtoOpenStudio/tests/test_validation.rb

docs/source/workflow_inputs.rst

joseph-robertson · 2023-09-20T17:09:14Z

tasks.rb

+  # Logic that can only be applied based on file name
+  if ['base-schedules-detailed-occupancy-stochastic-hpxml-header.xml'].include? hpxml_file
+    hpxml.header.schedules_filepaths << '../../HPXMLtoOpenStudio/resources/schedule_files/occupancy-stochastic.csv'
+  end


Demonstrate backward compatibility.

If you make the change I proposed where the BuildResSchedule measure sometimes writes to the HPXML Header and sometimes to the Building Header, I assume we can remove this new HPXML sample file as we'd end up testing both pathways through our existing sample files.

Also, it feels like we're missing a sample file where we actually vary the schedules across the HPXML buildings. How about creating a new base-multiple-buildings-detailed-occupancy-stochastic.xml based on base-multiple-buildings.xml?

Hmm, I'm realizing that the problem with your first comment here is that tasks.rb uses BuildResidentialHPXML to first create the HPXML (with SchedulesFilePath at building header) and then uses BuildResidentialScheduleFile to re-write the HPXML file (with SchedulesFilePath at the HPXML header)...

I suppose I can make a similar change to BuildResidentialHPXML?

Ugh, even then it gets complicated. You'd have to "move" a schedule from HPXML header to building header when going from 1 building to 2 buildings using BuildResidentialHPXML...

When we create sample files, there's no need to specify a schedule file path to BuildResidentialHPXML if we are going to use BuildResidentialScheduleFile to create the schedules (and add the path), no? Or maybe I'm not following.

But tasks.rb uses the schedules_filepaths argument to queue up running BuildResidentialScheduleFile. Even so, (it's not in this PR) but say you had an HPXML file with a single building (and SchedulesFilePath is in the HPXML header). If you went to add a building to the HPXML file, then you're assuming the existing schedule file applies to the second building?

I'd propose we save addressing this in #1457.

shorowit

Good stuff, @joseph-robertson, this is pretty close. A few comments/suggestions below.

BuildResidentialHPXML/measure.rb

BuildResidentialScheduleFile/measure.rb

BuildResidentialScheduleFile/tests/build_residential_schedule_file_test.rb

HPXMLtoOpenStudio/measure.rb

shorowit · 2023-09-20T20:02:11Z

tasks.rb

+  # Logic that can only be applied based on file name
+  if ['base-schedules-detailed-occupancy-stochastic-hpxml-header.xml'].include? hpxml_file
+    hpxml.header.schedules_filepaths << '../../HPXMLtoOpenStudio/resources/schedule_files/occupancy-stochastic.csv'
+  end


If you make the change I proposed where the BuildResSchedule measure sometimes writes to the HPXML Header and sometimes to the Building Header, I assume we can remove this new HPXML sample file as we'd end up testing both pathways through our existing sample files.

shorowit · 2023-09-20T20:05:07Z

tasks.rb

+  # Logic that can only be applied based on file name
+  if ['base-schedules-detailed-occupancy-stochastic-hpxml-header.xml'].include? hpxml_file
+    hpxml.header.schedules_filepaths << '../../HPXMLtoOpenStudio/resources/schedule_files/occupancy-stochastic.csv'
+  end


Also, it feels like we're missing a sample file where we actually vary the schedules across the HPXML buildings. How about creating a new base-multiple-buildings-detailed-occupancy-stochastic.xml based on base-multiple-buildings.xml?

BuildResidentialScheduleFile/tests/build_residential_schedule_file_test.rb

…com/NREL/OpenStudio-HPXML into whole_sfa_mf_models_unit_multiplier_schedules # Conflicts: # HPXMLtoOpenStudio/measure.xml

shorowit

This looks good. I'll merge when the CI comes back happy.

joseph-robertson added 4 commits September 5, 2023 12:09

Create class for schedules filepath at building level.

bb6995a

Update build measure to write building level schedules filepath.

64df290

Regenerate all sample files with schedules filepath.

039b9ac

Update build schedule file measure and tests.

3608f7e

joseph-robertson self-assigned this Sep 5, 2023

joseph-robertson added 5 commits September 5, 2023 13:50

Updates to schedule file measure for multiple buildings.

0e09786

Introduce new building_id argument and test it.

74ad7be

Revert removal of the unit_model workaround.

04a9d18

Update schedules and validation test files.

966a5a6

Merge branch 'whole_sfa_mf_models_unit_multiplier' into whole_sfa_mf_…

3612308

…models_unit_multiplier_schedules

shorowit reviewed Sep 6, 2023

View reviewed changes

HPXMLtoOpenStudio/resources/hpxml.rb Outdated Show resolved Hide resolved

joseph-robertson and others added 9 commits September 6, 2023 08:36

Updates for bldg header and schedule variation across units.

6b46d32

Carry building_id to schedule file measure in run_simulation.rb.

0ff590c

Updates for schedules filepath backward compatibility.

fced723

Merge branch 'whole_sfa_mf_models_unit_multiplier' into whole_sfa_mf_…

7b84afc

…models_unit_multiplier_schedules

Append in.schedules.csv int only for 2+ buildings.

f8082a6

Merge branch 'whole_sfa_mf_models_unit_multiplier' into whole_sfa_mf_…

32e5d6c

…models_unit_multiplier_schedules

Latest results.

50a2293

Merge branch 'whole_sfa_mf_models_unit_multiplier' into whole_sfa_mf_…

d1dd11f

…models_unit_multiplier_schedules

Few fixes in build schedule file tests.

816536f

joseph-robertson marked this pull request as ready for review September 19, 2023 23:43

joseph-robertson added 2 commits September 19, 2023 16:54

Update docs and epvalidator.

693c7aa

Update validator and ruby error messages test.

2d3e5b1

joseph-robertson commented Sep 20, 2023

View reviewed changes

joseph-robertson requested a review from shorowit September 20, 2023 18:24

shorowit reviewed Sep 20, 2023

View reviewed changes

Respond to review comments.

98d91cf

shorowit reviewed Sep 20, 2023

View reviewed changes

BuildResidentialScheduleFile/tests/build_residential_schedule_file_test.rb Show resolved Hide resolved

Deprecate hpxml header location of SchedulesFilePath.

998b658

joseph-robertson and others added 4 commits September 21, 2023 08:15

Few more updates for the deprecation.

4b6e05d

Latest results.

449e690

Remove obsolete code.

aaabb69

Merge branch 'whole_sfa_mf_models_unit_multiplier' of https://github.…

0504e74

…com/NREL/OpenStudio-HPXML into whole_sfa_mf_models_unit_multiplier_schedules # Conflicts: # HPXMLtoOpenStudio/measure.xml

shorowit approved these changes Sep 21, 2023

View reviewed changes

shorowit merged commit 36c3b08 into whole_sfa_mf_models_unit_multiplier Sep 21, 2023
5 checks passed

shorowit deleted the whole_sfa_mf_models_unit_multiplier_schedules branch September 21, 2023 21:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow simulating whole SFA/MF buildings: `SchedulesFilePath` for each building #1478

Allow simulating whole SFA/MF buildings: `SchedulesFilePath` for each building #1478

joseph-robertson commented Sep 5, 2023 •

edited

Loading

shorowit commented Sep 6, 2023

joseph-robertson Sep 20, 2023

shorowit Sep 20, 2023

shorowit Sep 20, 2023

joseph-robertson Sep 20, 2023

joseph-robertson Sep 20, 2023

joseph-robertson Sep 20, 2023

shorowit Sep 20, 2023

joseph-robertson Sep 20, 2023

joseph-robertson Sep 20, 2023

shorowit left a comment

shorowit Sep 20, 2023

shorowit Sep 20, 2023

shorowit left a comment

Allow simulating whole SFA/MF buildings: SchedulesFilePath for each building #1478

Allow simulating whole SFA/MF buildings: SchedulesFilePath for each building #1478

Conversation

joseph-robertson commented Sep 5, 2023 • edited Loading

Pull Request Description

Checklist

shorowit commented Sep 6, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shorowit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shorowit left a comment

Choose a reason for hiding this comment

Allow simulating whole SFA/MF buildings: `SchedulesFilePath` for each building #1478

Allow simulating whole SFA/MF buildings: `SchedulesFilePath` for each building #1478

joseph-robertson commented Sep 5, 2023 •

edited

Loading