From 12bd36b3a4ec5cd69e238937af1f2f2a37143cb5 Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Thu, 5 Oct 2023 13:20:12 +0545 Subject: [PATCH 1/5] Update documentation --- docs/sphinx/source/whatsnew/v0.10.3.rst | 3 ++- pvlib/irradiance.py | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/whatsnew/v0.10.3.rst b/docs/sphinx/source/whatsnew/v0.10.3.rst index 30b9f576b0..eeea6ca0ef 100644 --- a/docs/sphinx/source/whatsnew/v0.10.3.rst +++ b/docs/sphinx/source/whatsnew/v0.10.3.rst @@ -28,4 +28,5 @@ Contributors ~~~~~~~~~~~~ * Arjan Keeman (:ghuser:`akeeman`) * Miguel Sánchez de León Peque (:ghuser:`Peque`) -* Will Hobbs (:ghuser:`williamhobbs`) \ No newline at end of file +* Will Hobbs (:ghuser:`williamhobbs`) +* Adam R. Jensen (:ghuser:`AdamRJensen`) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 7e66281974..a3498cd2a6 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -542,7 +542,8 @@ 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. Isotropic ground reflections are + assumed. Function to determine the portion of irradiance on a tilted surface due to ground reflections. Any of the inputs may be DataFrames or From 52c5580c23b2b3718eea9f2edebf93b60df66acb Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Thu, 5 Oct 2023 21:32:33 +0545 Subject: [PATCH 2/5] Add Cliff's statement --- pvlib/irradiance.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index a3498cd2a6..eb3a336468 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -542,8 +542,8 @@ 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. Isotropic ground reflections are - assumed. + irradiance, albedo, and surface tilt. The ground is assumed to + be isotropic and reflections are Lambertian. Function to determine the portion of irradiance on a tilted surface due to ground reflections. Any of the inputs may be DataFrames or From ea7cdd6131d97be6cc60a4c1ddfba45056e63a57 Mon Sep 17 00:00:00 2001 From: Cliff Hansen Date: Thu, 1 Feb 2024 08:16:11 -0700 Subject: [PATCH 3/5] undo edits to v0.10.3 whatsnew --- docs/sphinx/source/whatsnew/v0.10.3.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/sphinx/source/whatsnew/v0.10.3.rst b/docs/sphinx/source/whatsnew/v0.10.3.rst index 82abecd455..4d222fca06 100644 --- a/docs/sphinx/source/whatsnew/v0.10.3.rst +++ b/docs/sphinx/source/whatsnew/v0.10.3.rst @@ -57,7 +57,6 @@ Contributors * Arjan Keeman (:ghuser:`akeeman`) * Miguel Sánchez de León Peque (:ghuser:`Peque`) * Will Hobbs (:ghuser:`williamhobbs`) -* Adam R. Jensen (:ghuser:`AdamRJensen`) * Anton Driesse (:ghuser:`adriesse`) * Abigail Jones (:ghuser:`ajonesr`) * Cliff Hansen (:ghuser:`cwhanse`) From 5a11ef1b6a8778141ad8f04477c893ca28e7b74f Mon Sep 17 00:00:00 2001 From: Cliff Hansen Date: Thu, 1 Feb 2024 08:18:53 -0700 Subject: [PATCH 4/5] whatsnew --- docs/sphinx/source/whatsnew/v0.10.4.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/sphinx/source/whatsnew/v0.10.4.rst b/docs/sphinx/source/whatsnew/v0.10.4.rst index 4d7b158552..f435f9e444 100644 --- a/docs/sphinx/source/whatsnew/v0.10.4.rst +++ b/docs/sphinx/source/whatsnew/v0.10.4.rst @@ -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 ~~~~~~~~~~~~ @@ -29,3 +30,4 @@ Requirements Contributors ~~~~~~~~~~~~ * :ghuser:`matsuobasho` +* Adam R. Jensen (:ghuser:`AdamRJensen`) From 6e446405e8fa4671e9471705924872cc9bb542aa Mon Sep 17 00:00:00 2001 From: Cliff Hansen Date: Thu, 1 Feb 2024 08:19:22 -0700 Subject: [PATCH 5/5] Update pvlib/irradiance.py --- pvlib/irradiance.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 35630729b1..3bec66b668 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -554,7 +554,8 @@ def get_ground_diffuse(surface_tilt, ghi, albedo=.25, surface_type=None): ''' Estimate diffuse irradiance from ground reflections given irradiance, albedo, and surface tilt. The ground is assumed to - be isotropic and reflections are Lambertian. + 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