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 HPXMLtoOpenStudio to top level #971

Merged
merged 35 commits into from Sep 23, 2022
Merged

Conversation

joseph-robertson
Copy link
Contributor

@joseph-robertson joseph-robertson commented Jul 21, 2022

Pull Request Description

Closes #969.

There are slight energy differences for some datapoints. After diffing in.xml (and in.idf files), from what I can tell there are discrepancies in:

  • FoundationWalls are collapsed to one FoundationWall on develop (same for Slabs)
  • Surfaces and ShadingSurfaces in different order

I think this is an artifact of using collapse_enclosure_surfaces before defaulting (develop) vs after defaulting (feature).

National project, ID=2:
develop.xml.txt
feature.xml.txt

This PR also consolidates all existing debug arguments to a single optional debug argument stored at the top level of the YML file. For example:

workflow_generator:
  type: residential_hpxml
  args:
    build_existing_model:
      simulation_control_timestep: 60
      simulation_control_run_period_begin_month: 1
      simulation_control_run_period_begin_day_of_month: 1
      simulation_control_run_period_end_month: 12
      simulation_control_run_period_end_day_of_month: 31
      simulation_control_run_period_calendar_year: 2007

    emissions:
      - scenario_name: LRMER_MidCase_15
        type: CO2e
        elec_folder: data/cambium/LRMER_MidCase_15
        gas_value: 147.3
        propane_value: 177.8
        oil_value: 195.9
        wood_value: 200.0

    simulation_output_report:
      timeseries_frequency: hourly
      include_timeseries_total_consumptions: true
      include_timeseries_fuel_consumptions: true
      include_timeseries_end_use_consumptions: true
      include_timeseries_emissions: true
      include_timeseries_total_loads: false
      output_variables:
        - name: Zone People Occupant Count

    reporting_measures:
      - measure_dir_name: QOIReport

    debug: true

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)

@joseph-robertson joseph-robertson added this to the ResStock v2.6.0 Beta milestone Jul 21, 2022
@joseph-robertson joseph-robertson self-assigned this Jul 21, 2022
arg.setDisplayName('Measures to Ignore')
arg.setDescription("Measures to exclude from the OpenStudio Workflow specified by listing one or more measure directories separated by '|'. Core ResStock measures cannot be ignored (this measure will fail). INTENDED FOR ADVANCED USERS/WORKFLOW DEVELOPERS.")
args << arg

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not even sure if/how this works with the new OS-HPXML based workflow.

arg.setDisplayName('Annual Component Loads?')
arg.setDescription('If true, output the annual component loads.')
args << arg

Copy link
Contributor Author

Choose a reason for hiding this comment

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

These two arguments removed here since they are applicable to HPXMLtoOpenStudio.

@@ -252,7 +237,6 @@ def run(model, runner, user_arguments)

if args['os_hescore_directory'].is_initialized
os_hescore_directory = args['os_hescore_directory'].get
hes_hpxml_measures_dir = File.join(os_hescore_directory, 'hpxml-measures')
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is removed because HPXMLtoOpenStudio (not called from the measure anymore) comes after HPXMLtoHEScore and HEScoreRuleset.

# Specify measures to run
measures['BuildResidentialHPXML'][0]['apply_defaults'] = true # for apply_hvac_sizing
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Apply this here because ApplyUpgrade now comes before HPXMLtoOpenStudio.

@@ -89,7 +89,7 @@ jobs:

- name: Run buildstockbatch
run: |
pip install git+https://github.com/NREL/buildstockbatch.git@develop
pip install git+https://github.com/NREL/buildstockbatch.git@workflow-refactor
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this automatically get reverted to develop upon merge?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No. I'll manually revert it before merge.

@joseph-robertson joseph-robertson merged commit 6820973 into develop Sep 23, 2022
@joseph-robertson joseph-robertson deleted the workflow-refactor branch September 23, 2022 15:51
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.

Refactor BuildExistingModel + ApplyUpgrade
2 participants