Skip to content

Add HVV convention in docs#148

Open
rrolph575 wants to merge 5 commits into
mainfrom
bf/update_hvv_docs
Open

Add HVV convention in docs#148
rrolph575 wants to merge 5 commits into
mainfrom
bf/update_hvv_docs

Conversation

@rrolph575

Copy link
Copy Markdown

…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

  • [WCRD.13600.01.01.01 ] Charge code provided to reviewers

General information to guide review

  • [ x] Zero impact on results of default case
  • [x ] No large data file(s) added/modified
  • [x ] No substantive impact on runtime for full-US reference case
  • [x ] No substantive impact on folder size for full-US reference case
  • [x ] No change to process flow (runreeds.py, reeds/core/solve/solve.py)
  • [x ] No change to code organization
  • No change to package requirements (environment.yml or Project.toml)

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).

@rrolph575 rrolph575 assigned wesleyjcole and rrolph575 and unassigned rrolph575 Jul 15, 2026
@github-actions github-actions Bot added the docs label Jul 15, 2026

@wesleyjcole wesleyjcole left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@rrolph575 rrolph575 changed the title Added a section in docs explaining ReEDS uses HHV heating value conve… Add HVV convention in docs Jul 22, 2026
@rrolph575

rrolph575 commented Jul 22, 2026

Copy link
Copy Markdown
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.

Comment thread docs/source/model_documentation.md Outdated
rrolph575 and others added 2 commits July 23, 2026 16:26
Co-authored-by: Wesley Cole <49044852+wesleyjcole@users.noreply.github.com>
@rrolph575
rrolph575 requested a review from wesleyjcole July 24, 2026 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants