Skip to content

Update urls for NLR pages and github repositories#658

Open
genevievestarke wants to merge 3 commits intoNatLabRockies:developfrom
genevievestarke:update_docs_links
Open

Update urls for NLR pages and github repositories#658
genevievestarke wants to merge 3 commits intoNatLabRockies:developfrom
genevievestarke:update_docs_links

Conversation

@genevievestarke
Copy link
Copy Markdown
Collaborator

@genevievestarke genevievestarke commented Apr 7, 2026

Update NLR page links, NLR references and GitHub links

Many of the links in the docs and references would stop working at the end of May. I've updated a lot of the NLR page links, references to NLR, and GitHub repository links. Things that I did not update

  • Package names, i.e. ard-nrel
  • Docs pages for other tools, specifically nrel-pysam docs page
  • References to the specific turbine names: NREL 5 MW reference turbine, etc.
  • Test names: test_nrel_solar_resource_file_downloads

Section 1: Type of Contribution

  • Feature Enhancement
    • Framework
    • New Model
    • Updated Model
    • Tools/Utilities
    • Other (please describe):
  • Bug Fix
  • Documentation Update
  • CI Changes
  • Other (please describe):

Section 2: Draft PR Checklist

  • Open draft PR
  • Describe the feature that will be added
  • Fill out TODO list steps
  • Describe requested feedback from reviewers on draft PR
  • Complete Section 7: New Model Checklist (if applicable)

TODO:

  • Step 1
  • Step 2

Type of Reviewer Feedback Requested (on Draft PR)

Structural feedback:

Implementation feedback:

Other feedback:

Section 3: General PR Checklist

  • PR description thoroughly describes the new feature, bug fix, etc.
  • Added tests for new functionality or bug fixes
  • Tests pass (If not, and this is expected, please elaborate in the Section 6: Test Results)
  • Documentation
    • Docstrings are up-to-date
    • Related docs/ files are up-to-date, or added when necessary
    • Documentation has been rebuilt successfully
    • Examples have been updated (if applicable)
  • CHANGELOG.md
    • At least one complete sentence has been provided to describe the changes made in this PR
    • After the above, a hyperlink has been provided to the PR using the following format:
      "A complete thought. [PR XYZ]((https://github.com/NatLabRockies/H2Integrate/pull/XYZ)", where
      XYZ should be replaced with the actual number.

Section 3: Related Issues

Section 4: Impacted Areas of the Software

Section 4.1: New Files

  • path/to/file.extension
    • method1: What and why something was changed in one sentence or less.

Section 4.2: Modified Files

  • path/to/file.extension
    • method1: What and why something was changed in one sentence or less.

Section 5: Additional Supporting Information

Section 6: Test Results, if applicable

Section 7 (Optional): New Model Checklist

  • Model Structure:
    • Follows established naming conventions outlined in docs/developer_guide/coding_guidelines.md
    • Used attrs class to define the Config to load in attributes for the model
      • If applicable: inherit from BaseConfig or CostModelBaseConfig
    • Added: initialize() method, setup() method, compute() method
      • If applicable: inherit from CostModelBaseClass
  • Integration: Model has been properly integrated into H2Integrate
    • Added to supported_models.py
    • If a new commodity_type is added, update create_financial_model in h2integrate_model.py
  • Tests: Unit tests have been added for the new model
    • Pytest-style unit tests
    • Unit tests are in a "test" folder within the folder a new model was added to
    • If applicable add integration tests
  • Example: If applicable, a working example demonstrating the new model has been created
    • Input file comments
    • Run file comments
    • Example has been tested and runs successfully in test_all_examples.py
  • Documentation:
    • Write docstrings using the Google style
    • Model added to the main models list in docs/user_guide/model_overview.md
      • Model documentation page added to the appropriate docs/ section
      • <model_name>.md is added to the _toc.yml

@genevievestarke genevievestarke added the ready for review This PR is ready for input from folks label Apr 7, 2026
@johnjasa johnjasa self-requested a review April 8, 2026 04:42
Copy link
Copy Markdown
Collaborator

@johnjasa johnjasa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this PR, @genevievestarke! I love your proactive approach and you being discerning in what all to change and what to keep here (not just blindly find-and-replacing).

I've pushed up some minor additions that I think we should tackle in this one. Namely GitHub repos that have been renamed (NREL -> NatLabRockies and WISDEM -> NLRWindSystems) that GitHub would probably always redirect (until it doesn't), but we might as well update them.

This is ready to come in imo, but I'll just approve and won't merge in case you had other changes coming in or other folks have comments. Feel free to merge it when you want!

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

Labels

ready for review This PR is ready for input from folks

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants