Skip to content

Commit 9970179

Browse files
author
anomam
committed
Fix docstrings for pvlib consistency + link to pvfactors TLDR
1 parent 9829b81 commit 9970179

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

pvlib/bifacial.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,20 @@ def pvfactors_timeseries(
2222
2323
Inputs
2424
------
25-
solar_azimuth: numeric (list, numpy array, or pandas Series)
25+
solar_azimuth: numeric
2626
Sun's azimuth angles using pvlib's azimuth convention (deg)
27-
solar_zenith: numeric (list, numpy array, or pandas Series)
27+
solar_zenith: numeric
2828
Sun's zenith angles (deg)
29-
surface_azimuth: numeric (list, numpy array, or pandas Series)
29+
surface_azimuth: numeric
3030
Azimuth angle of the front surface of the PV modules, using pvlib's
3131
convention (deg)
32-
surface_tilt: numeric (list, numpy array, or pandas Series)
32+
surface_tilt: numeric
3333
Tilt angle of the PV modules, going from 0 to 180 (deg)
3434
timestamps: datetime or DatetimeIndex
3535
List of simulation timestamps
36-
dni: numeric (list, numpy array, or pandas Series)
36+
dni: numeric
3737
Direct normal irradiance (W/m2)
38-
dhi: numeric (list, numpy array, or pandas Series)
38+
dhi: numeric
3939
Diffuse horizontal irradiance (W/m2)
4040
gcr: float
4141
Ground coverage ratio of the pv array

pvlib/test/test_bifacial.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
@requires_pvfactors
99
def test_pvfactors_timeseries():
1010
""" Test that pvfactors is functional, using the TLDR section inputs of the
11-
package github repo README.md file"""
11+
package github repo README.md file:
12+
https://github.com/SunPower/pvfactors/blob/master/README.md#tldr---quick-start"""
1213

1314
# Create some inputs
1415
timestamps = pd.DatetimeIndex([datetime(2017, 8, 31, 11),

0 commit comments

Comments
 (0)