Skip to content

Commit da305c2

Browse files
committed
revised docstring of ephemeris()
1 parent 9b95720 commit da305c2

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

pvlib/solarposition.py

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -210,9 +210,9 @@ def pyephem(time, location, pressure=101325, temperature=12):
210210

211211

212212
def ephemeris(time, location, pressure=101325, temperature=12):
213-
'''
213+
'''
214214
Python-native solar position calculator.
215-
The accuracy of this code is not guaranteed.
215+
The accuracy of this code is not guaranteed.
216216
Consider using the built-in spa_c code or the PyEphem library.
217217
218218
Parameters
@@ -223,47 +223,45 @@ def ephemeris(time, location, pressure=101325, temperature=12):
223223
Other Parameters
224224
----------------
225225
226-
pressure : float or DataFrame
226+
pressure : float or DataFrame [default: 101325]
227227
Ambient pressure (Pascals)
228228
229-
temperature : float or DataFrame
229+
temperature : float or DataFrame [default: 12]
230230
Ambient temperature (C)
231-
231+
232232
Returns
233233
-------
234-
234+
235235
DataFrame with the following columns
236-
236+
237237
SunEl : float of DataFrame
238-
Actual elevation (not accounting for refraction)of the sun
238+
Actual elevation (not accounting for refraction)of the sun
239239
in decimal degrees, 0 = on horizon. The complement of the True Zenith
240240
Angle.
241-
242-
SunAz : Azimuth of the sun in decimal degrees from North. 0 = North to 270 = West
243-
241+
242+
SunAz : Azimuth of the sun in decimal degrees from North.
243+
0 = North, 90 = West, 180 = South, 270 = West
244+
244245
SunZen : Solar zenith angle
245246
246247
ApparentSunEl : float or DataFrame
247248
248-
Apparent sun elevation accounting for atmospheric
249+
Apparent sun elevation accounting for atmospheric
249250
refraction. This is the complement of the Apparent Zenith Angle.
250251
251252
SolarTime : fload or DataFrame
252253
Solar time in decimal hours (solar noon is 12.00).
253-
254+
254255
255256
References
256257
-----------
257258
258-
Grover Hughes' class and related class materials on Engineering
259+
Grover Hughes' class and related class materials on Engineering
259260
Astronomy at Sandia National Laboratories, 1985.
260261
261262
See also
262263
--------
263-
pvl_makelocationstruct
264-
pvl_alt2pres
265-
pvl_getaoi
266-
pvl_spa
264+
pyephem, spa
267265
268266
'''
269267

0 commit comments

Comments
 (0)