Skip to content

Conversation

@yujiex
Copy link
Collaborator

@yujiex yujiex commented Feb 25, 2025

Pull request overview

  • Previously the documentation says heat pump heating rate equals the sum of air terminal heating rate (which includes supplemental heating coil heating rate). This is wrong for both the curve-based model and FluidTCtrl model. It should be total heating rate plus piping loss. This PR fixes the documentation issue.

Description of the purpose of this PR

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

heat pump heating rate = total coil heating rate and piping loss
previously RHS is total air terminal heating rate
@yujiex yujiex added the Documentation Related primarily on the LaTeX-based EnergyPlus documentation label Feb 25, 2025
@yujiex yujiex added this to the EnergyPlus 25.1 milestone Feb 25, 2025
@yujiex yujiex requested review from Myoldmopar and mjwitte February 25, 2025 23:41
@yujiex yujiex self-assigned this Feb 25, 2025
@yujiex yujiex added the Defect Includes code to repair a defect in EnergyPlus label Feb 25, 2025
@Myoldmopar
Copy link
Member

Thanks for pulling these little doc fixes into a quick PR. Merging it now.

@Myoldmopar Myoldmopar merged commit ddcfd02 into develop Feb 26, 2025
9 of 11 checks passed
@Myoldmopar Myoldmopar deleted the onlyFixDocVRFheatpumpHeatRate branch February 26, 2025 14:42
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 Documentation Related primarily on the LaTeX-based EnergyPlus documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants