pvlib 0.13.0__py3-none-any.whl → 0.13.1a1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
pvlib/irradiance.py CHANGED
@@ -63,10 +63,11 @@ def get_extra_radiation(datetime_or_doy, solar_constant=1366.1,
63
63
  Returns
64
64
  -------
65
65
  dni_extra : float, array, or Series
66
- The extraterrestrial radiation present in watts per square meter
67
- on a surface which is normal to the sun. Pandas Timestamp and
68
- DatetimeIndex inputs will yield a Pandas TimeSeries. All other
69
- inputs will yield a float or an array of floats.
66
+ The extraterrestrial radiation normal to the sun.
67
+ Pandas Timestamp and DatetimeIndex inputs for ``datetime_or_doy``
68
+ will return ``dni_extra`` as a Pandas TimeSeries. All other input
69
+ data types will yield ``dni_extra`` as a float or an array of floats.
70
+ See :term:`dni_extra`. [Wm⁻²]
70
71
 
71
72
  References
72
73
  ----------
@@ -171,18 +172,22 @@ def aoi_projection(surface_tilt, surface_azimuth, solar_zenith, solar_azimuth):
171
172
  Parameters
172
173
  ----------
173
174
  surface_tilt : numeric
174
- Panel tilt from horizontal.
175
+ Panel tilt from horizontal. See :term:`surface_tilt`. [°]
176
+
175
177
  surface_azimuth : numeric
176
- Panel azimuth from north.
178
+ Panel azimuth. See :term:`surface_azimuth`. [°]
179
+
177
180
  solar_zenith : numeric
178
- Solar zenith angle.
181
+ Solar zenith angle. See :term:`solar_zenith`. [°]
182
+
179
183
  solar_azimuth : numeric
180
- Solar azimuth angle.
184
+ Solar azimuth angle. See :term:`solar_azimuth`. [°]
181
185
 
182
186
  Returns
183
187
  -------
184
188
  projection : numeric
185
189
  Dot product of panel normal and solar angle.
190
+ See :term:`aoi_projection`.
186
191
  """
187
192
 
188
193
  projection = (
@@ -211,18 +216,18 @@ def aoi(surface_tilt, surface_azimuth, solar_zenith, solar_azimuth):
211
216
  Parameters
212
217
  ----------
213
218
  surface_tilt : numeric
214
- Panel tilt from horizontal.
219
+ Panel tilt from horizontal. See :term:`surface_tilt`. [°]
215
220
  surface_azimuth : numeric
216
- Panel azimuth from north.
221
+ Panel azimuth. See :term:`surface_azimuth`. [°]
217
222
  solar_zenith : numeric
218
- Solar zenith angle.
223
+ Solar zenith angle. See :term:`solar_zenith`. [°]
219
224
  solar_azimuth : numeric
220
- Solar azimuth angle.
225
+ Solar azimuth angle. See :term:`solar_azimuth`. [°]
221
226
 
222
227
  Returns
223
228
  -------
224
229
  aoi : numeric
225
- Angle of incidence in degrees.
230
+ Angle of incidence, see :term:`aoi`. [°]
226
231
  """
227
232
 
228
233
  projection = aoi_projection(surface_tilt, surface_azimuth,
@@ -245,20 +250,20 @@ def beam_component(surface_tilt, surface_azimuth, solar_zenith, solar_azimuth,
245
250
  Parameters
246
251
  ----------
247
252
  surface_tilt : numeric
248
- Panel tilt from horizontal.
253
+ Panel tilt from horizontal. See :term:`surface_tilt`. [°]
249
254
  surface_azimuth : numeric
250
- Panel azimuth from north.
255
+ Panel azimuth. See :term:`surface_azimuth`. [°]
251
256
  solar_zenith : numeric
252
- Solar zenith angle.
257
+ Solar zenith angle. See :term:`solar_zenith`. [°]
253
258
  solar_azimuth : numeric
254
- Solar azimuth angle.
259
+ Solar azimuth angle. See :term:`solar_azimuth`. [°]
255
260
  dni : numeric
256
261
  Direct normal irradiance, see :term:`dni`. [Wm⁻²]
257
262
 
258
263
  Returns
259
264
  -------
260
265
  beam : numeric
261
- Beam component
266
+ Beam component. [Wm⁻²]
262
267
  """
263
268
  beam = dni * aoi_projection(surface_tilt, surface_azimuth,
264
269
  solar_zenith, solar_azimuth)
@@ -293,25 +298,27 @@ def get_total_irradiance(surface_tilt, surface_azimuth,
293
298
  Parameters
294
299
  ----------
295
300
  surface_tilt : numeric
296
- Panel tilt from horizontal. [degree]
301
+ Panel tilt from horizontal. See :term:`surface_tilt`. [°]
297
302
  surface_azimuth : numeric
298
- Panel azimuth from north. [degree]
303
+ Panel azimuth. See :term:`surface_azimuth`. [°]
299
304
  solar_zenith : numeric
300
- Solar zenith angle. [degree]
305
+ Solar zenith angle. See :term:`solar_zenith`. [°]
301
306
  solar_azimuth : numeric
302
- Solar azimuth angle. [degree]
307
+ Solar azimuth angle. See :term:`solar_azimuth`. [°]
303
308
  dni : numeric
304
- Direct Normal Irradiance. [W/m2]
309
+ Direct normal irradiance. See :term:`dni`. [Wm⁻²]
305
310
  ghi : numeric
306
- Global horizontal irradiance. [W/m2]
311
+ Global horizontal irradiance. See :term:`ghi`. [Wm⁻²]
307
312
  dhi : numeric
308
- Diffuse horizontal irradiance. [W/m2]
313
+ Diffuse horizontal irradiance. See :term:`dhi`. [Wm⁻²]
309
314
  dni_extra : numeric, optional
310
- Extraterrestrial direct normal irradiance. [W/m2]
315
+ Extraterrestrial direct normal irradiance. See :term:`dni_extra`.
316
+ [Wm⁻²]
311
317
  airmass : numeric, optional
312
- Relative airmass (not adjusted for pressure). [unitless]
318
+ Relative airmass, not adjusted for pressure.
319
+ See :term:`airmass_relative`. [unitless]
313
320
  albedo : numeric, default 0.25
314
- Ground surface albedo. [unitless]
321
+ Ground surface albedo. See :term:`albedo`. [unitless]
315
322
  surface_type : str, optional
316
323
  Surface type. See :py:func:`~pvlib.irradiance.get_ground_diffuse` for
317
324
  the list of accepted values.
@@ -326,7 +333,7 @@ def get_total_irradiance(surface_tilt, surface_azimuth,
326
333
  -------
327
334
  total_irrad : OrderedDict or DataFrame
328
335
  Contains keys/columns ``'poa_global', 'poa_direct', 'poa_diffuse',
329
- 'poa_sky_diffuse', 'poa_ground_diffuse'``.
336
+ 'poa_sky_diffuse', 'poa_ground_diffuse'``. [Wm⁻²]
330
337
 
331
338
  Notes
332
339
  -----
@@ -372,23 +379,25 @@ def get_sky_diffuse(surface_tilt, surface_azimuth,
372
379
  Parameters
373
380
  ----------
374
381
  surface_tilt : numeric
375
- Panel tilt from horizontal. [degree]
382
+ Panel tilt from horizontal. See :term:`surface_tilt`. [°]
376
383
  surface_azimuth : numeric
377
- Panel azimuth from north. [degree]
384
+ Panel azimuth. See :term:`surface_azimuth`. [°]
378
385
  solar_zenith : numeric
379
- Solar zenith angle. [degree]
386
+ Solar zenith angle. See :term:`solar_zenith`. [°]
380
387
  solar_azimuth : numeric
381
- Solar azimuth angle. [degree]
388
+ Solar azimuth angle. See :term:`solar_azimuth`. [°]
382
389
  dni : numeric
383
- Direct Normal Irradiance. [W/m2]
390
+ Direct normal irradiance. See :term:`dni`. [Wm⁻²]
384
391
  ghi : numeric
385
- Global horizontal irradiance. [W/m2]
392
+ Global horizontal irradiance. See :term:`ghi`. [Wm⁻²]
386
393
  dhi : numeric
387
- Diffuse horizontal irradiance. [W/m2]
394
+ Diffuse horizontal irradiance. See :term:`dhi`. [Wm⁻²]
388
395
  dni_extra : numeric, optional
389
- Extraterrestrial direct normal irradiance. [W/m2]
396
+ Extraterrestrial direct normal irradiance. See :term:`dni_extra`.
397
+ [Wm⁻²]
390
398
  airmass : numeric, optional
391
- Relative airmass (not adjusted for pressure). [unitless]
399
+ Relative airmass, not adjusted for pressure.
400
+ See :term:`airmass_relative`. [unitless]
392
401
  model : str, default 'isotropic'
393
402
  Irradiance model. Can be one of ``'isotropic'``, ``'klucher'``,
394
403
  ``'haydavies'``, ``'reindl'``, ``'king'``, ``'perez'``,
@@ -399,7 +408,7 @@ def get_sky_diffuse(surface_tilt, surface_azimuth,
399
408
  Returns
400
409
  -------
401
410
  poa_sky_diffuse : numeric
402
- Sky diffuse irradiance in the plane of array. [W/m2]
411
+ Sky diffuse irradiance in the plane of array. [Wm⁻²]
403
412
 
404
413
  Raises
405
414
  ------
@@ -469,36 +478,35 @@ def poa_components(aoi, dni, poa_sky_diffuse, poa_ground_diffuse):
469
478
  ----------
470
479
  aoi : numeric
471
480
  Angle of incidence of solar rays with respect to the module
472
- surface, from :func:`aoi`.
481
+ surface. See :term:`aoi`. [°]
473
482
 
474
483
  dni : numeric
475
- Direct normal irradiance (Wm⁻²), as measured from a TMY file or
476
- calculated with a clearsky model.
484
+ Direct normal irradiance, as measured from a TMY file or
485
+ calculated with a clearsky model. See :term:`dni`. [Wm⁻²]
477
486
 
478
487
  poa_sky_diffuse : numeric
479
- Diffuse irradiance (Wm⁻²) in the plane of the modules, as
480
- calculated by a diffuse irradiance translation function
488
+ Diffuse irradiance in the plane of the modules, as
489
+ calculated by a diffuse irradiance translation function. [Wm⁻²]
481
490
 
482
491
  poa_ground_diffuse : numeric
483
- Ground reflected irradiance (Wm⁻²) in the plane of the modules,
484
- as calculated by an albedo model (eg. :func:`grounddiffuse`)
492
+ Ground-reflected irradiance in the plane of the modules,
493
+ as calculated by an albedo model (eg. :func:`grounddiffuse`). [Wm⁻²]
485
494
 
486
495
  Returns
487
496
  -------
488
497
  irrads : OrderedDict or DataFrame
489
498
  Contains the following keys:
490
499
 
491
- * ``poa_global`` : Total in-plane irradiance (Wm⁻²)
492
- * ``poa_direct`` : Total in-plane beam irradiance (Wm⁻²)
493
- * ``poa_diffuse`` : Total in-plane diffuse irradiance (Wm⁻²)
494
- * ``poa_sky_diffuse`` : In-plane diffuse irradiance from sky (Wm⁻²)
495
- * ``poa_ground_diffuse`` : In-plane diffuse irradiance from ground
496
- (Wm⁻²)
500
+ * ``poa_global`` : Total in-plane irradiance. [Wm⁻²]
501
+ * ``poa_direct`` : Total in-plane beam irradiance. [Wm⁻²]
502
+ * ``poa_diffuse`` : Total in-plane diffuse irradiance. [Wm⁻²]
503
+ * ``poa_sky_diffuse`` : In-plane diffuse irradiance from sky. [Wm⁻²]
504
+ * ``poa_ground_diffuse`` : In-plane diffuse irradiance from ground.
505
+ [Wm⁻²]
497
506
 
498
507
  Notes
499
508
  ------
500
- Negative beam irradiation due to aoi :math:`> 90^{\circ}` or AOI
501
- :math:`< 0^{\circ}` is set to zero.
509
+ Negative beam irradiation due to AOI > 90° or AOI < 0° is set to zero.
502
510
  '''
503
511
 
504
512
  poa_direct = np.maximum(dni * np.cos(np.radians(aoi)), 0)
@@ -533,18 +541,17 @@ def get_ground_diffuse(surface_tilt, ghi, albedo=.25, surface_type=None):
533
541
  Parameters
534
542
  ----------
535
543
  surface_tilt : numeric
536
- Surface tilt angles in decimal degrees. Tilt must be >=0 and
537
- <=180. The tilt angle is defined as degrees from horizontal
538
- (e.g. surface facing up = 0, surface facing horizon = 90).
544
+ Panel tilt from horizontal. See :term:`surface_tilt`. [°]
539
545
 
540
546
  ghi : numeric
541
- Global horizontal irradiance. [Wm⁻²]
547
+ Global horizontal irradiance. See :term:`ghi`. [Wm⁻²]
542
548
 
543
549
  albedo : numeric, default 0.25
544
- Ground reflectance, typically 0.1-0.4 for surfaces on Earth
545
- (land), may increase over snow, ice, etc. May also be known as
550
+ Ground surface albedo., typically 0.1-0.4 for bare or vegetated ground,
551
+ may increase over snow, ice, etc. May also be known as
546
552
  the reflection coefficient. Must be >=0 and <=1. Will be
547
- overridden if ``surface_type`` is supplied.
553
+ overridden if ``surface_type`` is supplied. See :term:`albedo`.
554
+ [unitless]
548
555
 
549
556
  surface_type : string, optional
550
557
  If supplied, overrides ``albedo``. ``surface_type`` can be one of
@@ -606,17 +613,15 @@ def isotropic(surface_tilt, dhi):
606
613
  Parameters
607
614
  ----------
608
615
  surface_tilt : numeric
609
- Surface tilt angle in decimal degrees. Tilt must be >=0 and
610
- <=180. The tilt angle is defined as degrees from horizontal
611
- (e.g. surface facing up = 0, surface facing horizon = 90)
616
+ Panel tilt from horizontal. See :term:`surface_tilt`. [°]
612
617
 
613
618
  dhi : numeric
614
- Diffuse horizontal irradiance. [Wm⁻²] DHI must be >=0.
619
+ Diffuse horizontal irradiance, must be >=0. See :term:`dhi`.
615
620
 
616
621
  Returns
617
622
  -------
618
623
  diffuse : numeric
619
- The sky diffuse component of the solar radiation.
624
+ The sky diffuse component of the solar radiation. [Wm⁻²]
620
625
 
621
626
  References
622
627
  ----------
@@ -644,29 +649,22 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith,
644
649
  Parameters
645
650
  ----------
646
651
  surface_tilt : numeric
647
- Surface tilt angles in decimal degrees. ``surface_tilt`` must be >=0
648
- and <=180. The tilt angle is defined as degrees from horizontal
649
- (e.g. surface facing up = 0, surface facing horizon = 90)
652
+ Panel tilt from horizontal. See :term:`surface_tilt`. [°]
650
653
 
651
654
  surface_azimuth : numeric
652
- Surface azimuth angles in decimal degrees. ``surface_azimuth`` must
653
- be >=0 and <=360. The Azimuth convention is defined as degrees
654
- east of north (e.g. North = 0, South=180 East = 90, West = 270).
655
+ Panel azimuth. See :term:`surface_azimuth`. [°]
655
656
 
656
657
  dhi : numeric
657
- Diffuse horizontal irradiance, must be >=0. [Wm⁻²]
658
+ Diffuse horizontal irradiance, must be >=0. See :term:`dhi`. [Wm⁻²]
658
659
 
659
660
  ghi : numeric
660
- Global horizontal irradiance, must be >=0. [Wm⁻²]
661
+ Global horizontal irradiance, must be >=0. See :term:`ghi`. [Wm⁻²]
661
662
 
662
663
  solar_zenith : numeric
663
- Apparent (refraction-corrected) zenith angles in decimal
664
- degrees. ``solar_zenith`` must be >=0 and <=180.
664
+ Apparent (refraction-corrected) zenith angles. [°]
665
665
 
666
666
  solar_azimuth : numeric
667
- Sun azimuth angles in decimal degrees. ``solar_azimuth`` must be >=0
668
- and <=360. The Azimuth convention is defined as degrees east of
669
- north (e.g. North = 0, East = 90, West = 270).
667
+ Sun azimuth angles. See :term:`solar_azimuth`. [°]
670
668
 
671
669
  Returns
672
670
  -------
@@ -749,32 +747,29 @@ def haydavies(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
749
747
  Parameters
750
748
  ----------
751
749
  surface_tilt : numeric
752
- Panel tilt from the horizontal, in decimal degrees, see
753
- :term:`surface_tilt`.
750
+ Panel tilt from the horizontal. See :term:`surface_tilt`. [°]
754
751
 
755
752
  surface_azimuth : numeric
756
- Surface azimuth angles in decimal degrees. The azimuth
757
- convention is defined as degrees east of north (e.g. North=0,
758
- South=180, East=90, West=270).
753
+ Panel azimuth. See :term:`surface_azimuth`. [°]
759
754
 
760
755
  dhi : numeric
761
- Diffuse horizontal irradiance. [Wm⁻²]
756
+ Diffuse horizontal irradiance, see :term:`dhi`. [Wm⁻²]
762
757
 
763
758
  dni : numeric
764
759
  Direct normal irradiance, see :term:`dni`. [Wm⁻²]
765
760
 
766
761
  dni_extra : numeric
767
- Extraterrestrial normal irradiance. [Wm⁻²]
762
+ Extraterrestrial normal irradiance, see :term:`dni_extra`. [Wm⁻²]
768
763
 
769
764
  solar_zenith : numeric, optional
770
- Solar apparent (refraction-corrected) zenith angles in decimal
771
- degrees. Must supply ``solar_zenith`` and ``solar_azimuth`` or
772
- supply ``projection_ratio``.
765
+ Solar apparent (refraction-corrected) zenith angles. Must supply
766
+ ``solar_zenith`` and ``solar_azimuth``, or supply
767
+ ``projection_ratio``. [°]
773
768
 
774
769
  solar_azimuth : numeric, optional
775
- Solar azimuth angles in decimal degrees. Must supply
776
- ``solar_zenith`` and ``solar_azimuth`` or supply
777
- ``projection_ratio``.
770
+ Solar azimuth angles. Must supply ``solar_zenith`` and
771
+ ``solar_azimuth``, or supply ``projection_ratio``. See
772
+ :term:`solar_azimuth`. [°]
778
773
 
779
774
  projection_ratio : numeric, optional
780
775
  Ratio of angle of incidence projection to solar zenith angle
@@ -794,7 +789,7 @@ def haydavies(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
794
789
 
795
790
  sky_diffuse : numeric
796
791
  The sky diffuse component of the solar radiation on a tilted
797
- surface.
792
+ surface. [Wm⁻²]
798
793
 
799
794
  diffuse_components : OrderedDict (array input) or DataFrame (Series input)
800
795
  Keys/columns are:
@@ -891,39 +886,34 @@ def reindl(surface_tilt, surface_azimuth, dhi, dni, ghi, dni_extra,
891
886
  Parameters
892
887
  ----------
893
888
  surface_tilt : numeric
894
- Surface tilt angles in decimal degrees. The tilt angle is
895
- defined as degrees from horizontal (e.g. surface facing up = 0,
896
- surface facing horizon = 90)
889
+ Panel tilt from the horizontal. See :term:`surface_tilt`. [°]
897
890
 
898
891
  surface_azimuth : numeric
899
- Surface azimuth angles in decimal degrees. The azimuth
900
- convention is defined as degrees east of north (e.g. North = 0,
901
- South=180 East = 90, West = 270).
892
+ Panel azimuth. See :term:`surface_azimuth`. [°]
902
893
 
903
894
  dhi : numeric
904
- diffuse horizontal irradiance. [Wm⁻²]
895
+ Diffuse horizontal irradiance, see :term:`dhi`. [Wm⁻²]
905
896
 
906
897
  dni : numeric
907
- direct normal irradiance. [Wm⁻²]
898
+ Direct normal irradiance, see :term:`dni`. [Wm⁻²]
908
899
 
909
- ghi: numeric
910
- Global horizontal irradiance. [Wm⁻²]
900
+ ghi : numeric
901
+ Global horizontal irradiance, see :term:`ghi`. [Wm⁻²]
911
902
 
912
903
  dni_extra : numeric
913
- Extraterrestrial normal irradiance. [Wm⁻²]
904
+ Extraterrestrial normal irradiance, see :term:`dni_extra`. [Wm⁻²]
914
905
 
915
906
  solar_zenith : numeric
916
- Apparent (refraction-corrected) zenith angles in decimal degrees.
907
+ Solar apparent (refraction-corrected) zenith angles
908
+ See :term:`solar_zenith`. [°]
917
909
 
918
910
  solar_azimuth : numeric
919
- Sun azimuth angles in decimal degrees. The azimuth convention is
920
- defined as degrees east of north (e.g. North = 0, East = 90,
921
- West = 270).
911
+ Solar azimuth angles. See :term:`solar_azimuth`. [°]
922
912
 
923
913
  Returns
924
914
  -------
925
915
  poa_sky_diffuse : numeric
926
- The sky diffuse component of the solar radiation.
916
+ The sky diffuse component of the solar radiation. [Wm⁻²]
927
917
 
928
918
  Notes
929
919
  -----
@@ -1008,18 +998,16 @@ def king(surface_tilt, dhi, ghi, solar_zenith):
1008
998
  Parameters
1009
999
  ----------
1010
1000
  surface_tilt : numeric
1011
- Surface tilt angles in decimal degrees. The tilt angle is
1012
- defined as degrees from horizontal (e.g. surface facing up = 0,
1013
- surface facing horizon = 90)
1001
+ Panel tilt from the horizontal. See :term:`surface_tilt`. [°]
1014
1002
 
1015
1003
  dhi : numeric
1016
- Diffuse horizontal irradiance. [Wm⁻²]
1004
+ Diffuse horizontal irradiance. See :term:`dhi`. [Wm⁻²]
1017
1005
 
1018
1006
  ghi : numeric
1019
- Global horizontal irradiance. [Wm⁻²]
1007
+ Global horizontal irradiance. See :term:`ghi`. [Wm⁻²]
1020
1008
 
1021
1009
  solar_zenith : numeric
1022
- Apparent (refraction-corrected) zenith angles in decimal degrees.
1010
+ Solar apparent (refraction-corrected) zenith angles. [°]
1023
1011
 
1024
1012
  Returns
1025
1013
  --------
@@ -1060,38 +1048,33 @@ def perez(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
1060
1048
  Parameters
1061
1049
  ----------
1062
1050
  surface_tilt : numeric
1063
- Surface tilt angles in decimal degrees. surface_tilt must be >=0
1064
- and <=180. The tilt angle is defined as degrees from horizontal
1065
- (e.g. surface facing up = 0, surface facing horizon = 90)
1051
+ Surface tilt angle. See :term:`surface_tilt`.
1052
+ [°]
1066
1053
 
1067
1054
  surface_azimuth : numeric
1068
- Surface azimuth angles in decimal degrees. surface_azimuth must
1069
- be >=0 and <=360. The azimuth convention is defined as degrees
1070
- east of north (e.g. North = 0, South=180 East = 90, West = 270).
1055
+ Surface azimuth angle. See :term:`surface_azimuth`. [°]
1071
1056
 
1072
1057
  dhi : numeric
1073
- Diffuse horizontal irradiance. [Wm⁻²] DHI must be >=0.
1058
+ Diffuse horizontal irradiance, must be >=0. [Wm⁻²]
1074
1059
 
1075
1060
  dni : numeric
1076
- Direct normal irradiance. [Wm⁻²] DNI must be >=0.
1061
+ Direct normal irradiance, must be >=0. [Wm⁻²]
1062
+
1077
1063
 
1078
1064
  dni_extra : numeric
1079
1065
  Extraterrestrial normal irradiance. [Wm⁻²]
1080
1066
 
1081
1067
  solar_zenith : numeric
1082
- apparent (refraction-corrected) zenith angles in decimal
1083
- degrees. solar_zenith must be >=0 and <=180.
1068
+ apparent (refraction-corrected) zenith angle. [°]
1084
1069
 
1085
1070
  solar_azimuth : numeric
1086
- Sun azimuth angles in decimal degrees. solar_azimuth must be >=0
1087
- and <=360. The azimuth convention is defined as degrees east of
1088
- north (e.g. North = 0, East = 90, West = 270).
1071
+ Solar azimuth angle. See :term:`solar_azimuth`. [°]
1089
1072
 
1090
1073
  airmass : numeric
1091
1074
  Relative (not pressure-corrected) airmass values. If AM is a
1092
1075
  DataFrame it must be of the same size as all other DataFrame
1093
1076
  inputs. AM must be >=0 (careful using the 1/sec(z) model of AM
1094
- generation)
1077
+ generation). [unitless]
1095
1078
 
1096
1079
  model : string, default 'allsitescomposite1990'
1097
1080
  A string which selects the desired set of Perez coefficients. If
@@ -1326,39 +1309,32 @@ def perez_driesse(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
1326
1309
  Parameters
1327
1310
  ----------
1328
1311
  surface_tilt : numeric
1329
- Surface tilt angles in decimal degrees. surface_tilt must be >=0
1330
- and <=180. The tilt angle is defined as degrees from horizontal
1331
- (e.g. surface facing up = 0, surface facing horizon = 90)
1312
+ Surface tilt angle. See :term:`surface_tilt`. [°]
1332
1313
 
1333
1314
  surface_azimuth : numeric
1334
- Surface azimuth angles in decimal degrees. surface_azimuth must
1335
- be >=0 and <=360. The azimuth convention is defined as degrees
1336
- east of north (e.g. North = 0, South=180 East = 90, West = 270).
1315
+ Surface azimuth angle. See :term:`surface_azimuth`. [°]
1337
1316
 
1338
1317
  dhi : numeric
1339
- Diffuse horizontal irradiance. [Wm⁻²] dhi must be >=0.
1318
+ Diffuse horizontal irradiance, must be >=0. [Wm⁻²]
1340
1319
 
1341
1320
  dni : numeric
1342
- Direct normal irradiance. [Wm⁻²] dni must be >=0.
1321
+ Direct normal irradiance, must be >=0. [Wm⁻²]
1322
+
1343
1323
 
1344
1324
  dni_extra : numeric
1345
1325
  Extraterrestrial normal irradiance. [Wm⁻²]
1346
1326
 
1347
1327
  solar_zenith : numeric
1348
- apparent (refraction-corrected) zenith angles in decimal
1349
- degrees. solar_zenith must be >=0 and <=180.
1328
+ apparent (refraction-corrected) zenith angle. [°]
1350
1329
 
1351
1330
  solar_azimuth : numeric
1352
- Sun azimuth angles in decimal degrees. solar_azimuth must be >=0
1353
- and <=360. The azimuth convention is defined as degrees east of
1354
- north (e.g. North = 0, East = 90, West = 270).
1331
+ Solar azimuth angle. See :term:`solar_azimuth`. [°]
1355
1332
 
1356
1333
  airmass : numeric, optional
1357
1334
  Relative (not pressure-corrected) airmass values. If ``airmass`` is a
1358
1335
  DataFrame it must be of the same size as all other DataFrame
1359
- inputs. The kastenyoung1989 airmass calculation is used internally
1360
- and is also recommended when pre-calculating airmass because
1361
- it was used in the original model development.
1336
+ inputs. AM must be >=0 (careful using the 1/sec(z) model of AM
1337
+ generation). [unitless]
1362
1338
 
1363
1339
  return_components: bool (optional, default=False)
1364
1340
  Flag used to decide whether to return the calculated diffuse components
@@ -1549,32 +1525,45 @@ def ghi_from_poa_driesse_2023(surface_tilt, surface_azimuth,
1549
1525
  Parameters
1550
1526
  ----------
1551
1527
  surface_tilt : numeric
1552
- Panel tilt from horizontal. [degree]
1528
+ Panel tilt from horizontal. See :term:`surface_tilt`. [°]
1529
+
1553
1530
  surface_azimuth : numeric
1554
- Panel azimuth from north. [degree]
1531
+ Panel azimuth. See :term:`surface_azimuth`. [°]
1532
+
1555
1533
  solar_zenith : numeric
1556
- Solar zenith angle. [degree]
1534
+ Solar zenith angle. See :term:`solar_zenith`. [°]
1535
+
1557
1536
  solar_azimuth : numeric
1558
- Solar azimuth angle. [degree]
1537
+ Solar azimuth angle. See :term:`solar_azimuth`. [°]
1538
+
1559
1539
  poa_global : numeric
1560
- Plane-of-array global irradiance, aka global tilted irradiance. [Wm⁻²]
1540
+ Plane-of-array global irradiance, aka global tilted irradiance.
1541
+ See :term:`poa_global`. [Wm⁻²]
1542
+
1561
1543
  dni_extra : numeric
1562
- Extraterrestrial direct normal irradiance. [Wm⁻²]
1544
+ Extraterrestrial direct normal irradiance. See :Term:`dni_extra`.
1545
+ [Wm⁻²]
1546
+
1563
1547
  airmass : numeric, optional
1564
- Relative airmass (not adjusted for pressure). [unitless]
1548
+ Relative airmass (not adjusted for pressure). See
1549
+ :term:`airmass_relative`. [unitless]
1550
+
1565
1551
  albedo : numeric, default 0.25
1566
- Ground surface albedo. [unitless]
1552
+ Ground surface albedo. See :term:`albedo`. [unitless]
1553
+
1567
1554
  xtol : numeric, default 0.01
1568
- Convergence criterion. The estimated GHI will be within xtol of the
1555
+ Convergence criterion. The estimated GHI will be within ``xtol`` of the
1569
1556
  true value. Must be positive. [Wm⁻²]
1557
+
1570
1558
  full_output : boolean, default False
1571
- If full_output is False, only ghi is returned, otherwise the return
1572
- value is (ghi, converged, niter). (see Returns section for details).
1559
+ If full_output is False, only ``ghi`` is returned, otherwise the return
1560
+ value is (``ghi``, ``converged``, ``niter``).
1561
+ (see Returns section for details).
1573
1562
 
1574
1563
  Returns
1575
1564
  -------
1576
1565
  ghi : numeric
1577
- Estimated GHI. [Wm⁻²]
1566
+ Estimated global horizontal irradiance. See :term:`ghi`. [Wm⁻²]
1578
1567
  converged : boolean, optional
1579
1568
  Present if full_output=True. Indicates which elements converged
1580
1569
  successfully.
@@ -1638,10 +1627,10 @@ def clearsky_index(ghi, ghi_clear, max_clearsky_index=2.0):
1638
1627
  Parameters
1639
1628
  ----------
1640
1629
  ghi : numeric
1641
- Global horizontal irradiance. [Wm⁻²]
1630
+ Global horizontal irradiance. See :term:`ghi`. [Wm⁻²]
1642
1631
 
1643
1632
  ghi_clear : numeric
1644
- Modeled clearsky GHI
1633
+ Modeled clearsky GHI. See :term:`ghi_clear`. [Wm⁻²]
1645
1634
 
1646
1635
  .. versionchanged:: 0.11.2
1647
1636
  Renamed from ``ghi_clearsky`` to ``ghi_clear``.
@@ -1653,7 +1642,7 @@ def clearsky_index(ghi, ghi_clear, max_clearsky_index=2.0):
1653
1642
  Returns
1654
1643
  -------
1655
1644
  clearsky_index : numeric
1656
- Clearsky index
1645
+ Clearsky index. [unitless]
1657
1646
  """
1658
1647
  clearsky_index = ghi / ghi_clear
1659
1648
  # set +inf, -inf, and nans to zero
@@ -1684,28 +1673,28 @@ def clearness_index(ghi, solar_zenith, extra_radiation, min_cos_zenith=0.065,
1684
1673
  Parameters
1685
1674
  ----------
1686
1675
  ghi : numeric
1687
- Global horizontal irradiance. [Wm⁻²]
1676
+ Global horizontal irradiance. See :term:`ghi`. [Wm⁻²]
1688
1677
 
1689
1678
  solar_zenith : numeric
1690
- True (not refraction-corrected) solar zenith angle in decimal
1691
- degrees.
1679
+ True (not refraction-corrected) solar zenith angle.
1680
+ See :term:`solar_zenith`. [°]
1692
1681
 
1693
1682
  extra_radiation : numeric
1694
- Irradiance incident at the top of the atmosphere
1683
+ Irradiance incident at the top of the atmosphere. See
1684
+ :term:`dni_extra`. [Wm⁻²]
1695
1685
 
1696
1686
  min_cos_zenith : numeric, default 0.065
1697
1687
  Minimum value of cos(zenith) to allow when calculating global
1698
- clearness index `kt`. Equivalent to zenith = 86.273 degrees.
1688
+ clearness index ``kt``. Equivalent to zenith = 86.273°.
1699
1689
 
1700
1690
  max_clearness_index : numeric, default 2.0
1701
1691
  Maximum value of the clearness index. The default, 2.0, allows
1702
1692
  for over-irradiance events typically seen in sub-hourly data.
1703
- NREL's SRRL Fortran code used 0.82 for hourly data.
1704
1693
 
1705
1694
  Returns
1706
1695
  -------
1707
1696
  kt : numeric
1708
- Clearness index
1697
+ Clearness index. [unitless]
1709
1698
 
1710
1699
  References
1711
1700
  ----------
@@ -1737,10 +1726,10 @@ def clearness_index_zenith_independent(clearness_index, airmass,
1737
1726
  ----------
1738
1727
  clearness_index : numeric
1739
1728
  Ratio of global to extraterrestrial irradiance on a horizontal
1740
- plane
1729
+ plane. [unitless]
1741
1730
 
1742
1731
  airmass : numeric
1743
- Airmass
1732
+ Airmass. See :term:`airmass_relative`. [unitless]
1744
1733
 
1745
1734
  max_clearness_index : numeric, default 2.0
1746
1735
  Maximum value of the clearness index. The default, 2.0, allows
@@ -1750,7 +1739,7 @@ def clearness_index_zenith_independent(clearness_index, airmass,
1750
1739
  Returns
1751
1740
  -------
1752
1741
  kt_prime : numeric
1753
- Zenith independent clearness index
1742
+ Zenith-independent clearness index. [unitless]
1754
1743
 
1755
1744
  References
1756
1745
  ----------
@@ -1797,32 +1786,31 @@ def disc(ghi, solar_zenith, datetime_or_doy, pressure=101325,
1797
1786
  Parameters
1798
1787
  ----------
1799
1788
  ghi : numeric
1800
- Global horizontal irradiance. [Wm⁻²]
1789
+ Global horizontal irradiance. See :term:`ghi`. [Wm⁻²]
1801
1790
 
1802
1791
  solar_zenith : numeric
1803
- True (not refraction-corrected) solar zenith angles in decimal
1804
- degrees.
1792
+ True (not refraction-corrected) solar zenith angles. See
1793
+ :term:`solar_zenith`. [°]
1805
1794
 
1806
1795
  datetime_or_doy : int, float, array, pd.DatetimeIndex
1807
1796
  Day of year or array of days of year e.g.
1808
1797
  pd.DatetimeIndex.dayofyear, or pd.DatetimeIndex.
1809
1798
 
1810
1799
  pressure : numeric or None, default 101325
1811
- Site pressure in Pascal. Uses absolute (pressure-corrected) airmass
1812
- by default. Set to ``None`` to use relative airmass.
1800
+ Site pressure. See :term:`pressure`. [Pa]
1813
1801
 
1814
1802
  min_cos_zenith : numeric, default 0.065
1815
1803
  Minimum value of cos(zenith) to allow when calculating global
1816
- clearness index `kt`. Equivalent to zenith = 86.273 degrees.
1804
+ clearness index :math:`k_t`. Equivalent to zenith = 86.273°.
1817
1805
 
1818
1806
  max_zenith : numeric, default 87
1819
1807
  Maximum value of zenith to allow in DNI calculation. DNI will be
1820
- set to 0 for times with zenith values greater than `max_zenith`.
1808
+ set to 0 for times with zenith values greater than `max_zenith`. [°]
1821
1809
 
1822
1810
  max_airmass : numeric, default 12
1823
1811
  Maximum value of the airmass to allow in Kn calculation.
1824
1812
  Default value (12) comes from range over which Kn was fit
1825
- to airmass in the original paper.
1813
+ to airmass in the original paper. [unitless]
1826
1814
 
1827
1815
  Returns
1828
1816
  -------
@@ -1830,11 +1818,11 @@ def disc(ghi, solar_zenith, datetime_or_doy, pressure=101325,
1830
1818
  Contains the following keys:
1831
1819
 
1832
1820
  * ``dni``: The modeled direct normal irradiance
1833
- in Wm⁻² provided by the
1834
- Direct Insolation Simulation Code (DISC) model.
1821
+ provided by the Direct Insolation Simulation Code (DISC) model.
1822
+ [Wm⁻²]
1835
1823
  * ``kt``: Ratio of global to extraterrestrial
1836
- irradiance on a horizontal plane.
1837
- * ``airmass``: Airmass
1824
+ irradiance on a horizontal plane. [unitless]
1825
+ * ``airmass``: Airmass. [unitless]
1838
1826
 
1839
1827
  References
1840
1828
  ----------
@@ -1943,17 +1931,16 @@ def dirint(ghi, solar_zenith, times, pressure=101325., use_delta_kt_prime=True,
1943
1931
  Parameters
1944
1932
  ----------
1945
1933
  ghi : array-like
1946
- Global horizontal irradiance. [Wm⁻²]
1934
+ Global horizontal irradiance. See :term:`ghi`. [Wm⁻²]
1947
1935
 
1948
1936
  solar_zenith : array-like
1949
- True (not refraction-corrected) solar_zenith angles in decimal
1950
- degrees.
1937
+ True (not refraction-corrected) solar zenith angles. See
1938
+ :term:`solar_zenith`. [°]
1951
1939
 
1952
1940
  times : DatetimeIndex
1953
1941
 
1954
1942
  pressure : float or array-like, default 101325.0
1955
- The site pressure in Pascal. Pressure may be measured or an
1956
- average pressure may be calculated from site altitude.
1943
+ Air pressure. See :term:`pressure`. [Pa]
1957
1944
 
1958
1945
  use_delta_kt_prime : bool, default True
1959
1946
  If True, indicates that the stability index delta_kt_prime is
@@ -1964,25 +1951,25 @@ def dirint(ghi, solar_zenith, times, pressure=101325., use_delta_kt_prime=True,
1964
1951
  input data must be Series.
1965
1952
 
1966
1953
  temp_dew : float, or array-like, optional
1967
- Surface dew point temperatures, in degrees C. Values of temp_dew
1954
+ Surface dew point temperatures, in. Values of ``temp_dew``
1968
1955
  may be numeric or NaN. Any single time period point with a
1969
1956
  temp_dew=NaN does not have dew point improvements applied. If
1970
- temp_dew is not provided, then dew point improvements are not
1971
- applied.
1957
+ ``temp_dew`` is not provided, then dew point improvements are not
1958
+ applied. See :term:`temp_dew`. [°C]
1972
1959
 
1973
1960
  min_cos_zenith : numeric, default 0.065
1974
1961
  Minimum value of cos(zenith) to allow when calculating global
1975
- clearness index `kt`. Equivalent to zenith = 86.273 degrees.
1962
+ clearness index Kt. Equivalent to zenith = 86.273°. [°]
1976
1963
 
1977
1964
  max_zenith : numeric, default 87
1978
1965
  Maximum value of zenith to allow in DNI calculation. DNI will be
1979
- set to 0 for times with zenith values greater than `max_zenith`.
1966
+ set to 0 for times with zenith values greater than ``max_zenith``. [°]
1980
1967
 
1981
1968
  Returns
1982
1969
  -------
1983
1970
  dni : array-like
1984
- The modeled direct normal irradiance in Wm⁻² provided by the
1985
- DIRINT model.
1971
+ The modeled direct normal irradiance, as provided by the
1972
+ DIRINT model. [Wm⁻²]
1986
1973
 
1987
1974
  Notes
1988
1975
  -----
@@ -2082,9 +2069,9 @@ def _dirint_coeffs(times, kt_prime, solar_zenith, w, delta_kt_prime):
2082
2069
  Parameters
2083
2070
  ----------
2084
2071
  times : pd.DatetimeIndex
2085
- kt_prime : Zenith-independent clearness index
2086
- solar_zenith : Solar zenith angle
2087
- w : precipitable water estimated from surface dew-point temperature
2072
+ kt_prime : Zenith-independent clearness index. [unitless]
2073
+ solar_zenith : Solar zenith angle. [°]
2074
+ w : precipitable water estimated from surface dew-point temperature. [cm]
2088
2075
  delta_kt_prime : stability index
2089
2076
 
2090
2077
  Returns
@@ -2195,30 +2182,31 @@ def dirindex(ghi, ghi_clear, dni_clear, zenith, times, pressure=101325.,
2195
2182
  Parameters
2196
2183
  ----------
2197
2184
  ghi : array-like
2198
- Global horizontal irradiance. [Wm⁻²]
2185
+ Global horizontal irradiance. See :term:`ghi`. [Wm⁻²]
2199
2186
 
2200
2187
  ghi_clear : array-like
2201
- Global horizontal irradiance from clear sky model. [Wm⁻²]
2188
+ Global horizontal irradiance from clear sky model. See
2189
+ :term:`ghi_clear`. [Wm⁻²]
2202
2190
 
2203
2191
  .. versionchanged:: 0.11.2
2204
2192
  Renamed from ``ghi_clearsky`` to ``ghi_clear``.
2205
2193
 
2206
2194
  dni_clear : array-like
2207
- Direct normal irradiance from clear sky model. [Wm⁻²]
2195
+ Direct normal irradiance from clear sky model. See
2196
+ :term:`dni_clear`. [Wm⁻²]
2208
2197
 
2209
2198
  .. versionchanged:: 0.11.2
2210
2199
  Renamed from ``dni_clearsky`` to ``dni_clear``.
2211
2200
 
2212
2201
  zenith : array-like
2213
- True (not refraction-corrected) zenith angles in decimal
2214
- degrees. If Z is a vector it must be of the same size as all
2215
- other vector inputs. Z must be >=0 and <=180.
2202
+ True (not refraction-corrected) zenith angles.
2203
+ If ``zenith`` is a vector, it must be of the same size as all other
2204
+ vector inputs. See :term`solar_zenith`. [°]
2216
2205
 
2217
2206
  times : DatetimeIndex
2218
2207
 
2219
2208
  pressure : float or array-like, default 101325.0
2220
- The site pressure in Pascal. Pressure may be measured or an
2221
- average pressure may be calculated from site altitude.
2209
+ Air pressure. See :term:`pressure`. [Pa]
2222
2210
 
2223
2211
  use_delta_kt_prime : bool, default True
2224
2212
  If True, indicates that the stability index delta_kt_prime is
@@ -2246,7 +2234,7 @@ def dirindex(ghi, ghi_clear, dni_clear, zenith, times, pressure=101325.,
2246
2234
  Returns
2247
2235
  -------
2248
2236
  dni : array-like
2249
- The modeled direct normal irradiance. [Wm⁻²]
2237
+ The modeled direct normal irradiance. See :term:`dni`. [Wm⁻²]
2250
2238
 
2251
2239
  Notes
2252
2240
  -----
@@ -2298,35 +2286,30 @@ def gti_dirint(poa_global, aoi, solar_zenith, solar_azimuth, times,
2298
2286
  Parameters
2299
2287
  ----------
2300
2288
  poa_global : array-like
2301
- Plane of array global irradiance. [Wm⁻²]
2289
+ Plane of array global irradiance. See :term:`poa_global`. [Wm⁻²]
2302
2290
 
2303
2291
  aoi : array-like
2304
2292
  Angle of incidence of solar rays with respect to the module
2305
- surface normal.
2293
+ surface normal. See :term:`aoi`. [°]
2306
2294
 
2307
2295
  solar_zenith : array-like
2308
2296
  True (not refraction-corrected) solar zenith angles in decimal
2309
- degrees.
2297
+ degrees. See :term:`solar_zenith`. [°]
2310
2298
 
2311
2299
  solar_azimuth : array-like
2312
- Solar azimuth angles in decimal degrees.
2300
+ Solar azimuth angles. See :term:`solar_azimuth`. [°]
2313
2301
 
2314
2302
  times : DatetimeIndex
2315
2303
  Time indices for the input array-like data.
2316
2304
 
2317
2305
  surface_tilt : numeric
2318
- Surface tilt angles in decimal degrees. Tilt must be >=0 and
2319
- <=180. The tilt angle is defined as degrees from horizontal
2320
- (e.g. surface facing up = 0, surface facing horizon = 90).
2306
+ Surface tilt angle, see :term:`surface_tilt`. [°]
2321
2307
 
2322
2308
  surface_azimuth : numeric
2323
- Surface azimuth angles in decimal degrees. surface_azimuth must
2324
- be >=0 and <=360. The Azimuth convention is defined as degrees
2325
- east of north (e.g. North = 0, South=180 East = 90, West = 270).
2309
+ Surface azimuth angles, see :term:`surface_azimuth`. [°]
2326
2310
 
2327
2311
  pressure : numeric, default 101325.0
2328
- The site pressure in Pascal. Pressure may be measured or an
2329
- average pressure may be calculated from site altitude.
2312
+ Site air pressure. See :term:`pressure`. [Pa]
2330
2313
 
2331
2314
  use_delta_kt_prime : bool, default True
2332
2315
  If True, indicates that the stability index delta_kt_prime is
@@ -2337,14 +2320,14 @@ def gti_dirint(poa_global, aoi, solar_zenith, solar_azimuth, times,
2337
2320
  input data must be Series.
2338
2321
 
2339
2322
  temp_dew : float, or array-like, optional
2340
- Surface dew point temperatures, in degrees C. Values of temp_dew
2323
+ Surface dew point temperature. Values of ``temp_dew``
2341
2324
  may be numeric or NaN. Any single time period point with a
2342
2325
  temp_dew=NaN does not have dew point improvements applied. If
2343
2326
  temp_dew is not provided, then dew point improvements are not
2344
- applied.
2327
+ applied. See :term:`temp_dew`. [°C]
2345
2328
 
2346
2329
  albedo : numeric, default 0.25
2347
- Ground surface albedo. [unitless]
2330
+ Ground surface albedo. See :term:`albedo`. [unitless]
2348
2331
 
2349
2332
  model : String, default 'perez'
2350
2333
  Irradiance model. See :py:func:`get_sky_diffuse` for allowed values.
@@ -2367,8 +2350,7 @@ def gti_dirint(poa_global, aoi, solar_zenith, solar_azimuth, times,
2367
2350
 
2368
2351
  * ``ghi``: the modeled global horizontal irradiance. [Wm⁻²]
2369
2352
  * ``dni``: the modeled direct normal irradiance. [Wm⁻²]
2370
- * ``dhi``: the modeled diffuse horizontal irradiance in
2371
- Wm⁻².
2353
+ * ``dhi``: the modeled diffuse horizontal irradiance. [Wm⁻²]
2372
2354
 
2373
2355
  References
2374
2356
  ----------
@@ -2644,18 +2626,19 @@ def erbs(ghi, zenith, datetime_or_doy, min_cos_zenith=0.065, max_zenith=87):
2644
2626
  Parameters
2645
2627
  ----------
2646
2628
  ghi: numeric
2647
- Global horizontal irradiance. [Wm⁻²]
2629
+ Global horizontal irradiance. See :term:`ghi`. [Wm⁻²]
2648
2630
  zenith: numeric
2649
- True (not refraction-corrected) zenith angles in decimal degrees.
2631
+ True (not refraction-corrected) zenith angles. See
2632
+ :term:`solar_zenith`. [°]
2650
2633
  datetime_or_doy : int, float, array, pd.DatetimeIndex
2651
2634
  Day of year or array of days of year e.g.
2652
2635
  pd.DatetimeIndex.dayofyear, or pd.DatetimeIndex.
2653
2636
  min_cos_zenith : numeric, default 0.065
2654
2637
  Minimum value of cos(zenith) to allow when calculating global
2655
- clearness index `kt`. Equivalent to zenith = 86.273 degrees.
2638
+ clearness index `kt`. Equivalent to zenith = 86.273°.
2656
2639
  max_zenith : numeric, default 87
2657
2640
  Maximum value of zenith to allow in DNI calculation. DNI will be
2658
- set to 0 for times with zenith values greater than `max_zenith`.
2641
+ set to 0 for times with zenith values greater than ``max_zenith``. [°]
2659
2642
 
2660
2643
  Returns
2661
2644
  -------
@@ -2663,10 +2646,9 @@ def erbs(ghi, zenith, datetime_or_doy, min_cos_zenith=0.065, max_zenith=87):
2663
2646
  Contains the following keys/columns:
2664
2647
 
2665
2648
  * ``dni``: the modeled direct normal irradiance. [Wm⁻²]
2666
- * ``dhi``: the modeled diffuse horizontal irradiance in
2667
- Wm⁻².
2649
+ * ``dhi``: the modeled diffuse horizontal irradiance [Wm⁻²].
2668
2650
  * ``kt``: Ratio of global to extraterrestrial irradiance
2669
- on a horizontal plane.
2651
+ on a horizontal plane. [unitless]
2670
2652
 
2671
2653
  References
2672
2654
  ----------
@@ -2742,23 +2724,30 @@ def erbs_driesse(ghi, zenith, datetime_or_doy=None, dni_extra=None,
2742
2724
  Parameters
2743
2725
  ----------
2744
2726
  ghi: numeric
2745
- Global horizontal irradiance. [Wm⁻²]
2727
+ Global horizontal irradiance. See :term:`ghi`. [Wm⁻²]
2728
+
2746
2729
  zenith: numeric
2747
- True (not refraction-corrected) zenith angles in decimal degrees.
2730
+ True (not refraction-corrected) zenith angles. See
2731
+ :term:`solar_zenith`. [°]
2732
+
2748
2733
  datetime_or_doy : int, float, array or pd.DatetimeIndex, optional
2749
2734
  Day of year or array of days of year e.g.
2750
2735
  pd.DatetimeIndex.dayofyear, or pd.DatetimeIndex.
2751
- Either datetime_or_doy or dni_extra must be provided.
2736
+ Either ``datetime_or_doy`` or ``dni_extra`` must be provided.
2737
+
2752
2738
  dni_extra : numeric, optional
2753
2739
  Extraterrestrial normal irradiance.
2754
- dni_extra can be provided if available to avoid recalculating it
2740
+ ``dni_extra`` can be provided if available to avoid recalculating it
2755
2741
  inside this function. In this case datetime_or_doy is not required.
2742
+ See :term:`dni_extra`. [Wm⁻²]
2743
+
2756
2744
  min_cos_zenith : numeric, default 0.065
2757
2745
  Minimum value of cos(zenith) to allow when calculating global
2758
- clearness index `kt`. Equivalent to zenith = 86.273 degrees.
2746
+ clearness index Kt. Equivalent to zenith = 86.273°.
2747
+
2759
2748
  max_zenith : numeric, default 87
2760
2749
  Maximum value of zenith to allow in DNI calculation. DNI will be
2761
- set to 0 for times with zenith values greater than `max_zenith`.
2750
+ set to 0 for times with zenith values greater than ``max_zenith``. [°]
2762
2751
 
2763
2752
  Returns
2764
2753
  -------
@@ -2766,15 +2755,14 @@ def erbs_driesse(ghi, zenith, datetime_or_doy=None, dni_extra=None,
2766
2755
  Contains the following keys/columns:
2767
2756
 
2768
2757
  * ``dni``: the modeled direct normal irradiance. [Wm⁻²]
2769
- * ``dhi``: the modeled diffuse horizontal irradiance in
2770
- Wm⁻².
2758
+ * ``dhi``: the modeled diffuse horizontal irradiance [Wm⁻²].
2771
2759
  * ``kt``: Ratio of global to extraterrestrial irradiance
2772
- on a horizontal plane.
2760
+ on a horizontal plane. [unitless]
2773
2761
 
2774
2762
  Raises
2775
2763
  ------
2776
2764
  ValueError
2777
- If neither datetime_or_doy nor dni_extra is provided.
2765
+ If neither ``datetime_or_doy`` nor ``dni_extra`` is provided.
2778
2766
 
2779
2767
  Notes
2780
2768
  -----
@@ -2863,20 +2851,30 @@ def orgill_hollands(ghi, zenith, datetime_or_doy, dni_extra=None,
2863
2851
  Parameters
2864
2852
  ----------
2865
2853
  ghi: numeric
2866
- Global horizontal irradiance. [Wm⁻²]
2854
+ Global horizontal irradiance. See :term:`ghi`. [Wm⁻²]
2855
+
2867
2856
  zenith: numeric
2868
- True (not refraction-corrected) zenith angles in decimal degrees.
2869
- datetime_or_doy : int, float, array, pd.DatetimeIndex
2857
+ True (not refraction-corrected) zenith angles. See
2858
+ :term:`solar_zenith`. [°]
2859
+
2860
+ datetime_or_doy : int, float, array or pd.DatetimeIndex, optional
2870
2861
  Day of year or array of days of year e.g.
2871
2862
  pd.DatetimeIndex.dayofyear, or pd.DatetimeIndex.
2863
+ Either ``datetime_or_doy`` or ``dni_extra`` must be provided.
2864
+
2872
2865
  dni_extra : numeric, optional
2873
- Extraterrestrial direct normal irradiance. [W/m2]
2866
+ Extraterrestrial normal irradiance.
2867
+ ``dni_extra`` can be provided if available to avoid recalculating it
2868
+ inside this function. In this case datetime_or_doy is not required.
2869
+ See :term:`dni_extra`. [Wm⁻²]
2870
+
2874
2871
  min_cos_zenith : numeric, default 0.065
2875
2872
  Minimum value of cos(zenith) to allow when calculating global
2876
- clearness index `kt`. Equivalent to zenith = 86.273 degrees.
2873
+ clearness index Kt. Equivalent to zenith = 86.273°.
2874
+
2877
2875
  max_zenith : numeric, default 87
2878
2876
  Maximum value of zenith to allow in DNI calculation. DNI will be
2879
- set to 0 for times with zenith values greater than `max_zenith`.
2877
+ set to 0 for times with zenith values greater than ``max_zenith``. [°]
2880
2878
 
2881
2879
  Returns
2882
2880
  -------
@@ -2884,10 +2882,9 @@ def orgill_hollands(ghi, zenith, datetime_or_doy, dni_extra=None,
2884
2882
  Contains the following keys/columns:
2885
2883
 
2886
2884
  * ``dni``: the modeled direct normal irradiance. [Wm⁻²]
2887
- * ``dhi``: the modeled diffuse horizontal irradiance in
2888
- Wm⁻².
2885
+ * ``dhi``: the modeled diffuse horizontal irradiance [Wm⁻²].
2889
2886
  * ``kt``: Ratio of global to extraterrestrial irradiance
2890
- on a horizontal plane.
2887
+ on a horizontal plane. [unitless]
2891
2888
 
2892
2889
  References
2893
2890
  ----------
@@ -2956,22 +2953,29 @@ def boland(ghi, solar_zenith, datetime_or_doy, a_coeff=8.645, b_coeff=0.613,
2956
2953
  Parameters
2957
2954
  ----------
2958
2955
  ghi: numeric
2959
- Global horizontal irradiance. [Wm⁻²]
2956
+ Global horizontal irradiance. See :term:`ghi`. [Wm⁻²]
2957
+
2960
2958
  solar_zenith: numeric
2961
- True (not refraction-corrected) zenith angles in decimal degrees.
2962
- datetime_or_doy : numeric, pandas.DatetimeIndex
2963
- Day of year or array of days of year e.g.
2964
- pd.DatetimeIndex.dayofyear, or pd.DatetimeIndex.
2959
+ True (not refraction-corrected) zenith angles. See
2960
+ :term:`solar_zenith`. [°]
2961
+
2962
+ datetime_or_doy : numeric or pd.DatetimeIndex.
2963
+ Day of year or array of days of year e.g. pd.DatetimeIndex.dayofyear,
2964
+ or pd.DatetimeIndex.
2965
+
2965
2966
  a_coeff : float, default 8.645
2966
2967
  Logistic curve fit coefficient.
2968
+
2967
2969
  b_coeff : float, default 0.613
2968
2970
  Logistic curve fit coefficient.
2971
+
2969
2972
  min_cos_zenith : numeric, default 0.065
2970
2973
  Minimum value of cos(zenith) to allow when calculating global
2971
- clearness index :math:`k_t`. Equivalent to zenith = 86.273 degrees.
2974
+ clearness index `kt`. Equivalent to zenith = 86.273°.
2975
+
2972
2976
  max_zenith : numeric, default 87
2973
2977
  Maximum value of zenith to allow in DNI calculation. DNI will be
2974
- set to 0 for times with zenith values greater than `max_zenith`.
2978
+ set to 0 for times with zenith values greater than ``max_zenith``. [°]
2975
2979
 
2976
2980
  Returns
2977
2981
  -------
@@ -2979,10 +2983,9 @@ def boland(ghi, solar_zenith, datetime_or_doy, a_coeff=8.645, b_coeff=0.613,
2979
2983
  Contains the following keys/columns:
2980
2984
 
2981
2985
  * ``dni``: the modeled direct normal irradiance. [Wm⁻²]
2982
- * ``dhi``: the modeled diffuse horizontal irradiance in
2983
- Wm⁻².
2986
+ * ``dhi``: the modeled diffuse horizontal irradiance. [Wm⁻²]
2984
2987
  * ``kt``: Ratio of global to extraterrestrial irradiance
2985
- on a horizontal plane.
2988
+ on a horizontal plane. [unitless]
2986
2989
 
2987
2990
  References
2988
2991
  ----------
@@ -3052,24 +3055,24 @@ def campbell_norman(zenith, transmittance, pressure=101325.0,
3052
3055
  Parameters
3053
3056
  ----------
3054
3057
  zenith: pd.Series
3055
- True (not refraction-corrected) zenith angles in decimal
3056
- degrees. If Z is a vector it must be of the same size as all
3057
- other vector inputs. Z must be >=0 and <=180.
3058
+ True (not refraction-corrected) zenith angles. If ``zenith`` is a
3059
+ vector, it must be of the same size as all other vector inputs. [°]
3058
3060
 
3059
3061
  transmittance: float
3060
3062
  Atmospheric transmittance between 0 and 1.
3061
3063
 
3062
3064
  pressure: float, default 101325.0
3063
- Air pressure
3065
+ Air pressure. See :term:`pressure`. [Pa]
3064
3066
 
3065
3067
  dni_extra: float, default 1367.0
3066
3068
  Direct irradiance incident at the top of the atmosphere.
3069
+ See :term:`dni_extra`. [Wm⁻²]
3067
3070
 
3068
3071
  Returns
3069
3072
  -------
3070
3073
  irradiance: DataFrame
3071
3074
  Modeled direct normal irradiance, direct horizontal irradiance,
3072
- and global horizontal irradiance in Wm⁻²
3075
+ and global horizontal irradiance. [Wm⁻²]
3073
3076
 
3074
3077
  References
3075
3078
  ----------
@@ -3111,7 +3114,7 @@ def _liujordan(zenith, transmittance, airmass, dni_extra=1367.0):
3111
3114
  zenith: pd.Series
3112
3115
  True (not refraction-corrected) zenith angles in decimal
3113
3116
  degrees. If Z is a vector it must be of the same size as all
3114
- other vector inputs. Z must be >=0 and <=180.
3117
+ other vector inputs. [°]
3115
3118
 
3116
3119
  transmittance: float
3117
3120
  Atmospheric transmittance between 0 and 1.
@@ -3678,17 +3681,17 @@ def dni(ghi, dhi, zenith, dni_clear=None, clearsky_tolerance=1.1,
3678
3681
  Parameters
3679
3682
  ----------
3680
3683
  ghi : Series
3681
- Global horizontal irradiance.
3684
+ Global horizontal irradiance. See :term:`ghi`. [Wm⁻²]
3682
3685
 
3683
3686
  dhi : Series
3684
- Diffuse horizontal irradiance.
3687
+ Diffuse horizontal irradiance. See :term:`dhi`. [Wm⁻²]
3685
3688
 
3686
3689
  zenith : Series
3687
- True (not refraction-corrected) zenith angles in decimal
3688
- degrees. Angles must be >=0 and <=180.
3690
+ True (not refraction-corrected) zenith angles.
3691
+ See :term:`solar_zenith`. [°]
3689
3692
 
3690
3693
  dni_clear : Series, optional
3691
- Clearsky direct normal irradiance. [Wm⁻²]
3694
+ Clearsky direct normal irradiance. See :term:`dni_clear`. [Wm⁻²]
3692
3695
 
3693
3696
  .. versionchanged:: 0.11.2
3694
3697
  Renamed from ``clearsky_dni`` to ``dni_clear``.
@@ -3712,7 +3715,7 @@ def dni(ghi, dhi, zenith, dni_clear=None, clearsky_tolerance=1.1,
3712
3715
  Returns
3713
3716
  -------
3714
3717
  dni : Series
3715
- The modeled direct normal irradiance.
3718
+ The modeled direct normal irradiance. See :Term:`dni`. [Wm⁻²]
3716
3719
  """
3717
3720
 
3718
3721
  # calculate DNI
@@ -3757,29 +3760,37 @@ def complete_irradiance(solar_zenith,
3757
3760
 
3758
3761
  Parameters
3759
3762
  ----------
3760
- solar_zenith : Series
3761
- Zenith angles in decimal degrees, with datetime index.
3762
- Angles must be >=0 and <=180. Must have the same datetime index
3763
- as ghi, dhi, and dni series, when available.
3763
+ solar_zenith : series
3764
+ Solar zenith angle, with datetime index.
3765
+ Must have the same datetime index as ``ghi``, ``dhi``, and ``dni``,
3766
+ when available. See :term:`solar_zenith`. [°]
3767
+
3764
3768
  ghi : Series, optional
3765
- Pandas series of dni data, with datetime index. Must have the same
3766
- datetime index as dni, dhi, and zenith series, when available.
3769
+ Pandas series of dni data [Wm⁻²], with datetime index. Must have the
3770
+ same datetime index as ``dni``, ``dhi``, and ``zenith``, when
3771
+ available. See :term:`ghi`. [Wm⁻²]
3772
+
3767
3773
  dhi : Series, optional
3768
- Pandas series of dni data, with datetime index. Must have the same
3769
- datetime index as ghi, dni, and zenith series, when available.
3774
+ Diffuse horizontal irradiance, with datetime index. Must have the
3775
+ same datetime index as ``ghi``, ``dhi``, and ``solar_zenith``, when
3776
+ available. See :term:`dhi`. [Wm⁻²]
3777
+
3770
3778
  dni : Series, optional
3771
- Pandas series of dni data, with datetime index. Must have the same
3772
- datetime index as ghi, dhi, and zenith series, when available.
3779
+ Pandas series of dni data [Wm⁻²], with datetime index. Must have the
3780
+ same datetime index as ``ghi``, ``dhi``, and ``zenith``, when
3781
+ available. See :term:`dni`. [Wm⁻²]
3782
+
3773
3783
  dni_clear : Series, optional
3774
3784
  Pandas series of clearsky dni data [Wm⁻²]. Must have the same datetime
3775
3785
  index as ghi, dhi, dni, and zenith series, when available. See
3776
- :py:func:`dni` for details.
3786
+ :py:func:`dni` for details. [Wm⁻²]
3777
3787
 
3778
3788
  Returns
3779
3789
  -------
3780
3790
  component_sum_df : Dataframe
3781
3791
  Pandas series of 'ghi', 'dhi', and 'dni' columns with datetime index
3782
3792
  """
3793
+
3783
3794
  if ghi is not None and dhi is not None and dni is None:
3784
3795
  dni = pvlib.irradiance.dni(ghi, dhi, solar_zenith,
3785
3796
  dni_clear=dni_clear,
@@ -3808,11 +3819,11 @@ def louche(ghi, solar_zenith, datetime_or_doy, max_zenith=90):
3808
3819
  Parameters
3809
3820
  ----------
3810
3821
  ghi : numeric
3811
- Global horizontal irradiance. [Wm⁻²]
3822
+ Global horizontal irradiance, see :term:`ghi`. [Wm⁻²]
3812
3823
 
3813
3824
  solar_zenith : numeric
3814
- True (not refraction-corrected) zenith angles in decimal
3815
- degrees. Angles must be >=0 and <=90.
3825
+ True (not refraction-corrected) zenith angle.
3826
+ See :term:`solar_zenith`. [°]
3816
3827
 
3817
3828
  datetime_or_doy : numeric, pandas.DatetimeIndex
3818
3829
  Day of year or array of days of year e.g.
@@ -3823,11 +3834,12 @@ def louche(ghi, solar_zenith, datetime_or_doy, max_zenith=90):
3823
3834
  data: OrderedDict or DataFrame
3824
3835
  Contains the following keys/columns:
3825
3836
 
3826
- * ``dni``: the modeled direct normal irradiance. [Wm⁻²]
3827
- * ``dhi``: the modeled diffuse horizontal irradiance in
3828
- Wm⁻².
3829
- * ``kt``: Ratio of global to extraterrestrial irradiance
3830
- on a horizontal plane.
3837
+ * ``dni``: the modeled direct normal irradiance, see :term:`dni`.
3838
+ [Wm⁻²]
3839
+ * ``dhi``: the modeled diffuse horizontal irradiance, see :term:`dhi`.
3840
+ [Wm⁻²]
3841
+ * ``kt``: Clearness index. Ratio of global to
3842
+ extraterrestrial irradiance on a horizontal plane. [unitless]
3831
3843
 
3832
3844
  References
3833
3845
  -------
@@ -3872,22 +3884,22 @@ def diffuse_par_spitters(daily_solar_zenith, global_diffuse_fraction):
3872
3884
 
3873
3885
  .. note::
3874
3886
  The diffuse fraction is defined as the ratio of
3875
- diffuse to global daily insolation, in J m⁻² day⁻¹ or equivalent.
3887
+ diffuse to global daily insolation, in Jm⁻² day⁻¹ or equivalent.
3876
3888
 
3877
3889
  Parameters
3878
3890
  ----------
3879
3891
  daily_solar_zenith : numeric
3880
- Average daily solar zenith angle. In degrees [°].
3892
+ Average daily solar zenith angle. See :term:`solar_zenith`. [°]
3881
3893
 
3882
3894
  global_diffuse_fraction : numeric
3883
- Fraction of daily global broadband insolation that is diffuse.
3884
- Unitless [0, 1].
3895
+ Fraction of daily global broadband insolation that is diffuse, between
3896
+ 0 and 1. [unitless]
3885
3897
 
3886
3898
  Returns
3887
3899
  -------
3888
3900
  par_diffuse_fraction : numeric
3889
3901
  Fraction of daily photosynthetically active radiation (PAR) that is
3890
- diffuse. Unitless [0, 1].
3902
+ diffuse, between 0 and 1. [unitless]
3891
3903
 
3892
3904
  Notes
3893
3905
  -----