Skip to content

Commit

Permalink
Update limits docstring from review
Browse files Browse the repository at this point in the history
Co-authored-by: Kevin Anderson <[email protected]>
  • Loading branch information
AdamRJensen and kandersolar authored Oct 28, 2024
1 parent 8eef26e commit 5b8391b
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions pvanalytics/quality/irradiance.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,9 @@ def check_dhi_limits_qcrad(dhi, solar_zenith, dni_extra, limits='physical'):
Extraterrestrial normal irradiance in :math:`W/m^2`
limits : {'physical', 'extreme'} or dict, default 'physical'
If string, must be either 'physical' or 'extreme', corresponding to the
QCRAD QC limits. If dict, must have keys 'ghi_ub' and 'ghi_lb'. For
'ghi_ub' value is a dict with keys {'mult', 'exp', 'min'} and float
values. For 'ghi_lb' value is a float.
QCRAD QC limits. If dict, must have keys 'dhi_ub' and 'dhi_lb'. For
'dhi_ub' value is a dict with keys {'mult', 'exp', 'min'} and float
values. For 'dhi_lb' value is a float.
Returns
-------
Expand Down Expand Up @@ -170,9 +170,9 @@ def check_dni_limits_qcrad(dni, solar_zenith, dni_extra, limits='physical'):
Extraterrestrial normal irradiance in :math:`W/m^2`
limits : {'physical', 'extreme'} or dict, default 'physical'
If string, must be either 'physical' or 'extreme', corresponding to the
QCRAD QC limits. If dict, must have keys 'ghi_ub' and 'ghi_lb'. For
'ghi_ub' value is a dict with keys {'mult', 'exp', 'min'} and float
values. For 'ghi_lb' value is a float.
QCRAD QC limits. If dict, must have keys 'dni_ub' and 'dni_lb'. For
'dni_ub' value is a dict with keys {'mult', 'exp', 'min'} and float
values. For 'dni_lb' value is a float.
Returns
-------
Expand Down Expand Up @@ -229,9 +229,11 @@ def check_irradiance_limits_qcrad(solar_zenith, dni_extra, ghi=None, dhi=None,
Direct normal irradiance in :math:`W/m^2`
limits : {'physical', 'extreme'} or dict, default 'physical'
If string, must be either 'physical' or 'extreme', corresponding to the
QCRAD QC limits. If dict, must have keys 'ghi_ub' and 'ghi_lb'. For
'ghi_ub' value is a dict with keys {'mult', 'exp', 'min'} and float
values. For 'ghi_lb' value is a float.
QCRAD QC limits. If dict, must have keys:
* 'ghi_ub', 'dhi_ub', 'dni_ub': dicts with keys
{'mult', 'exp', 'min'} and float values.
* 'ghi_lb', 'dhi_lb', 'dni_lb': float values.
Returns
-------
Expand Down

0 comments on commit 5b8391b

Please sign in to comment.