Repository navigation
More broken links (internal and external) #2489
Description
Describe the bug
#2488 is my source of inspiration. Grep'ed for user_guide pages, and these ones are the broken ones. Also, I've run linkchecker (output below). Feel free to provide other useful inputs for grep to check for broken links.
Broken user_guide references
README.md:77:https://pvlib-python.readthedocs.io/en/stable/user_guide/installation.html
docs/sphinx/source/conf.py:163:https://pydata-sphinx-theme.rtfd.io/en/latest/user_guide/configuring.html
Linkchecker output
( whatsnew: line 97) broken https://github.com/solphie-pelland - 404 Client Error: Not Found for url: https://github.com/solphie-pelland
( whatsnew: line 215) broken https://github.com/thunderfish24 - 404 Client Error: Not Found for url: https://github.com/thunderfish24
(contributing/style_guide: line 31) broken https://help.github.com/articles/about-pull-request-merges/#squash-and-merge-your-pull-request-commits - Anchor 'squash-and-merge-your-pull-request-commits' not found
(reference/generated/pvlib.iotools.get_pvgis_hourly: line 1) broken https://re.jrc.ec.europa.eu/api/v5_2/ - 404 Client Error: NOT FOUND for url: https://re.jrc.ec.europa.eu/api/v5_2/
(reference/generated/pvlib.clearsky.bird: line 57) broken https://www.nrel.gov/docs/legosti/old/761.pdf - 404 Client Error: Not Found for url: https://www.nrel.gov/docs/legosti/old/761.pdf
(reference/generated/pvlib.spectrum.get_reference_spectra: line 27) broken https://www.nrel.gov/grid/solar-resource/assets/data/astmg173.xls - 404 Client Error: Not Found for url: https://www.nrel.gov/grid/solar-resource/assets/data/astmg173.xls
(reference/generated/pvlib.spectrum.spectral_factor_jrc: line 54) broken https://www.researchgate.net/publication/256080247 - 403 Client Error: Forbidden for url: https://www.researchgate.net/publication/256080247
(reference/generated/pvlib.iotools.read_solaranywhere: line 23) broken https://www.solaranywhere.com/support/historical-data/file-formats/ - 520 Server Error: for url: https://www.solaranywhere.com/support/historical-data/file-formats/
(reference/generated/pvlib.iotools.get_solaranywhere: line 75) broken https://www.solaranywhere.com/support/data-fields/definitions/ - 520 Server Error: for url: https://www.solaranywhere.com/support/data-fields/definitions/
(reference/generated/pvlib.iotools.get_solaranywhere: line 69) broken https://www.solaranywhere.com/support/using-solaranywhere/api/ - 520 Server Error: for url: https://www.solaranywhere.com/support/using-solaranywhere/api/
(gallery/spectrum/average_photon_energy: line 220) broken https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html#pandas.DataFrame - HTTPSConnectionPool(host='pandas.pydata.org', port=443): Max retries exceeded with url: /pandas-docs/stable/reference/api/pandas.DataFrame.html (Caused by SSLError(SSLEOFError(8, 'EOF occurred in violation of protocol (_ssl.c:1006)')))
( whatsnew: line 83) broken https://github.com/Sandia-Labs/PVLIB_Python - 404 Client Error: Not Found for url: https://github.com/Sandia-Labs/PVLIB_Python
( whatsnew: line 99) broken https://github.com/bhellis725 - 404 Client Error: Not Found
for url: https://github.com/bhellis725
( whatsnew: line 89) broken https://github.com/johnMoseleyArray - 404 Client Error: Not
Found for url: https://github.com/johnMoseleyArray
( whatsnew: line 79) broken https://github.com/kanderso-nrel - 404 Client Error: Not Found for url: https://github.com/kanderso-nrel
sleeping...
(contributing/introduction_to_contributing: line 54) broken https://github.com/pvlib/pvlib-python/blob/main/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct - Anchor 'contributor-covenant-code-of-conduct' not found
To Reproduce
See this comment. In a nutshell, run the linkcheck Sphinx builder from the command line (working directory of Makefiles in the docs tree).
Expected behavior
N/A
Screenshots
N/A
Versions:
pvlib.__version__: latest in main at the time of writing
Additional context
Expected links to be updated are related to external documentation pages that complement pvlib's doc pages. Unrelevant links (like broken github users) can be ignored.
Activity
Fix broken user guide references
Fix all broken documentation links from linkchecker
Update GitHub usernames to current handles
Remove invalid johnMoseleyArray GitHub username
Fix broken links throughout codebase
Improve documentation links with DOIs and updated URLs
Fix reference formatting to comply with IEEE style guide
aman-coder03 commentedon Nov 28, 2025
Can I work on this?
7 remaining items
dgowdaan-cmyk commentedon Jul 8, 2026
Hi @echedey-ls, I'd like to pick this up. I can see a few rounds of link fixes have already
landed (#2594, #2610, #2622), so I'll run
make linkcheckfresh from main to get the currentlist of broken links before touching anything, rather than assuming the original list in this
issue is still accurate.
I'll focus on the genuinely fixable external/internal doc links (dead NREL/vendor URLs, broken
anchors, etc.) and skip low-value ones like unrelated dead GitHub profile links, per your note
above. Will open a focused PR once I have the current linkcheck output.
echedey-ls commentedon Jul 8, 2026
Please, go ahead @dgowdaan-cmyk . Take it easy and report which commands you've run so we can spot and verify what may be missing more easily.
dgowdaan-cmyk commentedon Jul 9, 2026
Ran
make linkcheckon main. Full run found 108 flagged links , but most are false positives -sites like Wiley, ASME, ResearchGate, JSTOR, and StackOverflow return 403 to bots but work fine for real users , so I'm leaving those alone.Genuinely dead links worth fixing (~15):
Skipping the old dead GitHub profile links in whatsnew.rst per your earlier note.
I'll track down current URLs for each of these and open a PR. Flagging before I start in case any of these look like they should just be removed instead of replaced.
dgowdaan-cmyk commentedon Jul 9, 2026
Update: started tracking down replacement URLs for the dead links. Confirmed so far:
pvlib.clearsky.bird: NREL restructured their URLs (and fixed the oldnlr.govdomain typo).www.nlr.gov/grid/solar-resource/clearsky.html→ New:https://www.nrel.gov/grid/solar-resource/clear-sky.../clearsky-error-reports.htmlpage no longer exists as a separate page — that content appears to have been folded into the main clear-sky page above, so I'll point both references there (or drop the second one if it doesn't make sense once merged).pvlib.spectrum.get_reference_spectra: the direct.xlsasset path (.../assets/data/astmg173.xls) has moved and I can't find its exact new location, but the stable landing page still works:→
https://www.nrel.gov/grid/solar-resource/spectra-am1.5Still working through the rest (EnergyPlus, Sandia PDFs, PVGIS API version, Solcast, DuraMAT, git-scm anchor, the malformed Wikipedia URL, and the GitHub docs anchor). Will post the full list once I've verified replacements for all of them rather than trickle updates - should have it wrapped up soon.
dgowdaan-cmyk commentedon Jul 9, 2026
Progress update - fixed and tested locally so far:
pvlib.clearsky.bird: updated to current NREL clear-sky pagepvlib.spectrum.get_reference_spectra: fixed NREL domain typo + updated ASTM G173 linkpvlib.iotools.parse_epw: EnergyPlus docs moved to readthedocs, updated both referencespvlib.solarposition.spa_c: fixed a malformed Wikipedia URL (unencoded trailing parenthesis was breaking the link)installation.rst: fixed git-scm.com link to match the correct URL already used elsewhere in the same fileStill working through: the two dead prod.sandia.gov PDFs, the PVGIS API version bump, Solcast's registration page, DuraMAT's datahub link, and a renamed GitHub docs anchor. Will open the PR once I've got replacements for all of these (or confirmed removal is the right call for any that don't have one).