Summary
docs/sources.csv previously held a single-line description for each input file. This has been replaced with inputs/*/README.md per folder, and the prior sources.csv entries for inputs have been migrated in as a starting point. Most of the READMEs still need more complete information.
What a "complete" README covers
At a minimum:
- A description of each file in the folder
- Where the data comes from
- Any switches that affect it
How to contribute
Pick a folder, comment on the issue or link a PR so others know it's in progress, and check it off once merged.
A good example of what the input READMEs should look like is inputs/transmission/README.md.
READMEs that need to be completed:
Summary
docs/sources.csvpreviously held a single-line description for each input file. This has been replaced withinputs/*/README.mdper folder, and the priorsources.csventries for inputs have been migrated in as a starting point. Most of the READMEs still need more complete information.What a "complete" README covers
At a minimum:
How to contribute
Pick a folder, comment on the issue or link a PR so others know it's in progress, and check it off once merged.
A good example of what the input READMEs should look like is
inputs/transmission/README.md.READMEs that need to be completed:
capacity_exogenous/README.mdclimate/README.mdctus/README.mddegradation/README.mddgen_model_inputs/README.mddisaggregation/README.mdemission_constraints/README.mdfinancials/README.mdfuelprices/README.mdgeothermal/README.mdgrowth_constraints/README.mdhydro/README.mdload/README.mdnational_generation/README.mdplant_characteristics/README.mdreserves/README.mdsets/README.mdshapefiles/README.mdstate_policies/README.mdstorage/README.mdsupply_curve/README.mdtechs/README.mdtemporal/README.mdupgrades/README.mduserinput/README.mdvaluestreams/README.mdwaterclimate/README.md