Skip to content
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

Have pvlib.iotools.read_solrad return metadata #1968

Merged
merged 7 commits into from Mar 5, 2024

Conversation

AdamRJensen
Copy link
Member

@AdamRJensen AdamRJensen commented Feb 9, 2024

  • [ ] Closes #xxxx
  • I am familiar with the contributing guidelines
  • Tests added
  • Updates entries in docs/sphinx/source/reference for API changes.
  • 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 read_solrad function currently does not follow the standard pattern of returning (data, metadata). This PR adds metadata parsing to the function and is thus a breaking change.

@AdamRJensen AdamRJensen added the io label Feb 9, 2024
@AdamRJensen AdamRJensen added this to the v0.10.4 milestone Feb 9, 2024
@AdamRJensen AdamRJensen added the remote-data triggers --remote-data pytests label Feb 9, 2024
@AdamRJensen AdamRJensen added remote-data triggers --remote-data pytests and removed remote-data triggers --remote-data pytests labels Feb 9, 2024
@kandersolar kandersolar modified the milestones: v0.10.4, 0.11.0 Feb 12, 2024
@kandersolar kandersolar modified the milestones: 0.11.0, v0.10.4 Feb 27, 2024
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.

I've been persuaded that this is minor enough to be more of an enhancement than a breaking change, and so should go in 0.10.4. I changed the milestone accordingly.

Nice improvements to the tests by the way!

pvlib/iotools/solrad.py Outdated Show resolved Hide resolved
pvlib/iotools/solrad.py Outdated Show resolved Hide resolved
@AdamRJensen AdamRJensen added remote-data triggers --remote-data pytests and removed remote-data triggers --remote-data pytests labels Mar 1, 2024
@kandersolar kandersolar merged commit 33045d2 into pvlib:main Mar 5, 2024
40 of 41 checks passed
@kandersolar kandersolar mentioned this pull request Mar 5, 2024
7 tasks
@AdamRJensen AdamRJensen deleted the read_solrad_return_metadata branch March 9, 2024 12:42
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.

None yet

4 participants