Skip to content

remove extra scripts from documentation_tools #108

Open
kennedy-mindermann wants to merge 20 commits into
mainfrom
km/source-documentation
Open

remove extra scripts from documentation_tools #108
kennedy-mindermann wants to merge 20 commits into
mainfrom
km/source-documentation

Conversation

@kennedy-mindermann
Copy link
Copy Markdown
Contributor

@kennedy-mindermann kennedy-mindermann commented May 27, 2026

Summary

This PR cleans up the sources documentation scripts. I removed everything under docs/source/documentation_tools except generate_markdown.py.

generate_markdown.py was moved to the docs/scripts/ folder and conf.py was updated so that the script would run and automatically generate an updated sources.md file when the documentation is built.

Additional Changes

A couple additional changes were made:

  • removal of logic to set the base GitHub URL for the documentation since it's no longer needed
  • added link to the latest release in the main readme

Validation, testing, and comparison report(s)

There are no model changes so I didn't do any full runs for validation.

Checklist for author

Details to double-check

  • Charge code provided to reviewers
  • Included comparison reports for appropriate test cases
  • Documentation updated if necessary
  • If input data added/modified:
    • Dollar year recorded and converted to 2004$ for GAMS
    • Timeseries are in Central Time
    • Units are specified
    • Preprocessing steps have been documented and committed to ReEDS_Input_Processing
    • New large data files handled with .h5 instead of .csv
    • If spatially resolved inputs are modified, the following visualizations for each file are included in the PR description (time-averaged if the inputs are time-resolved):
      • Map of absolute values before
      • Map of absolute values after
      • Map of differences: (after - before) or (after / before)
    • If entries are added/removed/changed in the EIA-NEMS unit database:
      • Changes have been committed to ReEDS_Input_Processing
      • hourlize/resource.py was rerun to regenerate the existing/prescribed VRE capacity data
  • Code formatting standardized
  • Reusable functions used where possible instead of copy/pasted code

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

Tag points of contact here if you would like additional review of the relevant parts of the model

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant