Remove support for "conditioned" crawlspaces#2224
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR removes support for “conditioned crawlspaces” across the OpenStudio-HPXML workflow (breaking change), aligning inputs/modeling with OS-ERI constraints by requiring users to represent these cases as unvented crawlspaces instead.
Changes:
- Removes conditioned crawlspace foundation/location constants, sample files, and related defaults/tests.
- Updates schematron validation, builder options, and documentation to eliminate “crawlspace - conditioned” and the “Crawlspace, Conditioned” choice.
- Refactors attic/foundation type → location mapping into shared helper methods.
Reviewed changes
Copilot reviewed 26 out of 26 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| workflow/tests/util.rb | Removes conditioned-crawlspace-specific conditioned floor area adjustment in output verification. |
| workflow/sample_files/base-foundation-conditioned-crawlspace.xml | Deletes conditioned crawlspace sample HPXML. |
| workflow/hpxml_inputs.json | Removes mapping for the deleted conditioned crawlspace sample file. |
| tasks.rb | Removes conditioned crawlspace from a validation adjacency whitelist. |
| HPXMLtoOpenStudio/tests/test_validation.rb | Updates expected schematron/ruby validation messages to remove conditioned crawlspace references. |
| HPXMLtoOpenStudio/tests/test_enclosure.rb | Removes conditioned crawlspace cases from enclosure/foundation tests. |
| HPXMLtoOpenStudio/tests/test_defaults.rb | Removes conditioned crawlspace defaulting test scenarios. |
| HPXMLtoOpenStudio/resources/hpxml.rb | Removes conditioned crawlspace constants, adds attic/foundation type→location helpers, updates serialization/parsing. |
| HPXMLtoOpenStudio/resources/hpxml_schematron/EPvalidator.sch | Removes “crawlspace - conditioned” from allowed location enumerations and deletes conditioned crawlspace patterns. |
| HPXMLtoOpenStudio/resources/geometry.rb | Removes conditioned crawlspace from zone volume/height calculations. |
| HPXMLtoOpenStudio/resources/defaults.rb | Removes conditioned crawlspace handling in defaults (volume, infiltration, duct location hierarchy, etc.). |
| HPXMLtoOpenStudio/measure.xml | Bumps measure metadata/checksums for updated resources/tests. |
| docs/source/workflow_inputs.rst | Updates input docs to remove conditioned crawlspace and instruct using unvented crawlspace instead. |
| Changelog.md | Adds breaking-change note about conditioned crawlspaces no longer allowed. |
| BuildResidentialHPXML/tests/test_build_residential_hpxml.rb | Removes builder workflow coverage and error cases for conditioned crawlspace. |
| BuildResidentialHPXML/resources/options/geometry_foundation_type.tsv | Removes “Crawlspace, Conditioned” option. |
| BuildResidentialHPXML/resources/geometry.rb | Uses new helper methods for attic/foundation naming; removes conditioned crawlspace handling. |
| BuildResidentialHPXML/README.md | Removes “Crawlspace, Conditioned” from documented geometry foundation choices. |
| BuildResidentialHPXML/measure.xml | Removes conditioned crawlspace choice; updates measure metadata/checksums. |
| BuildResidentialHPXML/measure.rb | Removes conditioned crawlspace logic; refactors duct/water-heater location mapping to use new helpers. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…HPXML into remove_conditioned_crawl # Conflicts: # HPXMLtoOpenStudio/measure.xml
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 #2031. This is a breaking change.
We don't support conditioned crawlspaces in OS-ERI and we really shouldn't here. The feature was added a while back to support crawlspaces that are actively maintained at setpoint, but that is unlikely to occur in practice and has a high potential of being misused.
Going forward, conditioned crawlspaces should be described as unvented crawlspaces, in which the crawlspace temperature will be calculated by EnergyPlus based on how well it's insulated. If the crawlspace is well-insulated, its temperature will approach the above-grade conditioned space temperature.
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