From 460d7b707611cf95945ba2787d69f3318375fc8a Mon Sep 17 00:00:00 2001 From: "Mindermann, Kennedy" Date: Wed, 15 Apr 2026 12:22:22 -0600 Subject: [PATCH 01/11] update links to point to new documentation site --- CONTRIBUTING.md | 6 ++--- README.md | 14 +++++------ docs/source/model_documentation.md | 2 +- preprocessing/README.md | 38 +++++++++++++++--------------- runbatch.py | 2 +- 5 files changed, 31 insertions(+), 31 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3806c19b..dce9669c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,8 +2,8 @@ Community contributions to ReEDS are welcome and encouraged! -For questions or general discussion, please open a [discussion](https://github.com/NatLabRockies/ReEDS-2.0/discussions). To report a bug, please open an [issue](https://github.com/NatLabRockies/ReEDS-2.0/issues). +For questions or general discussion, please open a [discussion](https://github.com/ReEDS-Model/ReEDS/discussions). To report a bug, please open an [issue](https://github.com/ReEDS-Model/ReEDS/issues). -To contribute code, fork the repository, make your changes, and submit a pull request. Please review our [Developer Guide](https://natlabrockies.github.io/ReEDS-2.0/developer_best_practices.html) before getting started. +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/NatLabRockies/ReEDS-2.0/discussions). \ No newline at end of file +**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). \ No newline at end of file diff --git a/README.md b/README.md index 919dd5eb..18cb5005 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -## ReEDS 2.0 +## ReEDS **Regional Energy Deployment System (ReEDS) Model** -[![CI](https://github.nrel.gov/ReEDS/ReEDS-2.0/actions/workflows/python-app.yaml/badge.svg)](https://github.nrel.gov/ReEDS/ReEDS-2.0/actions/workflows/python-app.yaml) -[![Documentation](https://img.shields.io/badge/Documentation-view%20online-0a7f5e?logo=readthedocs&logoColor=white&labelColor=555)](https://natlabrockies.github.io/ReEDS-2.0) +[![CI](https://github.com/ReEDS-Model/ReEDS/actions/workflows/python-app.yaml/badge.svg)](https://github.com/ReEDS-Model/ReEDS/actions/workflows/python-app.yaml) +[![Documentation](https://img.shields.io/badge/Documentation-view%20online-0a7f5e?logo=readthedocs&logoColor=white&labelColor=555)](https://reeds-model.github.io/ReEDS) ![Static Badge](https://img.shields.io/badge/python-3.11-blue) -![GitHub License](https://img.shields.io/github/license/NatLabRockies/ReEDS-2.0) +![GitHub License](https://img.shields.io/github/license/ReEDS-Model/ReEDS) [![DOI](https://zenodo.org/badge/189060033.svg)](https://doi.org/10.5281/zenodo.16943302)
@@ -15,7 +15,7 @@ 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). -**For more information about the model, see the [open source ReEDS-2.0 Documentation](https://reeds-model.github.io/ReEDS).** +**For more information about the model, see the [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). @@ -27,7 +27,7 @@ ReEDS training videos are available on the [NLR Learning YouTube channel](https: [ReEDS](https://www.nrel.gov/analysis/reeds/) is a capacity planning and dispatch model for the U.S. electricity system. -As NLR's flagship long-term power sector model, ReEDS has served as the primary analytic tool for [many studies](https://natlabrockies.github.io/ReEDS-2.0/publications.html) of electricity sector research questions. +As NLR's flagship long-term power sector model, ReEDS has served as the primary analytic tool for [many studies](https://reeds-model.github.io/ReEDS/publications.html) of electricity sector research questions. Example model results are available in the [Scenario Viewer](https://scenarioviewer.nrel.gov/). @@ -40,7 +40,7 @@ Example model results are available in the [Scenario Viewer](https://scenariovie The ReEDS model is written in [Python](https://www.python.org/), [GAMS](https://www.gams.com/), and [Julia](https://julialang.org/). Python and Julia are free, open-source languages; GAMS requires a software license from the vendor. -A step-by-step guide for getting started with ReEDS is available [here](https://pages.github.nrel.gov/ReEDS/ReEDS-2.0/setup.html), and a quick-start guide for advanced users is outlined below. +A step-by-step guide for getting started with ReEDS is available [here](https://reeds-model.github.io/ReEDS/setup.html), and a quick-start guide for advanced users is outlined below. 1. Install Python using the Anaconda Distribution: 2. Set up GAMS: diff --git a/docs/source/model_documentation.md b/docs/source/model_documentation.md index cc9c6a9c..cf799565 100644 --- a/docs/source/model_documentation.md +++ b/docs/source/model_documentation.md @@ -9,7 +9,7 @@ We are especially grateful to Walter Short who first envisioned and developed th Finally, we are grateful to all those who helped sponsor ReEDS model development and analysis, particularly supporters from the U.S. Department of Energy (DOE) but also others who have funded our work over the years. ```{admonition} Suggested Citation -National Laboratory of the Rockies. ({{ cite_date_last_updated }}). *Model documentation — ReEDS 2.0*. https://natlabrockies.github.io/ReEDS-2.0/model_documentation.html +National Laboratory of the Rockies. ({{ cite_date_last_updated }}). *Model documentation — ReEDS 2.0*. https://reeds-model.github.io/ReEDS/model_documentation.html ``` diff --git a/preprocessing/README.md b/preprocessing/README.md index 15a4ed9e..35f7ee06 100644 --- a/preprocessing/README.md +++ b/preprocessing/README.md @@ -24,30 +24,30 @@ The general steps for creating or updating a Zenodo record are: 1. Determine the author list 1. Include each author's [ORCID ID](https://orcid.org/) if they have one 1. Write or update the following sections for the description, using an [existing](https://zenodo.org/records/18435263) [record](https://zenodo.org/records/18407659) as a guide: - 1. General description, including links to relevant model github pages, the [ReEDS](https://github.com/NREL/ReEDS-2.0) model, and the [ReEDS documentation](https://natlabrockies.github.io/ReEDS-2.0/model_documentation.html) - 1. Technical assumptions (such as losses, orientation and inverter loading ratio for PV, specific power and hub height for wind, etc.), with citations to relevant published papers or reports - 1. Temporal resolution - 1. Spatial resolution - 1. File structure and naming conventions (if multiple files are in the record) - 1. An example Python script for reading the file (if using a non-text-based format like `.h5`) + 1. General description, including links to relevant model github pages, the [ReEDS](https://github.com/NREL/ReEDS-2.0) model, and the [ReEDS documentation](https://reeds-model.github.io/ReEDS/model_documentation.html) + 2. Technical assumptions (such as losses, orientation and inverter loading ratio for PV, specific power and hub height for wind, etc.), with citations to relevant published papers or reports + 3. Temporal resolution + 4. Spatial resolution + 5. File structure and naming conventions (if multiple files are in the record) + 6. An example Python script for reading the file (if using a non-text-based format like `.h5`) 1. Double check that it works for all uploaded files using `zenodo_prep.test_read_profiles()` - 1. Ask the authors of the record to review the text -1. Upload the files + 2. Ask the authors of the record to review the text +2. Upload the files 1. Try using the web interface first. If your uploads hang indefinitely, try using the [Zenodo API](https://developers.zenodo.org/) via `preprocessing.zenodo_prep.add_file_to_record()`. If you're still having trouble, try at different times of day on different days of the week. (The Zenodo servers experience [a lot of traffic](https://blog.zenodo.org/2026/01/28/2026-01-28-improvements-and-support-expectations/) and sometimes slow down.) - 1. Make sure the md5 checksums of the uploaded files match the checksums of the local files using `preprocessing.zenodo_prep.compare_checksums()` -1. Review the record preview a few times -1. Publish the record -1. Update the ReEDS repository as necessary + 2. Make sure the md5 checksums of the uploaded files match the checksums of the local files using `preprocessing.zenodo_prep.compare_checksums()` +3. Review the record preview a few times +4. Publish the record +5. Update the ReEDS repository as necessary 1. Update the affected file entries in `inputs/remote_files.csv` 1. If a new file was added, add a new row - 1. If an existing file was updated, change the `record_id` and `md5` for an existing row - 1. If new switch options were added, update the choices in `cases.csv` - 1. Update the documentation if necessary + 2. If an existing file was updated, change the `record_id` and `md5` for an existing row + 2. If new switch options were added, update the choices in `cases.csv` + 3. Update the documentation if necessary 1. Descriptions of assumptions and links to relevant papers or reports - 1. Figures - 1. Tables and numeric values ("X GW in the supply curve", "Y% CAGR in demand", etc.) - 1. References to switch options if the options have changed - 1. Open a pull request to merge the changes into the main branch, following all the usual steps (compare reports against the main branch, description of changes, etc.) + 2. Figures + 3. Tables and numeric values ("X GW in the supply curve", "Y% CAGR in demand", etc.) + 4. References to switch options if the options have changed + 4. Open a pull request to merge the changes into the main branch, following all the usual steps (compare reports against the main branch, description of changes, etc.) diff --git a/runbatch.py b/runbatch.py index 33b32979..c0b32275 100644 --- a/runbatch.py +++ b/runbatch.py @@ -472,7 +472,7 @@ def check_compatibility(sw): err = ( "Manifest.toml does not exist. " "Please set up julia by following the instructions at " - "https://natlabrockies.github.io/ReEDS-2.0/setup.html#reeds2pras-julia-and-stress-periods-setup" + "https://reeds-model.github.io/ReEDS/setup.html#reeds2pras-julia-and-stress-periods-setup" ) raise Exception(err) From 5a24464562736f3c35365dd0e467c30789c8730e Mon Sep 17 00:00:00 2001 From: "Mindermann, Kennedy" Date: Wed, 15 Apr 2026 12:31:32 -0600 Subject: [PATCH 02/11] update more links --- README.md | 2 +- docs/source/developer_best_practices.md | 2 +- docs/source/setup.md | 1 - 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 18cb5005..11b2a888 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ A step-by-step guide for getting started with ReEDS is available [here](https:// 5. Instantiate the Julia environment: `julia --project=. instantiate.jl` 6. (Optional) Several large data files are hosted remotely. 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://pages.github.nrel.gov/ReEDS/ReEDS-2.0/user_guide.html#large-input-files). + 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`. diff --git a/docs/source/developer_best_practices.md b/docs/source/developer_best_practices.md index 63421d1d..90af1b9f 100644 --- a/docs/source/developer_best_practices.md +++ b/docs/source/developer_best_practices.md @@ -566,7 +566,7 @@ The following are best practices that should be considered when reviewing pull r - Request changes as necessary and explain your reasoning - Remember that the PR submitter is ultimately responsible for the changes in the PR, not you, so give the PR review a good effort, but don't agonize over every detail. - If reviewing a PR becomes too large of a chore, feel free to reach out to others on the team to be able to tackle the PR review jointly - - If necessary, make sure the [ReEDS documentation](https://pages.github.nrel.gov/ReEDS/ReEDS-2.0/index.html) was updated to reflect the code changes + - If necessary, make sure the [ReEDS documentation](https://reeds-model.github.io/ReEDS/index.html) was updated to reflect the code changes - Instructions for how to update the documentation can be found [here](#updating-the-reeds-documentation) diff --git a/docs/source/setup.md b/docs/source/setup.md index 72996f18..ee154b59 100644 --- a/docs/source/setup.md +++ b/docs/source/setup.md @@ -275,7 +275,6 @@ If you'd like practice with running a specific ReEDS scenario, you can walk thro Additional resources and learning: * [General information on ReEDS](https://www.nrel.gov/analysis/reeds/) * [ReEDS POC list](https://nrel.sharepoint.com/:w:/s/ReEDS/ES6GQTyzXo1DnnCPlnAhg5QB8cPY--_01HkQkiOnrPskxw?e=flEAtY) -* [GitHub README](https://github.nrel.gov/ReEDS/ReEDS-2.0/blob/main/README.md) * [YouTube tutorials](https://www.youtube.com/playlist?list=PLmIn8Hncs7bG558qNlmz2QbKhsv7QCKiC) * [GAMS language information](https://www.gams.com/latest/docs/UG_MAIN.html#UG_Language_Environment) * [Tips and tricks for the bash shell](https://nrel-my.sharepoint.com/:p:/r/personal/ssundar_nrel_gov/Documents/Microsoft%20Teams%20Chat%20Files/02062024_what_the_shell.pptx?d=wa7aea3514f814d51924bf2dfa737d414&csf=1&web=1&e=qr1YuP) From 0fd94edfcd98dbe6a144ba0e548153058394826a Mon Sep 17 00:00:00 2001 From: "Mindermann, Kennedy" Date: Wed, 15 Apr 2026 13:07:28 -0600 Subject: [PATCH 03/11] more links --- README.md | 4 ++-- docs/source/setup.md | 4 ++-- docs/source/user_guide.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 11b2a888..8a3daa56 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ A step-by-step guide for getting started with ReEDS is available [here](https:// 2. Other commercial solvers have also been successfully applied to ReEDS, but setup details and some solver tuning are specific to the CPLEX solver. 3. Install Julia: 4. Open a command-line interface and set up your environments: - 1. Clone the ReEDS repository: `git clone git@github.com:NatLabRockies/ReEDS-2.0.git` or `git clone https://github.com/NatLabRockies/ReEDS-2.0.git` + 1. Clone the ReEDS repository: `git clone git@github.com:ReEDS-Model/ReEDS.git` or `git clone https://github.com/ReEDS-Model/ReEDS.git` 2. Navigate to the cloned repository 3. Create the `reeds2` [conda environment](https://docs.conda.io/projects/conda/en/stable/user-guide/tasks/manage-environments.html): `conda env create -f environment.yml` 1. Linux and Mac users can use the environment.yml directly. Windows users need to comment out the `- julia=1.8` line from the environment.yml file before creating the environment and use the version of Julia installed above. @@ -72,4 +72,4 @@ A step-by-step guide for getting started with ReEDS is available [here](https:// ## Contact Us -If you have comments and/or questions, you can contact the ReEDS team at [ReEDS.Inquiries@nlr.gov](mailto:ReEDS.Inquiries@nlr.gov) or post a question on the [discussion pages](https://github.com/NatLabRockies/ReEDS-2.0/discussions). +If you have comments and/or questions, you can contact the ReEDS team at [ReEDS.Inquiries@nlr.gov](mailto:ReEDS.Inquiries@nlr.gov) or post a question on the [discussion pages](https://github.com/ReEDS-Model/ReEDS/discussions). diff --git a/docs/source/setup.md b/docs/source/setup.md index ee154b59..3ebe4cc6 100644 --- a/docs/source/setup.md +++ b/docs/source/setup.md @@ -1,5 +1,5 @@ # Getting Started -The ReEDS model source code is available at no cost from the National Laboratory of the Rockies (NLR). The ReEDS model can be downloaded or cloned from [https://github.com/NatLabRockies/ReEDS-2.0](https://github.com/NatLabRockies/ReEDS-2.0). +The ReEDS model source code is available at no cost from the National Laboratory of the Rockies (NLR). The ReEDS model can be downloaded or cloned from [https://github.com/ReEDS-Model/ReEDS](https://github.com/ReEDS-Model/ReEDS). New users may also wish to start with some ReEDS training videos which are available on the [NLR YouTube channel](https://youtu.be/aGj3Jnspk9M?si=iqCRNn5MbGZc8ZIO). @@ -153,7 +153,7 @@ Screenshot of a test of GAMS from the terminal window ``` ### Repository Setup -The ReEDS source code is hosted on GitHub: [https://github.com/NatLabRockies/ReEDS-2.0](https://github.com/NatLabRockies/ReEDS-2.0) +The ReEDS source code is hosted on GitHub: [https://github.com/ReEDS-Model/ReEDS](https://github.com/ReEDS-Model/ReEDS) 1. Install Git Large File Storage, instructions can be found here: [Installing Git Large File Storage](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage) diff --git a/docs/source/user_guide.md b/docs/source/user_guide.md index dd5483ea..3e353fef 100644 --- a/docs/source/user_guide.md +++ b/docs/source/user_guide.md @@ -112,7 +112,7 @@ The `GSw_LoadProfiles` switch corresponds to a file saved to `inputs/remote/dema | Switch Name | Description of Profile | Origin | Weather year included | | ------------- | ------------- | ------------- | ------------- | -| historic | Detrended historic demand from 2007-2013 and 2016-2023. This is multiplied by annual growth factors from AEO to forecast load growth. | Produced by the ReEDS team from a compilation of data sources. More detail can be found in the [hourlize readme](https://github.com/NatLabRockies/ReEDS-2.0/tree/main/hourlize). | 2007-2013 & 2016-2023 | +| historic | Detrended historic demand from 2007-2013 and 2016-2023. This is multiplied by annual growth factors from AEO to forecast load growth. | Produced by the ReEDS team from a compilation of data sources. More detail can be found in the [hourlize readme](https://github.com/ReEDS-Model/ReEDS/tree/main/hourlize). | 2007-2013 & 2016-2023 | | EFS_Clean2035_LTS | Net-zero emissions, economy wide, by 2050 based on the White House's Long Term Strategy as shown here: | Developed for the 100% Clean Electricity by 2035 study: | 2007-2013 | | EFS_Clean2035 | Accelerated Demand Electrification (ADE) profile. This profile was custom made for the 100% Clean Electricity by 2035 study. More information about how it was formed can be found in Appendix C. | Developed for the 100% Clean Electricity by 2035 study: | 2007-2013 | | EFS_Clean2035clip1pct | Same as Clean2035 but clips off the top 1% of load hours. | Developed for the 100% Clean Electricity by 2035 study: | 2007-2013 | From e1e6b6702c14b68f0d8b20fb3f750a21ecaf7fa2 Mon Sep 17 00:00:00 2001 From: "Mindermann, Kennedy" Date: Wed, 22 Apr 2026 15:56:33 -0600 Subject: [PATCH 04/11] update PR template --- .github/PULL_REQUEST_TEMPLATE.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7cdc621b..31556888 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,10 +15,6 @@ ### Relevant sources or documentation - -## Charge code for review - - ## Validation, testing, and comparison report(s) -- [ ] Charge code provided for review +- [ ] Charge code sent reviewer - [ ] Included comparison reports for appropriate test cases - [ ] Documentation updated if necessary -- [ ] Charge code sent reviewer +- [ ] Charge code sent to reviewer - [ ] Included comparison reports for appropriate test cases - [ ] Documentation updated if necessary -- [ ] Charge code sent to reviewer +- [ ] Charge code provided to reviewers - [ ] Included comparison reports for appropriate test cases - [ ] Documentation updated if necessary