Skip to content

Standardize pvgis_hourly to return (data,meta) #2462

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
May 29, 2025

Conversation

AdamRJensen
Copy link
Member

@AdamRJensen AdamRJensen commented May 26, 2025

  • I am familiar with the contributing guidelines
  • Tests added
  • Adds description and name entries in the appropriate "what's new" file in docs/sphinx/source/whatsnew for all changes. Includes link to the GitHub Issue with :issue:`num` or this Pull Request with :pull:`num`. Includes contributor name and/or GitHub username (link with :ghuser:`user`).
  • New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
  • Pull request is nearly complete and ready for detailed review.
  • Maintainer: Appropriate GitHub Labels (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.

The pvlib.iotools.get_pvgis_hourly and read_pvigs_hourly currently does not follow the iotools standard convention returning a tuple with (data,meta). Instead the functions currently output (data,inputs,meta), which is causing a lot of confusion for new users, particular this is a major pain point during intro tutorials. This PR introduces impelements a breaking change of by changing the output of the functions to follow the iotools standard convention.

@AdamRJensen AdamRJensen added the io label May 26, 2025
@AdamRJensen AdamRJensen added the remote-data triggers --remote-data pytests label May 26, 2025
Copy link
Member

@kandersolar kandersolar left a comment

Choose a reason for hiding this comment

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

This change (move the inputs dict to be within the returned metadata dict instead of a separate variable) is okay with me.

A few minor suggestions below. Otherwise, my only feedback is that it would be nice if the descriptions of the metadata dict in Returns were more useful.

AdamRJensen and others added 2 commits May 27, 2025 11:30
Co-authored-by: Kevin Anderson <kevin.anderso@gmail.com>
@AdamRJensen AdamRJensen merged commit 7b7e3c7 into pvlib:main May 29, 2025
29 of 30 checks passed
@AdamRJensen AdamRJensen deleted the standardize_pvgis_hourly branch May 29, 2025 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
io remote-data triggers --remote-data pytests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants