Skip to content

Conversation

@RKStrand
Copy link
Contributor

Pull request overview

Description of the purpose of this PR

It was noted that in the SetupOutputVariables.csv file that is generated by a python script has a slight issue. When the scrip runs, it looks for all occurrences of "SetupOutputVariable" in the EnergyPlus code and then reports that to the .csv file. Unfortunately, there are several cases where the call to SetupOutputVariable has been commented out. The python script still logs those even though they are no longer valid calls. The solution here was to adjust the name of the call in the comment lines (added spaces between them) so that they are not logged by the python script. In addition, any place where an in-line comment was in the middle of a call to SetupOutputVariable there were also issues that resulted in the log in SetupOutputVariables.csv having additional problems. These have been corrected as well. No unit test were added or needed as per @Myoldmopar.

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
  • [na] 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

In SetupOutputVariables.csv, there were several places where there were calls that had been commented out but were showing up in this summary file.  These are now all corrected.
@RKStrand RKStrand added this to the EnergyPlus 25.2 IO Freeze milestone Jun 10, 2025
@RKStrand RKStrand requested a review from Myoldmopar June 10, 2025 18:36
@RKStrand RKStrand self-assigned this Jun 10, 2025
@RKStrand RKStrand added Defect Includes code to repair a defect in EnergyPlus AuxiliaryTool Related to an auxiliary tool, not EnergyPlus itself (readvars, preprocessor, ep-launch, etc.) labels Jun 10, 2025
@Myoldmopar
Copy link
Member

Yep, thanks for this cleanup.

@Myoldmopar Myoldmopar merged commit 7a5c8df into develop Jul 7, 2025
12 of 13 checks passed
@Myoldmopar Myoldmopar deleted the 11086SetupOutputVariablesCSVErrorFix branch July 7, 2025 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AuxiliaryTool Related to an auxiliary tool, not EnergyPlus itself (readvars, preprocessor, ep-launch, etc.) Defect Includes code to repair a defect in EnergyPlus

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SetupOutputVariables.csv is reporting unused reports and comments

4 participants