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

Improve docstring for get_ground_diffuse #1953

Merged
merged 11 commits into from Feb 27, 2024

Conversation

cwhanse
Copy link
Member

@cwhanse cwhanse commented Jan 26, 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.

Reformat reference section and update links in get_ground_diffuse.

Fresh snow albedo value in irradiance.SURFACE_ALBEDOS conflicts with sources. Perhaps we change to 0.80 (wikipedia value); PVsyst uses 0.82.

@cwhanse cwhanse added this to the v0.10.4 milestone Jan 26, 2024
@cwhanse cwhanse mentioned this pull request Jan 26, 2024
5 tasks
pvlib/irradiance.py Outdated Show resolved Hide resolved
@echedey-ls
Copy link
Contributor

Notes
-----
Ground diffuse irradiance is the the last term of equations 3, 4, 7, 8,
10, 11, and 12 in [1]_. Table of albedo values by ``surface_type``
Copy link
Member

@adriesse adriesse Jan 28, 2024

Choose a reason for hiding this comment

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

Could you describe what that last term is, rather than refer to a paper that's not openly accessible?

Copy link
Member Author

Choose a reason for hiding this comment

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

There's a preprint here but one has to find it by searching the title.

pvlib/irradiance.py Outdated Show resolved Hide resolved
@kandersolar kandersolar merged commit 74e1fd1 into pvlib:main Feb 27, 2024
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants