Move inputs documentation from `sources.csv` to `inputs/*/README.md` by kennedy-mindermann · Pull Request #157 · ReEDS-Model/ReEDS

kennedy-mindermann · 2026-07-23T21:13:11Z

Summary

This PR adds more inputs/*/README.md files and automatically compiles them into a single Inputs Documentation page. I removed all of the input files in sources.csv and added any information found there to the applicable README.md.

Since the documentation on the inputs is still pretty light, I also created this issue to cover filling in the documentation a bit more with this new structure: #156.

Technical details

The sources.csv file no longer contains any input files. It now only contains references to hourlize, postprocessing, and test files.

Implementation notes

Additional changes

Switches added/removed/changed

Issues resolved

Addresses the documentation reorganization mentioned in #43

Known incompatibilities

Relevant sources or documentation

Validation, testing, and comparison report(s)

I did a GDX diff between main and this branch for a USA default scenario and it showed no differences.

results-8_24_2026_sd_USA_defaults,8_24_2026_main_USA_defaults.pptx

Checklist for author

Details to double-check

General information to guide review

Zero impact on results of default case
No large data file(s) added/modified
No substantive impact on runtime for full-US reference case
No substantive impact on folder size for full-US reference case
No change to process flow (runreeds.py, reeds/core/solve/solve.py)
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

Yes, I used copilot to help me write the generate_inputs_markdown.py script.

…s.csv

… get deflator from input specific dollaryear files

patrickbrown4 · 2026-07-23T21:36:29Z

@@ -1,4 +1,4 @@
-# Model zone definitions
+## Model Zone Definitions


I use the markdownlint extension and it complains if the first line in the file is not a top-level heading (single #). Is it ok to stick with that format?

I think so, I had originally left them as single # but that prevents us from compiling into a single markdown file for the documentation unless we do some additional processing

Oh I see, thanks. I can just turn off that rule if it complicates things (I'm not sure how widely that linter is used anyway).

wesleyjcole

developer_B]=best_practicies.md needs updated.

Would you update the PR description to note the revised scope of source.csv (non-inputs files only)? Or do you think it's worth removing all sources.csv entries in this PR?

wesleyjcole · 2026-08-25T20:50:14Z

+    readmes = _collect_input_readmes(inputs_root)
+    _write_inputs_md(output_path, readmes)


What do you think about bringing the function code down to here instead of keeping it above in the functions? That seems slightly more intuitive to me, but maybe there is a value to keeping it as a function?

I see value in keeping the main function smaller, and having this as a separate function makes it a little more digestible imo. Happy to reconsider if you feel strongly, but I'd lean toward leaving it separate.

wesleyjcole · 2026-08-25T21:24:58Z

    return runfiles, non_region_files, region_files

-
 def get_source_deflator_map(reeds_path):


I think this function can now be removed.

patrickbrown4

Thanks a lot for starting this Kennedy. A few notes from a quick scan.

patrickbrown4 · 2026-08-27T15:18:02Z

I think this whole file could be removed now; it looks like most of the remaining entries are out of date anyway.

patrickbrown4 · 2026-08-27T15:21:30Z


 ### Global Warming Potentials
-A range of values for global warming potentials (GWP) of CH<sub>4</sub> and N<sub>2</sub>O are taken from the most recent IPCC assessment reports (AR4 to AR6). Summary of the ranges of GWPs for these pollutants can be found in Table 7.15, page 1017 of the IPCC AR6 report (https://www.ipcc.ch/report/ar6/wg1/downloads/report/IPCC_AR6_WGI_FullReport.pdf).
+A range of values for global warming potentials (GWP) of CH<sub>4</sub> and N<sub>2</sub>O are taken from the most recent IPCC assessment reports (AR4 to AR6). Summary of the ranges of GWPs for these pollutants can be found in Table 7.15, page 1017 of the IPCC AR6 report ([https://www.ipcc.ch/report/ar6/wg1/downloads/report/IPCC_AR6_WGI_FullReport.pdf](https://www.ipcc.ch/report/ar6/wg1/downloads/report/IPCC_AR6_WGI_FullReport.pdf)).


(nitpick) bare URLs can be given as a single <https://www.ipcc.ch/report/ar6/wg1/downloads/report/IPCC_AR6_WGI_FullReport.pdf> (with triangle brackets) instead of the two-part link

patrickbrown4 · 2026-08-27T15:22:39Z

+- `ofs-wind_ATB_2023_*.csv`:
+  - `ofs-wind_ATB_2023_advanced.csv`: 2023 advanced ofs-wind capital, fixed O&M, var O&M costs and rsc_mult (SC cost reduction mult) by class and year
+  - `ofs-wind_ATB_2023_conservative.csv`: 2023 conservative ofs-wind capital, fixed O&M, var O&M costs and rsc_mult (SC cost reduction mult) by class and year
+  - `ofs-wind_ATB_2023_moderate.csv`: 2023 moderate ofs-wind capital, fixed O&M, var O&M costs and rsc_mult (SC cost reduction mult) by class and year
+  - `ofs-wind_ATB_2023_moderate_noFloating.csv`: 2023 moderate_noFloating ofs-wind capital (5x floating capital cost), fixed O&M, var O&M costs and rsc_mult (SC cost reduction mult) by class and year
+
+- `ofs-wind_ATB_2024_*.csv`:
+  - `ofs-wind_ATB_2024_advanced.csv`:
+  - `ofs-wind_ATB_2024_conservative.csv`: 2024 conservative ofs-wind capital, fixed O&M, var O&M costs and rsc_mult (SC cost reduction mult) by class and year
+  - `ofs-wind_ATB_2024_moderate.csv`: 2024 moderate ofs-wind capital, fixed O&M, var O&M costs and rsc_mult (SC cost reduction mult) by class and year
+  - `ofs-wind_ATB_2024_moderate_noFloating.csv`: 2024 moderate_noFloating ofs-wind capital (5x floating capital cost), fixed O&M, var O&M costs and rsc_mult (SC cost reduction mult) by class and year
+
+- `ons-wind_ATB_2023_*.csv`:
+  - `ons-wind_ATB_2023_advanced.csv`: Advanced cost and performance inputs from the 2023 Annual Technology Baseline for land-based wind
+  - `ons-wind_ATB_2023_conservative.csv`: Conservative cost and performance inputs from the 2023 Annual Technology Baseline for land-based wind
+  - `ons-wind_ATB_2023_moderate.csv`: Moderate cost and performance inputs from the 2023 Annual Technology Baseline for land-based wind
+
+- `ons-wind_ATB_2024_*.csv`:
+  - `ons-wind_ATB_2024_advanced.csv`: Advanced cost and performance inputs from the 2024 Annual Technology Baseline for land-based wind
+  - `ons-wind_ATB_2024_conservative.csv`: Conservative cost and performance inputs from the 2024 Annual Technology Baseline for land-based wind
+  - `ons-wind_ATB_2024_moderate.csv`: Moderate cost and performance inputs from the 2024 Annual Technology Baseline for land-based wind


I think a lot of things like these can be collapsed for readability, but it can happen in a followup

Co-authored-by: Patrick Brown <25125211+patrickbrown4@users.noreply.github.com>

kennedy-mindermann added 12 commits July 9, 2026 15:34

add readmes for input folders and fill out with information in source…

b9a5089

…s.csv

add missing file to readme

d0ee7ae

add script to compile inputs.md from the inputs/*/readme.md files

07cf9e9

update formatting of readmes

05e9a27

update script to not have duplicate headers

a0ee7bb

merge main into km/source-documentation

e1341a1

update some links and fix spelling errors

910841e

update formatting

56744b8

remove input file records from sources.csv, add new dollar year file,…

e3ac86c

… get deflator from input specific dollaryear files

update readme

d49df6e

Merge branch 'main' into km/source-documentation

e768cdf

formatting updates

c98a334

patrickbrown4 reviewed Jul 23, 2026

View reviewed changes

kennedy-mindermann and others added 7 commits July 24, 2026 10:06

remove the old generate_markdown script

c620e35

Merge branch 'main' into km/source-documentation

a72bf8c

delete sources_documentation.md

6340034

add get_source_deflator_map function back into copy_files

09ff17c

merge main into km/source-documentation

02dce1e

merge main into km/source-documentation

9dcff00

fix copy_files

c373232

kennedy-mindermann requested a review from wesleyjcole August 21, 2026 15:21

Merge branch 'main' into km/source-documentation

09a43f7

kennedy-mindermann marked this pull request as ready for review August 21, 2026 15:24

github-actions Bot added data_changes model_changes docs labels Aug 21, 2026

pesap mentioned this pull request Aug 21, 2026

Fix R2X compatibility dependency floor #192

Merged

7 tasks done

kennedy-mindermann added 2 commits August 24, 2026 08:04

Merge branch 'main' into km/source-documentation

de4c80a

Merge branch 'main' into km/source-documentation

b32b572

wesleyjcole reviewed Aug 25, 2026

View reviewed changes

kennedy-mindermann and others added 3 commits August 26, 2026 15:45

updates in response to pr comments

0c496d3

remove get_source_deflator_map

77fe9df

Merge branch 'main' into km/source-documentation

5414bbe

kennedy-mindermann requested a review from wesleyjcole August 27, 2026 15:12

wesleyjcole approved these changes Aug 27, 2026

View reviewed changes

patrickbrown4 reviewed Aug 27, 2026

View reviewed changes

kennedy-mindermann and others added 7 commits August 27, 2026 10:29

Update inputs/canada_imports/README.md

6e957b5

Co-authored-by: Patrick Brown <25125211+patrickbrown4@users.noreply.github.com>

Update inputs/canada_imports/README.md

02b4d5e

Co-authored-by: Patrick Brown <25125211+patrickbrown4@users.noreply.github.com>

Update inputs/sets/README.md

4f5e0cf

Co-authored-by: Patrick Brown <25125211+patrickbrown4@users.noreply.github.com>

Update inputs/consume/README.md

7f33332

Co-authored-by: Patrick Brown <25125211+patrickbrown4@users.noreply.github.com>

Update inputs/canada_imports/README.md

faa0612

Co-authored-by: Patrick Brown <25125211+patrickbrown4@users.noreply.github.com>

Update inputs/canada_imports/README.md

234cff3

Co-authored-by: Patrick Brown <25125211+patrickbrown4@users.noreply.github.com>

Merge branch 'main' into km/source-documentation

1429dae

kennedy-mindermann merged commit 855ba2f into main Aug 28, 2026
10 checks passed

kennedy-mindermann deleted the km/source-documentation branch August 28, 2026 15:47

wesleyjcole mentioned this pull request Aug 31, 2026

Update inputs documentation #205

Open

9 tasks done

		@@ -1,4 +1,4 @@
		# Model zone definitions
		## Model Zone Definitions

		readmes = _collect_input_readmes(inputs_root)
		_write_inputs_md(output_path, readmes)

		return runfiles, non_region_files, region_files


		def get_source_deflator_map(reeds_path):

Conversation

kennedy-mindermann commented Jul 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Technical details

Implementation notes

Additional changes

Switches added/removed/changed

Issues resolved

Known incompatibilities

Relevant sources or documentation

Validation, testing, and comparison report(s)

Checklist for author

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wesleyjcole left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

patrickbrown4 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

kennedy-mindermann commented Jul 23, 2026 •

edited

Loading