Skip to content

Commit 19ed9a2

Browse files
committed
Add notes on system-wide parameters to PVSystem method docstrings
1 parent 2e389fa commit 19ed9a2

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

pvlib/pvsystem.py

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -344,6 +344,14 @@ def get_irradiance(self, solar_zenith, solar_azimuth, dni, ghi, dhi,
344344
kwargs
345345
Extra parameters passed to :func:`irradiance.get_total_irradiance`.
346346
347+
Notes
348+
-----
349+
Each of `dni`, `ghi`, and `dni` parameters may be passed as a tuple
350+
to provide different irradiance for each array in the system. If not
351+
passed as a tuple then the same value is used for input to each Array.
352+
If passed as a tuple the length must be the same as the number of
353+
Arrays.
354+
347355
Returns
348356
-------
349357
poa_irradiance : DataFrame or tuple of DataFrame
@@ -567,6 +575,14 @@ def sapm_celltemp(self, poa_global, temp_air, wind_speed):
567575
-------
568576
numeric or tuple of numeric
569577
values in degrees C.
578+
579+
Notes
580+
-----
581+
The `temp_air` and `wind_speed` parameters may be passed as tuples
582+
to provide different values for each Array in the system. If not
583+
passed as a tuple then the same value is used for input to each Array.
584+
If passed as a tuple the length must be the same as the number of
585+
Arrays.
570586
"""
571587
poa_global = self._validate_per_array(poa_global)
572588
temp_air = self._validate_per_array(temp_air, system_wide=True)
@@ -680,6 +696,14 @@ def pvsyst_celltemp(self, poa_global, temp_air, wind_speed=1.0):
680696
-------
681697
numeric or tuple of numeric
682698
values in degrees C.
699+
700+
Notes
701+
-----
702+
The `temp_air` and `wind_speed` parameters may be passed as tuples
703+
to provide different values for each Array in the system. If not
704+
passed as a tuple then the same value is used for input to each Array.
705+
If passed as a tuple the length must be the same as the number of
706+
Arrays.
683707
"""
684708
poa_global = self._validate_per_array(poa_global)
685709
temp_air = self._validate_per_array(temp_air, system_wide=True)
@@ -720,6 +744,14 @@ def faiman_celltemp(self, poa_global, temp_air, wind_speed=1.0):
720744
-------
721745
numeric or tuple of numeric
722746
values in degrees C.
747+
748+
Notes
749+
-----
750+
The `temp_air` and `wind_speed` parameters may be passed as tuples
751+
to provide different values for each Array in the system. If not
752+
passed as a tuple then the same value is used for input to each Array.
753+
If passed as a tuple the length must be the same as the number of
754+
Arrays.
723755
"""
724756
poa_global = self._validate_per_array(poa_global)
725757
temp_air = self._validate_per_array(temp_air, system_wide=True)
@@ -763,6 +795,14 @@ def fuentes_celltemp(self, poa_global, temp_air, wind_speed):
763795
transposition. This method defaults to using ``self.surface_tilt``, but
764796
if you want to match the PVWatts behavior, you can override it by
765797
including a ``surface_tilt`` value in ``temperature_model_parameters``.
798+
799+
Notes
800+
-----
801+
The `temp_air` and `wind_speed` parameters may be passed as tuples
802+
to provide different values for each Array in the system. If not
803+
passed as a tuple then the same value is used for input to each Array.
804+
If passed as a tuple the length must be the same as the number of
805+
Arrays.
766806
"""
767807
# default to using the Array attribute, but allow user to
768808
# override with a custom surface_tilt value

0 commit comments

Comments
 (0)