PR to Update main branch with REEDs head main branch

.github/PULL_REQUEST_TEMPLATE.md

@@ -72,7 +72,7 @@ Include additional illustrative plots describing input data, methods, testing, a
 - [ ] 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 (runbatch.py, d_solve_iterate.py)
+- [ ] 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)
 

.github/labeler.yaml

@@ -9,6 +9,7 @@ dependencies:
           - "Project.toml"
           - "Manifest.toml"
           - ".github/dependabot.yml"
+          - "instantiate.jl"
 
 github_actions:
   - changed-files:
@@ -42,15 +43,8 @@ tests:
 model_changes:
   - changed-files:
       - any-glob-to-any-file:
-          - "*.gms"
-          - "**/*.gms"
-          - "runbatch.py"
-          - "d_solve*.py"
           - "reeds/**"
-          - "ReEDS_Augur/**"
-          - "Augur.py"
-          - "instantiate.jl"
-          - "reeds2pras/**"
+          - "runreeds.py"
 
 data_changes:
   - changed-files:
@@ -60,19 +54,11 @@ data_changes:
           - "postprocessing/**/inputs/**"
           - "**/*.csv"
           - "**/*.h5"
-          - "sources.csv"
-          - "sources_documentation.md"
 
 hourlize:
   - changed-files:
       - any-glob-to-any-file: "hourlize/**"
 
-input_processing:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "input_processing/**"
-          - "preprocessing/**"
-
 postprocessing:
   - changed-files:
       - any-glob-to-any-file: "postprocessing/**"

.github/workflows/build-docs.yaml

@@ -26,14 +26,14 @@ jobs:
     permissions:
       contents: write # Required for peaceiris/actions-gh-pages publish to gh-pages.
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
         with: 
           fetch-depth: 1
           lfs: true
           persist-credentials: false
 
       - name: Set up Python 3.12
-        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
         with: 
           python-version: "3.12"
 
@@ -50,21 +50,13 @@ jobs:
             sphinxcontrib-bibtex==2.6.2 \
             sphinx_design==0.6.1
 
-      - name: Set variables for internal github repo
-        run: |
-          echo "BASE_URL=https://github.com/ReEDS-Model/ReEDS" >> "$GITHUB_ENV"
-          cd "$GITHUB_WORKSPACE/docs/source/documentation_tools/"
-          sh generate_sources_md_file.sh
-          cd "$GITHUB_WORKSPACE"
-          python docs/source/documentation_tools/generate_markdown.py --githubURL "https://github.com/ReEDS-Model/ReEDS/blob/main" --reedsPath "$GITHUB_WORKSPACE"
-
       - name: Build Sphinx documentation
         env: 
           GAMSLICE: ${{ secrets.GAMSLICE }}
         run: sphinx-build docs/source docs/build/
 
       - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 # v3
+        uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453 # v4.1.0
         if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
         with: 
           github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/labeler.yaml

@@ -22,7 +22,7 @@ jobs:
     timeout-minutes: 5
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/labeler@634933edcd8ababfe52f92936142cc22ac488b1b # v6.0.1
+      - uses: actions/labeler@f27b608878404679385c85cfa523b85ccb86e213 # v6.1.0
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           configuration-path: .github/labeler.yaml

.github/workflows/python-app.yaml

@@ -34,7 +34,7 @@ jobs:
       contents: read
       actions: write # Required to save/update micromamba cache.
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
         with:
           persist-credentials: false
       - name: Setup ReEDS environments
@@ -52,7 +52,7 @@ jobs:
       contents: read
       actions: write # Required to save/update Zenodo data cache.
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
         with:
           fetch-depth: 1
           lfs: false
@@ -115,7 +115,7 @@ jobs:
     env:
       batch: test
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
         with:
           fetch-depth: 1
           lfs: false
@@ -195,15 +195,15 @@ jobs:
       - name: Run ReEDS model
         env:
           SCENARIO: ${{ matrix.scenario }}
-        run: python runbatch.py -b "$batch" -c test -s "$SCENARIO"
+        run: python runreeds.py -b "$batch" -c test -s "$SCENARIO"
 
       - name: Print GAMS log
         if: runner.debug == '1'
         run: cat "$RUN_FOLDER/gamslog.txt"
 
       - name: Check ReEDS outputs
         if: ${{ hashFiles(format('{0}/outputs/cap_ivrt.csv', env.RUN_FOLDER)) == '' }}
-        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7
+        uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v7
         with:
           script: |
             core.setFailed('ReEDS run failed. Check log to diagnose.')
@@ -215,7 +215,7 @@ jobs:
 
       - name: Upload ReEDS failure diagnostics
         if: ${{ failure() }}
-        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
         with:
           name: ${{ format('{0}-failure-diagnostics', matrix.scenario) }}
           compression-level: 9
@@ -230,7 +230,7 @@ jobs:
             ${{ env.RUN_FOLDER }}/ReEDS_Augur/PRAS/PRAS_*i*.log
 
       - name: Save ReEDS run
-        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
         with:
           name: ${{ matrix.scenario }}
           compression-level: 9
@@ -264,17 +264,17 @@ jobs:
             solve-year: 2026
 
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
         with:
           persist-credentials: false
       - name: Retrieve ReEDS runs for ${{ matrix.scenario }}
-        uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
         with:
           name: ${{ matrix.scenario }}
           path: ${{ format('{0}-{1}', matrix.scenario, matrix.solve-year) }}
 
       - name: Install uv and set Python version
-        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
         with:
           python-version: "3.11"
           enable-cache: true
@@ -290,15 +290,15 @@ jobs:
           R2X_WEATHER_YEAR: "2012"
           R2X_SYSTEM_JSON: ${{ format('{0}_system.json', matrix.scenario) }}
         run: |
-          uvx --from "r2x-reeds>=0.3.5" python scripts/run_r2x.py \
+          uvx --from "r2x-reeds>=0.3.5" python postprocessing/run_r2x.py \
             --reeds-run-path "$R2X_REEDS_RUN_PATH" \
             --scenario "$R2X_SCENARIO" \
             --solve-year "$R2X_SOLVE_YEAR" \
             --weather-year "$R2X_WEATHER_YEAR" \
             --system-json "$R2X_SYSTEM_JSON"
 
       - name: Save R2X system
-        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
         with:
           name: r2x-${{ matrix.scenario }}
           compression-level: 9

.github/workflows/workflow-quality.yaml

@@ -23,12 +23,12 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
         with:
           persist-credentials: false
 
       - name: Install uv
-        uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57 # v8.0.0
+        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
         with:
           version: "0.9.4"
 
@@ -40,7 +40,7 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
         with:
           persist-credentials: false
 

CONTRIBUTING.md

@@ -6,4 +6,4 @@ For questions or general discussion, please open a [discussion](https://github.c
 
 To contribute code, fork the repository, make your changes, and submit a pull request. Please review our [Developer Guide](https://reeds-model.github.io/ReEDS/developer_best_practices.html) before getting started.
 
-**Note:** if you're considering making a change that might lead to meaningful differences in model capability, workflow, or outputs, we recommend initiating a [discussion](https://github.com/ReEDS-Model/ReEDS/discussions).
+**Note:** if you're considering making a change that might lead to meaningful differences in model capability, workflow, or outputs, we recommend initiating a [discussion](https://github.com/ReEDS-Model/ReEDS/discussions).

README.md

@@ -15,6 +15,8 @@ This GitHub repository contains the source code for NLR's ReEDS model.
 The ReEDS model source code is available at no cost from the National Laboratory of the Rockies.
 The ReEDS model can be downloaded or cloned from [https://github.com/ReEDS-Model/ReEDS](https://github.com/ReEDS-Model/ReEDS).
 
+If you want to use the latest stable version of ReEDS, download or check out the latest stable release [here](https://github.com/ReEDS-Model/ReEDS/releases/latest).
+
 **For more information about the model, see the [ReEDS Documentation](https://reeds-model.github.io/ReEDS).**
 
 ReEDS training videos are available on the [NLR Learning YouTube channel](https://youtube.com/playlist?list=PLmIn8Hncs7bG558qNlmz2QbKhsv7QCKiC&si=NgGBaL_MxNcYiIEX).
@@ -63,10 +65,10 @@ A step-by-step guide for getting started with ReEDS is available [here](https://
     These files are downloaded automatically as needed during a ReEDS run, but to finish all the internet-requiring steps up front, you can download them all by running `python reeds/remote.py`.
     Additional details on remote files and other topics can be found in the [user guide](https://reeds-model.github.io/ReEDS/user_guide.html#large-input-files).
 5. Run ReEDS on a test case from the root of the cloned repository:
-    1. For interactive setup: `python runbatch.py`
-    2. For one-line operation: `python runbatch.py -b v20250314_main -c test`.
+    1. For interactive setup: `python runreeds.py`
+    2. For one-line operation: `python runreeds.py -b v20250314_main -c test`.
     In this example, "v20250314_main" is the prefix for this batch of cases, and "test" is the suffix of the cases file, in this case `cases_test.csv`, located in the root of the repository.
-    Run `python runbatch.py -h` for information on other optional command-line arguments for ReEDS.
+    Run `python runreeds.py -h` for information on other optional command-line arguments for ReEDS.