Update inputs documentation - #205
Open
wesleyjcole wants to merge 36 commits into
Open
Conversation
…osts, DAC costs, California CO2 cap, and the ban on nuclear in IL.
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.
Summary
This pull request builds on #157 and updates the ReadMe files in various inputs folders to document what the input files are, their units, and, in many cases, something about their source. Every file now has an entry (and stale entries, plus a couple unused files were removed). The entries are not 100% comprehensive, but they sure provide a lot more than our previous coverage.
Technical details
Implementation notes
I used Claude for the implementation, which traced each input file through the model to verify where and how it was used. Claude aslo pulled from this repo's history and the prior repo's history when needed to understand why files were added and gain context on file provenance. Finally, Claude cross-walked inputs with the Inputs_Processing repo to create links back to files where there was an obvious linkage (e.g., filenames matched exactly from the Inputs_Processing ReadMe and description).
I reviewed each entry, and made a few minor edits. I didn't find any cases where Claude made an error (every time I found an error, it was with a pre-existing description).
inputs/capacity_exogenous/cappayments.csvandinputs/financials/supply_chain_adjust.csvwere both removed because they were not used.I moved the Clean Air Act description from the
nationa_generationfolder to theemission_constraintsfolder.I also asked Claude to check for any inconsistencies between the model and our model documentation. It identified several inconsistencies, which I fixed (using my words).
Note that when I updated
references.bibseveral entries were removed. I verified that they aren't in Zotero, so it's possible that entries were added in the past but not synced with the online Zotero repository.Issues resolved
Supports #43
Validation, testing, and comparison report(s)
Because this is a documentation only fix, model results are unchanged. I verified documentation changes by tracing input files, asking others on the team questions as needed, and inspecting input files.
Checklist for author
Details to double-check
[ ] Included comparison reports for appropriate test casesGeneral information to guide review
Did you use LLM tools (chatbot or copilot) in the preparation of this PR? If so, describe how
Yes, as described in the implementation section.
Tag points of contact here if you would like additional review of the relevant parts of the model