Fix #11267 - Ensure consistency of IDF file formats for easier diffing by jmarrec · Pull Request #11268 · NatLabRockies/EnergyPlus

jmarrec · 2025-10-10T11:39:17Z

Pull request overview

Fixes Ensure consistency of IDF file formats for easier diffing #11267

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

Reviewer

…gured from an in.f90 file

…sts are failing

``` 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'} ```

…lExecutor (this is too slow for pratical use: takes 1 to 2 hr to reformat testfiles/)

github-actions · 2025-10-10T12:07:54Z

⚠️ Regressions detected on ubuntu-24.04 for commit `ab54ac8`

Regression Summary

IDF: 5

github-actions · 2025-10-10T12:14:09Z

⚠️ Regressions detected on macos-14 for commit `ab54ac8`

Regression Summary

IDF: 5

mitchute

I like adding some consistency to these.

testfiles/1ZoneDataCenterCRAC_wApproachTemp_ClassH1.idf

mitchute · 2025-10-10T18:14:05Z

scripts/dev/make_pretty.py

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?

No. It takes way too long. Like 1.5 hours. And that's why 16 processes running in parallel in a temp folder. It's horrendous. The Transition utilities are really really bad in terms of performance.

Eventually we'll write up a python script to do at least the formatting part.

Now that I've already pushed, I'm realizing that I didn't actually run this script. I just ran the new transition exe directly.

mitchute · 2025-10-10T18:16:12Z

datasets/ASHRAE_2005_HOF_Materials.idf

-!  Version,
-!    9.0;                    !- Version Identifier
-


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.

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

If the version objects are not in there, the transition still happens. It'll just add the Transition's version as a comment.

So you'd end up with

! Version, ! 9.0; !- Version Identifier ! Version, ! 25.2; !- Version Identifier

mitchute · 2025-10-10T18:18:48Z

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

jmarrec · 2025-10-16T16:47:08Z

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

Yeah that's a much harder problem to solve.
The docs would be outdated, and probably already are in a lot of places
The tests would at least fail if the fields aren't in line, regardless the the comments.

mitchute

I ran the new transition exe locally, and it all looks OK. Unless I hear otherwise, I think we can merge this if CI passes.

mitchute · 2025-10-20T18:57:57Z

datasets/Macro/SandiaPVdata.imf

@@ -301,8 +298,8 @@
    0.03,                    !- Sandia Database Parameter c5 {dimensionless}
    33.8,                    !- Sandia Database Parameter Ix0


These should probably be tagged with \unit A at some point.

mitchute · 2025-10-20T19:01:01Z

scripts/dev/make_pretty.py

Now that I've already pushed, I'm realizing that I didn't actually run this script. I just ran the new transition exe directly.

github-actions · 2025-10-20T19:15:45Z

⚠️ Regressions detected on macos-14 for commit `dc8b312`

Regression Summary

IDF: 5

github-actions · 2025-10-20T19:16:40Z

⚠️ Regressions detected on ubuntu-24.04 for commit `dc8b312`

Regression Summary

IDF: 5

jmarrec added 7 commits October 10, 2025 09:15

Add a Transition target that has only MakingPretty = true. It's confi…

11051a6

…gured from an in.f90 file

[chore] Reformat dataset

c522309

[chore] Remove version 9.0 comment

92edaf2

[chore] Reformat perf and tst

0eeb10e

[chore] Reformat testfiles - exclude the changes where integration te…

de3778b

…sts are failing

jmarrec self-assigned this Oct 10, 2025

jmarrec added 3 commits October 10, 2025 13:42

Add to git blame ignore revs

9db6783

Commit my script that runs Formatter_only in parallel in a ProcessPoo…

df58baf

…lExecutor (this is too slow for pratical use: takes 1 to 2 hr to reformat testfiles/)

Install Formatter_only?

21cb6d3

jmarrec force-pushed the 11267_format_idfs branch from d5d328c to 21cb6d3 Compare October 10, 2025 11:44

mitchute reviewed Oct 10, 2025

View reviewed changes

mitchute added 3 commits October 16, 2025 15:58

Merge branch 'develop' into 11267_format_idfs

b350db3

reformat testfiles

0b09c83

format performance tests

67fcd8b

mitchute reviewed Oct 20, 2025

View reviewed changes

mitchute added this to the EnergyPlus 25.2 milestone Oct 22, 2025

mitchute merged commit 4f5c971 into develop Oct 24, 2025
11 checks passed

mitchute deleted the 11267_format_idfs branch October 24, 2025 03:16

mitchute mentioned this pull request Oct 26, 2025

Make Pretty IDFs Again #11294

Merged

25 tasks

mitchute mentioned this pull request Mar 2, 2026

Weird extra comments in IDF related to schedules and FenestrationSurface:Detailed #9590

Open

3 tasks

		@@ -301,8 +298,8 @@
		0.03, !- Sandia Database Parameter c5 {dimensionless}
		33.8, !- Sandia Database Parameter Ix0

Conversation

jmarrec commented Oct 10, 2025

Pull request overview

Description of the purpose of this PR

Pull Request Author

Reviewer

Uh oh!

github-actions bot commented Oct 10, 2025

⚠️ Regressions detected on ubuntu-24.04 for commit ab54ac8

Uh oh!

github-actions bot commented Oct 10, 2025

⚠️ Regressions detected on macos-14 for commit ab54ac8

Uh oh!

mitchute left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mitchute commented Oct 10, 2025

Uh oh!

jmarrec commented Oct 16, 2025

Uh oh!

mitchute left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 20, 2025

⚠️ Regressions detected on macos-14 for commit dc8b312

Uh oh!

github-actions bot commented Oct 20, 2025

⚠️ Regressions detected on ubuntu-24.04 for commit dc8b312

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

⚠️ Regressions detected on ubuntu-24.04 for commit `ab54ac8`

⚠️ Regressions detected on macos-14 for commit `ab54ac8`

⚠️ Regressions detected on macos-14 for commit `dc8b312`

⚠️ Regressions detected on ubuntu-24.04 for commit `dc8b312`