Remove EP-Compare

[JasonGlazer]

Pull request overview

Removes EP-Compare program

The EP-Compare program did not appear to have any users since it showed an issue when being used that was never reported by any user.

Removes the binaries and updates the documentation and leaves a readme and a brief note in the documentation only.

Pull Request Author

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

• 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

This will not be exhaustively relevant to every PR.

• 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

[shorowit]

Fixes #7324? 😄

[JasonGlazer]

Fixes #7324? 😄

I suppose, if you really stretch the concept of a "fix" :-)

[github-actions]

⚠️ Regressions detected on macos-14 for commit 4758ff8

Regression Summary

• EIO: 2
• ESO Big Diffs: 2
• MTR Big Diffs: 2
• Table Big Diffs: 2
• Table String Diffs: 2

• View Results
• Download Regressions

[jmarrec]

There are still a couple of locations that need to be adjusted.

scripts/dev/verify_signature.py
76:    "PostProcess/EP-Compare/EP-Compare.app",


src/EP-Launch/epl-ui.frm
6078:utilProg(10).name = "EP-Compare"
6091:utilProg(10).applicationFile = "PostProcess\EP-Compare\EP-Compare.exe"

doc/getting-started/src/getting-started-with-energyplus.tex
37:|   +-- EPCompare              A graphical tool for comparing two EnergyPlus output sets

[jmarrec]

Did you remove that EPMacro line by mistake?

[JasonGlazer]

Thanks @jmarrec, the EPMacro line was a mistake and I will make the changes to verify_signature.py and getting started.

The change to EP-Launch, I think I will skip for now. It fails gracefully, which I think is better than just making it disappear from the list of choices. But the next time I work on EP-Launch, I will pick it up for a future release. I added it to this issue for the future

[JasonGlazer]

@jmarrec in verify_signature.py, shouldn't the list of the bundled apps include others like IDFVersionUpdater, ExpandObjects and EPMacro and other utilities that are available on MacOS? Or is it only for apps that had not included the source code in the repo?

[jmarrec]

IDFVersionUpdater is in there. That BUNDLED_APPS is just so I don't recheck something I actually codesigned in the repo directly.

ExpandObjects is a built one (and a fortran exe, not a bundled app) so it'll be checked by default.

EnergyPlus/scripts/dev/verify_signature.py

Lines 73 to 77 in 22e9501

	BUNDLED_APPS = [
	"PreProcess/EP-Launch-Lite.app",
	"PreProcess/IDFVersionUpdater/IDFVersionUpdater.app",
	"PostProcess/EP-Compare/EP-Compare.app",
	]

[JasonGlazer]

I just posted the source and zip of the binaries in an archive repo:

https://github.com/JasonGlazer/ep-compare

[Myoldmopar]

Love this. Great job cleaning it all out and putting it in a separate archive repo. I'll make sure to note this in the readme and deprecation files that go into the release packages.

GitHub is of course showing that you removed about 235 lines of code with this PR, it would be kinda nice if it actually said how many MB you were also removing with all the binary removals.

[Myoldmopar]

It's like 45 MB removed, nice!! OK, this is great. Merging this in. Thanks @JasonGlazer and @jmarrec. Obviously we'll make sure things are happy when I start making release candidates and deal with issues at that point.