Add HVV convention in docs#148
Open
rrolph575 wants to merge 5 commits into
Open
Conversation
wesleyjcole
reviewed
Jul 20, 2026
wesleyjcole
left a comment
Contributor
There was a problem hiding this comment.
A few comments:
- What do you think about moving this section to the fossil and nuclear technologies section where these things (fuel costs, heat rate) are first introduced?
- I don't think we need to explain the difference between HHV and LHV, or note locations where one is more common than another. I think the goal is just so people know we use HHV, which can be pretty short (a single sentence would probably be fine).
- In order to make it easier to identify changes to .md files, we prefer one sentence per line for any multi-sentence sections.
- Would you update the pull request title so that it fits on the single line?
…ey are on their own lines.
Author
|
I removed most of the text so that it is now just 2 sentences with now one sentence per line. I also moved those sentences to the section you recommended and agree it fits better there. I shortened the PR title. |
wesleyjcole
reviewed
Jul 23, 2026
Co-authored-by: Wesley Cole <49044852+wesleyjcole@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…ntion.
Summary
Added a subsection under "Fuel Prices" section of documentation saying that the HHV convention is used for heating value in ReEDS. This is not explicitly stated in the docs and can be a source of confusion for users who are used to input values from IEA, EU, or manufacturers fuel prices.
Details to double-check
General information to guide review
Did you use LLM tools (chatbot or copilot) in the preparation of this PR? If so, describe how
I did not use verbatim text but I used an LLM to help me in my research (which I double checked on other sources for correctness).