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

Update get_ground_diffuse description #1883

Merged
merged 6 commits into from Feb 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/sphinx/source/whatsnew/v0.10.4.rst
Expand Up @@ -21,6 +21,7 @@ Testing
Documentation
~~~~~~~~~~~~~
* Fixed broken URLs in various docstrings. (:pull:`1957`)
* Clarified documentation for :py:func:`~pvlib.irradiance.get_ground_diffuse`. (:pull:`1883`)

Requirements
~~~~~~~~~~~~
Expand All @@ -29,3 +30,4 @@ Requirements
Contributors
~~~~~~~~~~~~
* :ghuser:`matsuobasho`
* Adam R. Jensen (:ghuser:`AdamRJensen`)
4 changes: 3 additions & 1 deletion pvlib/irradiance.py
Expand Up @@ -553,7 +553,9 @@ def poa_components(aoi, dni, poa_sky_diffuse, poa_ground_diffuse):
def get_ground_diffuse(surface_tilt, ghi, albedo=.25, surface_type=None):
'''
Estimate diffuse irradiance from ground reflections given
irradiance, albedo, and surface tilt.
irradiance, albedo, and surface tilt. The ground is assumed to
be horizontal, flat and Lambertian, and the reflected irradiance
is isotropic.

Function to determine the portion of irradiance on a tilted surface
due to ground reflections. Any of the inputs may be DataFrames or
Expand Down