Standardize pvgis_tmy to return (data,meta) #2470
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kandersolar
approved these changes
Jun 5, 2025
Comment on lines
+396
to
+401
| # Re-create original outputs (prior to #2470) | ||
| months_selected = meta['months_selected'] | ||
| inputs = meta['inputs'].copy() | ||
| del inputs['descriptions'] | ||
| meta['inputs'] = meta['inputs']['descriptions'] | ||
| del meta['months_selected'] |
There was a problem hiding this comment.
This seems a little hacky to me. Ok if it's just to get the API change in for this release, but let's at least open an issue to update the expected values to match the new format.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
docs/sphinx/source/whatsnewfor 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`).remote-data) and Milestone are assigned to the Pull Request and linked Issue.The
pvlib.iotools.get_pvgis_tmyandread_pvigs_tmycurrently do not follow the iotools standard convention of returning a tuple with (data,meta). Instead, the functions currently output(data,moths_selected,inputs,meta), which is causing a lot of confusion for new users, particularly this is a major pain point during intro tutorials. This PR introduces a breaking change by changing the output of the functions to follow the iotools standard convention.Related to #2462.