Repository navigation
Add supply air/water condition timeseries outputs - #2289
Draft
joseph-robertson wants to merge 12 commits into
Draft
joseph-robertson wants to merge 12 commits into
joseph-robertson wants to merge 12 commits into
Conversation
Add an optional report argument for HVAC air conditions, HVAC hydronic supply temperatures, and domestic hot water outlet temperatures. Label outputs by HVAC distribution or water-heating system ID, and cover distributionless fallback IDs and multifamily building suffixes in tests.
Add the supply timeseries category to run_simulation.rb and pass it to the reporting measure. Set the new measure argument to false in workflow templates to preserve existing defaults.
Describe the new supply category and the HVAC air, hydronic water, and DHW temperatures and humidity outputs it includes.
Add a feature entry for the optional supply timeseries category covering HVAC supply conditions and domestic hot water outlet temperatures.
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Solar DHW labels can collide and overwrite results, while fan-coil and combi systems omit expected supply-condition outputs.
3 open issues
What changed in this PR
Adds optional supply-condition timeseries to the simulation reporting workflow, addressing #2274 with HVAC air temperature/humidity, hydronic supply temperature, and DHW outlet temperature outputs.
Changes:
- Adds the
supplycategory and reporting argument, with columns labeled by distribution or system ID. - Integrates output requests and results into supported report formats.
- Updates workflow templates, tests, documentation, and release notes.
| File | Description |
|---|---|
workflow/tests/util.rb |
Adds supply-output tolerances and a GSHP warning exemption. |
workflow/template-run-hpxml.osw |
Adds the disabled-by-default supply option. |
workflow/template-run-hpxml-with-stochastic-occupancy.osw |
Adds the supply option. |
workflow/template-run-hpxml-with-stochastic-occupancy-subset.osw |
Adds the supply option. |
workflow/template-build-and-run-hpxml.osw |
Adds the supply option. |
workflow/template-build-and-run-hpxml-with-stochastic-occupancy.osw |
Adds the supply option. |
workflow/run_simulation.rb |
Connects the supply category to reporting. |
ReportSimulationOutput/tests/test_report_sim_output.rb |
Tests supply columns, ordering, and units. |
ReportSimulationOutput/README.md |
Documents the new argument. |
ReportSimulationOutput/measure.xml |
Registers the argument and updates metadata. |
ReportSimulationOutput/measure.rb |
Requests, labels, and exports supply conditions. |
docs/source/workflow_outputs.rst |
Documents the category and output units. |
Changelog.md |
Announces optional supply timeseries. |
Review effort: Balanced
| # @param plant_loop [OpenStudio::Model::PlantLoop] Plant loop to inspect | ||
| # @return [Boolean] Whether the loop contains a water heater | ||
| def water_heating_plant_loop?(plant_loop) | ||
| components = plant_loop.supplyComponents + plant_loop.demandComponents |
Comment on lines
+654
to
+655
| model.getAirLoopHVACs.each do |air_loop| | ||
| key_value = air_loop.demandInletNode.name.to_s.upcase |
| end | ||
|
|
||
| # DHW outputs | ||
| water_heaters = @model.getWaterHeaterMixeds + @model.getWaterHeaterStratifieds |
Add air temperature and humidity outputs for boiler fan coil outlets. Map the hydronic supply temperature to the HVAC distribution for combi systems, while excluding the cloned water heating loop and solar preheat tank from HVAC and DHW system outputs.
Store the heating system ID on each boiler fan coil so the reporting measure can label supply air series with the referenced HVAC distribution.
Contributor
|
Thinking out loud a bit here... First, I think calling it "supply air temperature" is misleading. It doesn't include duct losses, so it's really the leaving air temperature. I forget offhand if we calculate an actual supply air temperature in our duct model... Also, the PR is very focused on supply conditions, but that is pretty narrow. Other items of interest:
Maybe we should break this up into HVAC Conditions and DHW Conditions (or HVAC Details and DHW Details)? I feel like this feature needs discussion. |
joseph-robertson
marked this pull request as draft
October 26, 2026 18:30
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Description
Closes #2274.
Add optional timeseries for HVAC supply air (temperature/humidity) and hydronic (temperature), and for DHW outlet temperature (label columns by distribution or system ID):
Supply Air Temperature: <HVACDistributionID>Supply Air Relative Humidity: <HVACDistributionID>Supply Air Humidity Ratio: <HVACDistributionID>Supply Water Temperature: <HVACDistributionID>Supply Water Temperature: <WaterHeatingSystemID>Checklist
Not all may apply:
EPvalidator.sch) has been updatedopenstudio tasks.rb update_hpxmls)HPXMLtoOpenStudio/tests/test*.rband/orworkflow/tests/test*.rb)openstudio tasks.rb update_measureshas been run