Skip to content

Commit 8a7927a

Browse files
authored
Update get_extra_radiation references (#2437)
* link to pvlib.solarposition.nrel_earthsun_distance * add solar constant units * (incomplete) reference updates * add nrel reference, remove `` * ieee formatting [4] * text suggestion to link Reno and Beckman refs * remove partridge, update uoregon * blank space * close url * long url * # noqa: E501 * # noqa: E501 * two spaces * formatting * beckman reference * Update v0.12.1.rst * Update irradiance.py * update rg allen reference + linter * rephrase description
1 parent 1428b6b commit 8a7927a

File tree

2 files changed

+26
-15
lines changed

2 files changed

+26
-15
lines changed

docs/sphinx/source/whatsnew/v0.12.1.rst

+2
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ Documentation
3232
* Add a supporting reference to :py:func:`pvlib.atmosphere.get_relative_airmass` (:issue:`2390`, :pull:`2424`)
3333
* Documented how `np.nan` values are handled by :py:func:`~pvlib.spectrum.average_photon_energy`
3434
(:issue:`2423`, :pull:`2426`)
35+
* Update references in :py:func`~pvlib.irradiance.get_extra_radiation`
36+
(:issue:`2333`, :pull:`2347`)
3537

3638
Requirements
3739
~~~~~~~~~~~~

pvlib/irradiance.py

+24-15
Original file line numberDiff line numberDiff line change
@@ -35,25 +35,30 @@ def get_extra_radiation(datetime_or_doy, solar_constant=1366.1,
3535
"""
3636
Determine extraterrestrial radiation from day of year.
3737
38+
Specific references for each method are cited in the parameter descriptions
39+
below, while a more general discussion of the different models may also be
40+
found in [1]_ and [2]_.
41+
3842
Parameters
3943
----------
4044
datetime_or_doy : numeric, array, date, datetime, Timestamp, DatetimeIndex
4145
Day of year, array of days of year, or datetime-like object
4246
4347
solar_constant : float, default 1366.1
44-
The solar constant.
48+
The solar constant. [Wm⁻²]
4549
46-
method : string, default 'spencer'
47-
The method by which the ET radiation should be calculated.
48-
Options include ``'pyephem', 'spencer', 'asce', 'nrel'``.
50+
method : string, default `spencer`
51+
The method by which the extraterrestrial radiation should be
52+
calculated. Options include: `pyephem`, `spencer` [3]_, `asce` [4]_,
53+
'nrel' [6]_.
4954
5055
epoch_year : int, default 2014
5156
The year in which a day of year input will be calculated. Only
52-
applies to day of year input used with the pyephem or nrel
57+
applies to day of year input used with the `pyephem` or `nrel`
5358
methods.
5459
5560
kwargs :
56-
Passed to solarposition.nrel_earthsun_distance
61+
Passed to :py:func:`~pvlib.solarposition.nrel_earthsun_distance`.
5762
5863
Returns
5964
-------
@@ -68,19 +73,23 @@ def get_extra_radiation(datetime_or_doy, solar_constant=1366.1,
6873
.. [1] M. Reno, C. Hansen, and J. Stein, "Global Horizontal Irradiance
6974
Clear Sky Models: Implementation and Analysis", Sandia National
7075
Laboratories, SAND2012-2389, 2012.
76+
:doi:`10.2172/1039404`
7177
72-
.. [2] http://solardata.uoregon.edu/SolarRadiationBasics.html, Eqs.
73-
SR1 and SR2
78+
.. [2] J. A. Duffie, W. A. Beckman, N. Blair, "Solar Radiation", in Solar
79+
Engineering of Thermal Processes, Photovoltaics and Wind, 5th ed,
80+
New York, USA: J. Wiley and Sons, 2020, pp. 3-44.
81+
:doi:`10.1002/9781119540328`
7482
75-
.. [3] Partridge, G. W. and Platt, C. M. R. 1976. Radiative Processes
76-
in Meteorology and Climatology.
83+
.. [3] J. W. Spencer, "Fourier series representation of the sun," Search,
84+
vol. 2, p. 172, 1971.
7785
78-
.. [4] Duffie, J. A. and Beckman, W. A. 1991. Solar Engineering of
79-
Thermal Processes, 2nd edn. J. Wiley and Sons, New York.
86+
.. [4] R. G. Allen et al., Eds. The ASCE standardized reference
87+
evapotranspiration equation. Reston, Va.: American Society of Civil
88+
Engineers, 2005. :doi:`10.1061/9780784408056`
8089
81-
.. [5] ASCE, 2005. The ASCE Standardized Reference Evapotranspiration
82-
Equation, Environmental and Water Resources Institute of the American
83-
Civil Engineers, Ed. R. G. Allen et al.
90+
.. [6] I. Reda, A. Andreas, "Solar position algorithm for solar
91+
radiation applications" NREL Golden, USA. NREL/TP-560-34302,
92+
Revised 2008. :doi:`10.2172/15003974`
8493
"""
8594

8695
to_doy, to_datetimeindex, to_output = \

0 commit comments

Comments
 (0)