Skip to content

Conversation

jmarrec
Copy link
Contributor

@jmarrec jmarrec commented Oct 10, 2025

Pull request overview

Description of the purpose of this PR

  • Added a specifically configured Transition tool that only does MakingPretty
  • Applied to the repo, and manually fixed a bunch of problems.

In particular I had about 50 files failures, and after a lot of effort I isolated the issue: the tool removed some coils

{'Coil:Cooling:DX:VariableSpeed',
 'Coil:Cooling:WaterToAirHeatPump:EquationFit',
 'Coil:Cooling:WaterToAirHeatPump:ParameterEstimation',
 'Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit',
 'Coil:Heating:DX:VariableSpeed',
 'Coil:Heating:WaterToAirHeatPump:EquationFit',
 'Coil:Heating:WaterToAirHeatPump:ParameterEstimation',
 'Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit',
 'Coil:WaterHeating:AirToWaterHeatPump:Pumped',
 'Coil:WaterHeating:AirToWaterHeatPump:VariableSpeed',
 'Coil:WaterHeating:AirToWaterHeatPump:Wrapped',
 'ThermalStorage:HotWater:Stratified'}

Pull Request Author

  • Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
  • Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
  • Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
  • Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
  • If any diffs are expected, author must demonstrate they are justified using plots and descriptions
  • If changes fix a defect, the fix should be demonstrated in plots and descriptions
  • If any defect files are updated to a more recent version, upload new versions here or on DevSupport
  • If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
  • If structural output changes, add to output rules file and add OutputChange label
  • If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies

Reviewer

  • Perform a Code Review on GitHub
  • If branch is behind develop, merge develop and build locally to check for side effects of the merge
  • If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If feature, test running new feature, try creative ways to break it
  • CI status: all green or justified
  • Check that performance is not impacted (CI Linux results include performance check)
  • Run Unit Test(s) locally
  • Check any new function arguments for performance impacts
  • Verify IDF naming conventions and styles, memos and notes and defaults
  • If new idf included, locally check the err file and other outputs

```
git diff -U0 | grepdiff 'Watts per Zone' --output-matching=hunk | git apply --cached --unidiff-zero
git diff -U0 | grepdiff 'Rate per Exterior' --output-matching=hunk | git apply --cached --unidiff-zero
```

more

```
git diff -U0 | grepdiff 'Zone Load Sizing Method' --output-matching=hunk | git apply --cached --unidiff-zero
git diff -U0 | grepdiff 'Coefficient1 Constant' --output-matching=hunk | git apply --cached --unidiff-zero
[etc]
```
Then I manually added the rest of the formatting changes
…ableSpeed and WaterToAir[chore] HeatPump and AirToWaterHeatPump and PCM coils

```
{'Coil:Cooling:DX:VariableSpeed',
 'Coil:Cooling:WaterToAirHeatPump:EquationFit',
 'Coil:Cooling:WaterToAirHeatPump:ParameterEstimation',
 'Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit',
 'Coil:Heating:DX:VariableSpeed',
 'Coil:Heating:WaterToAirHeatPump:EquationFit',
 'Coil:Heating:WaterToAirHeatPump:ParameterEstimation',
 'Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit',
 'Coil:WaterHeating:AirToWaterHeatPump:Pumped',
 'Coil:WaterHeating:AirToWaterHeatPump:VariableSpeed',
 'Coil:WaterHeating:AirToWaterHeatPump:Wrapped',
 'ThermalStorage:HotWater:Stratified'}
```
@jmarrec jmarrec self-assigned this Oct 10, 2025
@jmarrec jmarrec added Defect Includes code to repair a defect in EnergyPlus DoNotPublish Includes changes that shouldn't be reported in the changelog NotIDDChange Code does not impact IDD (can be merged after IO freeze) Developer Issue Related to cmake, packaging, installers, or developer tooling (CI, etc) labels Oct 10, 2025
Copy link

⚠️ Regressions detected on ubuntu-24.04 for commit ab54ac8

Regression Summary
  • IDF: 5

Copy link

⚠️ Regressions detected on macos-14 for commit ab54ac8

Regression Summary
  • IDF: 5

Copy link
Collaborator

@mitchute mitchute left a comment

Choose a reason for hiding this comment

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

I like adding some consistency to these.

Comment on lines -393 to +392
934.4, !- 2023 Rated Evaporator Fan Power Per Volume Flow {W/(m3/s)}
, !- 2017 Rated Evaporator Fan Power Per Volume Flow Rate {W/(m3/s)}
Copy link
Collaborator

Choose a reason for hiding this comment

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

This change seems like a regression. I'm not arguing with what is in the schema, just noting it.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I guess we would just run this on our own occasionally, or it is going to be part of a more formal check? Would it be fast enough to run as part of our ./scripts/dev/apply_formatting.sh cleanup?

Comment on lines -18 to -20
! Version,
! 9.0; !- Version Identifier

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm debating whether it would be useful to keep the version identifiers here and in other files that are just IDF object holders, and not really simulation input files.

Copy link
Contributor

Choose a reason for hiding this comment

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

If the version object and number was in those files, wouldn't the transition program work on them?

@mitchute
Copy link
Collaborator

Now the next can of 🪱 🪱 🪱 ... what about the IDF objects in the unit tests and docs??

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Defect Includes code to repair a defect in EnergyPlus Developer Issue Related to cmake, packaging, installers, or developer tooling (CI, etc) DoNotPublish Includes changes that shouldn't be reported in the changelog NotIDDChange Code does not impact IDD (can be merged after IO freeze)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Ensure consistency of IDF file formats for easier diffing

5 participants