NatLabRockies / NatLabRockies/EnergyPlus

Pump referenced by TemperingValve must be placed before TemperingValve in plantloop is missing in documentation

Open
#7,129 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation
Dominant language
C++
Stars
1.6k
Forks
490
Avg merge
6d 21h
Merged PRs (30d)
22

Description

Found this out by trial and error here. https://unmethours.com/question/36680/temperingvalve-object-not-recognizing-outlet-node-of-pump-object/?answer=36704#post-id-36704

Easy fix is to explicitly state in the IO Reference where the supply side pump must be relative to the TemperingValve object in the plantloop. Nicer solution would change the code to look for the pump object before and after the TemperingValve in the supply side of the plantloop.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the IO Reference for the TemperingValve object and review the plantloop guidance for the supply-side pump, using the linked Unmet Hours discussion for context. Done means the documentation explicitly states where the pump must be placed relative to the TemperingValve; the possible code change is a separate, broader option.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.