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

Correct usage of xtol in ghi_from_poa_driesse_2023 #1971

Merged

Conversation

echedey-ls
Copy link
Contributor

@echedey-ls echedey-ls commented Feb 10, 2024

  • Closes [BUG]: unused xtol argument in ghi_from_poa_driesse_2023 #1970
  • 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.

I believe linked issue gives enough context.

@echedey-ls echedey-ls marked this pull request as ready for review February 10, 2024 22:36
@cwhanse cwhanse added the bug label Feb 11, 2024
@cwhanse cwhanse added this to the v0.10.4 milestone Feb 11, 2024
Convergence criterion. The estimated GHI will be within xtol of the
true value. [W/m^2]
Convergence criterion. The estimated GHI will be within xtol of the
true value. Must be positive. [W/m^2]
Copy link
Member

Choose a reason for hiding this comment

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

Interestingly, the bisect docstring says nonnegative, which is inconsistent with its code.

@@ -1599,7 +1603,7 @@ def ghi_from_poa_driesse_2023(surface_tilt, surface_azimuth,
solar_zenith, solar_azimuth,
poa_global,
dni_extra, airmass, albedo,
xtol=0.01)
xtol=xtol)
Copy link
Member

Choose a reason for hiding this comment

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

Good catch!

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.

Thanks @echedey-ls!

@kandersolar kandersolar changed the title Typofix ghi from poa driesse 2023 xtol Correct usage of xtol in ghi_from_poa_driesse_2023 Feb 12, 2024
@kandersolar kandersolar merged commit e92ee94 into pvlib:main Feb 12, 2024
34 checks passed
@echedey-ls echedey-ls deleted the typofix-ghi_from_poa_driesse_2023-xtol branch February 12, 2024 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG]: unused xtol argument in ghi_from_poa_driesse_2023
4 participants