Skip to content

Commit 4f78af5

Browse files
committed
ongoing...
1 parent 89e7e71 commit 4f78af5

File tree

1 file changed

+49
-38
lines changed

1 file changed

+49
-38
lines changed

pvlib/irradiance.py

Lines changed: 49 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -465,31 +465,31 @@ def poa_components(aoi, dni, poa_sky_diffuse, poa_ground_diffuse):
465465
----------
466466
aoi : numeric
467467
Angle of incidence of solar rays with respect to the module
468-
surface, from :func:`aoi`.
468+
surface, from :func:`aoi` [°]. See :term:`aoi`.
469469
470470
dni : numeric
471-
Direct normal irradiance (Wm⁻²), as measured from a TMY file or
472-
calculated with a clearsky model.
471+
Direct normal irradiance [Wm⁻²], as measured from a TMY file or
472+
calculated with a clearsky model. See :term:`dni`.
473473
474474
poa_sky_diffuse : numeric
475-
Diffuse irradiance (Wm⁻²) in the plane of the modules, as
476-
calculated by a diffuse irradiance translation function
475+
Diffuse irradiance [Wm⁻²] in the plane of the modules, as
476+
calculated by a diffuse irradiance translation function.
477477
478478
poa_ground_diffuse : numeric
479-
Ground reflected irradiance (Wm⁻²) in the plane of the modules,
479+
Ground reflected irradiance [Wm⁻²] in the plane of the modules,
480480
as calculated by an albedo model (eg. :func:`grounddiffuse`)
481481
482482
Returns
483483
-------
484484
irrads : OrderedDict or DataFrame
485485
Contains the following keys:
486486
487-
* ``poa_global`` : Total in-plane irradiance (Wm⁻²)
488-
* ``poa_direct`` : Total in-plane beam irradiance (Wm⁻²)
489-
* ``poa_diffuse`` : Total in-plane diffuse irradiance (Wm⁻²)
490-
* ``poa_sky_diffuse`` : In-plane diffuse irradiance from sky (Wm⁻²)
487+
* ``poa_global`` : Total in-plane irradiance [Wm⁻²]
488+
* ``poa_direct`` : Total in-plane beam irradiance [Wm⁻²]
489+
* ``poa_diffuse`` : Total in-plane diffuse irradiance [Wm⁻²]
490+
* ``poa_sky_diffuse`` : In-plane diffuse irradiance from sky [Wm⁻²]
491491
* ``poa_ground_diffuse`` : In-plane diffuse irradiance from ground
492-
(Wm⁻²)
492+
[Wm⁻²]
493493
494494
Notes
495495
------
@@ -1545,13 +1545,13 @@ def ghi_from_poa_driesse_2023(surface_tilt, surface_azimuth,
15451545
Parameters
15461546
----------
15471547
surface_tilt : numeric
1548-
Panel tilt from horizontal. [degree]
1548+
Panel tilt from horizontal. [°]
15491549
surface_azimuth : numeric
1550-
Panel azimuth from north. [degree]
1550+
Panel azimuth from north. [°]
15511551
solar_zenith : numeric
1552-
Solar zenith angle. [degree]
1552+
Solar zenith angle. [°]
15531553
solar_azimuth : numeric
1554-
Solar azimuth angle. [degree]
1554+
Solar azimuth angle. [°]
15551555
poa_global : numeric
15561556
Plane-of-array global irradiance, aka global tilted irradiance [Wm⁻²].
15571557
dni_extra : numeric, optional
@@ -3707,24 +3707,35 @@ def complete_irradiance(solar_zenith,
37073707
37083708
Parameters
37093709
----------
3710-
solar_zenith : Series
3711-
Zenith angles in decimal degrees, with datetime index.
3710+
solar_zenith : series
3711+
Solar zenith angle [°], with datetime index.
37123712
Angles must be >=0 and <=180. Must have the same datetime index
3713-
as ghi, dhi, and dni series, when available.
3713+
as ghi, dhi, and dni series, when available. See :term:`solar_zenith`.
37143714
ghi : Series, optional
3715-
Pandas series of dni data, with datetime index. Must have the same
3716-
datetime index as dni, dhi, and zenith series, when available.
3715+
Pandas series of dni data [Wm⁻²], with datetime index. Must have the
3716+
same datetime index as dni, dhi, and zenith series, when available.
3717+
See :term:`ghi`.
37173718
dhi : Series, optional
3718-
Pandas series of dni data, with datetime index. Must have the same
3719-
datetime index as ghi, dni, and zenith series, when available.
3719+
Pandas series of dni data [Wm⁻²], with datetime index. Must have the
3720+
same datetime index as ghi, dni, and zenith series, when available.
3721+
See :term:`dhi`.
37203722
dni : Series, optional
3721-
Pandas series of dni data, with datetime index. Must have the same
3722-
datetime index as ghi, dhi, and zenith series, when available.
3723+
Pandas series of dni data [Wm⁻²], with datetime index. Must have the
3724+
same datetime index as ghi, dhi, and zenith series, when available.
3725+
See :term:`dni`.
37233726
dni_clear : Series, optional
3724-
Pandas series of clearsky dni data. Must have the same datetime index
3725-
as ghi, dhi, dni, and zenith series, when available. See
3726-
:py:func:`dni` for details.
3727-
3727+
Pandas series of clearsky dni data [Wm⁻²]. Must have the same datetime
3728+
index as ghi, dhi, dni, and zenith series, when available. See
3729+
:py:func:`dni` for details. See :term:`dni_clear` for glossary
3730+
definition.
3731+
3732+
3733+
solar_azimuth : numeric
3734+
Solar azimuth angle. [°]
3735+
poa_global : numeric
3736+
Plane-of-array global irradiance, aka global tilted irradiance .
3737+
dni_extra : numeric, optional
3738+
Extraterrestrial direct normal irradiance [Wm⁻²].
37283739
Returns
37293740
-------
37303741
component_sum_df : Dataframe
@@ -3758,11 +3769,11 @@ def louche(ghi, solar_zenith, datetime_or_doy, max_zenith=90):
37583769
Parameters
37593770
----------
37603771
ghi : numeric
3761-
Global horizontal irradiance [Wm⁻²].
3772+
Global horizontal irradiance [Wm⁻²]. See :term:`ghi`.
37623773
37633774
solar_zenith : numeric
3764-
True (not refraction-corrected) zenith angles in decimal
3765-
degrees. Angles must be >=0 and <=90.
3775+
True (not refraction-corrected) zenith angles [°].
3776+
Angles must be >=0° and <=90°. See :term:`solar_zenith`.
37663777
37673778
datetime_or_doy : numeric, pandas.DatetimeIndex
37683779
Day of year or array of days of year e.g.
@@ -3773,11 +3784,11 @@ def louche(ghi, solar_zenith, datetime_or_doy, max_zenith=90):
37733784
data: OrderedDict or DataFrame
37743785
Contains the following keys/columns:
37753786
3776-
* ``dni``: the modeled direct normal irradiance [Wm⁻²].
3777-
* ``dhi``: the modeled diffuse horizontal irradiance in
3778-
Wm⁻².
3779-
* ``kt``: Ratio of global to extraterrestrial irradiance
3780-
on a horizontal plane.
3787+
* ``dni``: the modeled direct normal irradiance [Wm⁻²]. See :term:`dni`
3788+
* ``dhi``: the modeled diffuse horizontal irradiance [Wm⁻²].
3789+
See :term:`dhi`
3790+
* ``kt``: Clearness index [unitless], ratio of global to
3791+
extraterrestrial irradiance on a horizontal plane.
37813792
37823793
References
37833794
-------
@@ -3822,12 +3833,12 @@ def diffuse_par_spitters(daily_solar_zenith, global_diffuse_fraction):
38223833
38233834
.. note::
38243835
The diffuse fraction is defined as the ratio of
3825-
diffuse to global daily insolation, in J m⁻² day⁻¹ or equivalent.
3836+
diffuse to global daily insolation, in Jm⁻² day⁻¹ or equivalent.
38263837
38273838
Parameters
38283839
----------
38293840
daily_solar_zenith : numeric
3830-
Average daily solar zenith angle. In degrees [°].
3841+
Average daily solar zenith angle [°].
38313842
38323843
global_diffuse_fraction : numeric
38333844
Fraction of daily global broadband insolation that is diffuse.

0 commit comments

Comments
 (0)