Skip to content

Conversation

@yujiex
Copy link
Collaborator

@yujiex yujiex commented Jan 24, 2025

Pull request overview

EnergyPlus allows modelers to input shading fractions for exterior surfaces using a CSV-format schedule, but modelers cannot override the surface view factors to the ground/horizon or the sky. This feature aims to facilitate the use of an external file to overwrite surface view factors to the ground and sky, similar to using Schedule:File:Shading to overwrite shading fractions. Further, for a large EnergyPlus simulation model, the external CSV schedule file could become extremely large and slow to parse. Another proposed improvement was to enhance the performance of shading fraction overwrites for large models. However, through benchmarking, we’ve established that the current csv parser performs decently well.

NOTE: ENHANCEMENTS MUST FOLLOW A SUBMISSION PROCESS INCLUDING A FEATURE PROPOSAL AND DESIGN DOCUMENT PRIOR TO SUBMITTING CODE

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

@yujiex yujiex added the NewFeature Includes code to add a new feature to EnergyPlus label Jan 24, 2025
@yujiex yujiex added this to the EnergyPlus 25.2 IO Freeze milestone Jan 24, 2025
@yujiex yujiex self-assigned this Jan 24, 2025
@yujiex yujiex marked this pull request as draft January 24, 2025 19:35
@nrel-bot-2c
Copy link

@yujiex @Myoldmopar it has been 28 days since this pull request was last updated.

2 similar comments
@nrel-bot-2c
Copy link

@yujiex @Myoldmopar it has been 28 days since this pull request was last updated.

@nrel-bot-2
Copy link

@yujiex @Myoldmopar it has been 28 days since this pull request was last updated.

@nrel-bot-2
Copy link

@yujiex @Myoldmopar it has been 33 days since this pull request was last updated.

@nrel-bot-2c
Copy link

@yujiex @Myoldmopar it has been 34 days since this pull request was last updated.

@yujiex yujiex removed this from the EnergyPlus 25.2 IO Freeze milestone Jul 28, 2025
@nrel-bot-2c
Copy link

@yujiex @Myoldmopar it has been 32 days since this pull request was last updated.

@nrel-bot-2
Copy link

@yujiex @Myoldmopar it has been 30 days since this pull request was last updated.

@mitchute
Copy link
Collaborator

@yujiex any reason to hold this open, or can we close the PR?

@nrel-bot-2
Copy link

@yujiex @Myoldmopar it has been 28 days since this pull request was last updated.

1 similar comment
@nrel-bot-2
Copy link

@yujiex @Myoldmopar it has been 28 days since this pull request was last updated.

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

Labels

NewFeature Includes code to add a new feature to EnergyPlus

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants