8000 improve solpos tz requirements documentation (#853) · roy-camargo/pvlib-python@7dcb717 · GitHub
[go: up one dir, main page]
Skip to content

Commit 7dcb717

Browse files
wholmgrencwhanse
wholmgren
and
cwhanse
authored
improve solpos tz requirements documentation (pvlib#853)
* improve solpos tz requirements * Update pvlib/solarposition.py Co-Authored-By: Cliff Hansen <cwhanse@sandia.gov> * Update pvlib/solarposition.py Co-Authored-By: Cliff Hansen <cwhanse@sandia.gov> Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
1 parent 245ace1 commit 7dcb717

File tree

2 files changed

+42
-12
lines changed

2 files changed

+42
-12
lines changed

‎pvlib/location.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,8 @@ def get_solarposition(self, times, pressure=None, temperature=12,
171171
172172
Parameters
173173
----------
174-
times : DatetimeIndex
174+
times : pandas.DatetimeIndex
175+
Must be localized or UTC will be assumed.
175176
pressure : None, float, or array-like, default None
176177
If None, pressure will be calculated using
177178
:py:func:`atmosphere.alt2pres` and ``self.altitude``.

‎pvlib/solarposition.py

Lines changed: 40 additions & 11 deletions
< 8000 td data-grid-cell-id="diff-cb87c5de5d97f94270d390f540ae4b854d6e4b531346c5f662fd0cfc30817805-579-594-0" data-selected="false" role="gridcell" style="background-color:var(--diffBlob-deletionNum-bgColor, var(--diffBlob-deletion-bgColor-num));text-align:center" tabindex="-1" valign="top" class="focusable-grid-cell diff-line-number position-relative left-side">579
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424

2525
from pvlib import atmosphere
2626
from pvlib.tools import datetime_to_djd, djd_to_datetime
27-
from pvlib._deprecation import deprecated
2827

2928

3029
NS_PER_HR = 1.e9 * 3600. # nanoseconds per hour
@@ -40,9 +39,15 @@ def get_solarposition(time, latitude, longitude,
4039
Parameters
4140
----------
4241
time : pandas.DatetimeIndex
42+
Must be localized or UTC will be assumed.
4343
4444
latitude : float
45+
Latitude in decimal degrees. Positive north of equator, negative
46+
to south.
47+
4548
longitude : float
49+
Longitude in decimal degrees. Positive east of prime meridian,
50+
negative to west.
4651
4752
altitude : None or float, default None
4853
If None, computed from pressure. Assumed to be 0 m
@@ -69,7 +74,9 @@ def get_solarposition(time, latitude, longitude,
6974
temperature : float, default 12
7075
Degrees C.
7176
72-
Other keywords are passed to the underlying solar position function.
77+
kwargs
78+
Other keywords are passed to the solar position function
79+
specified by the ``method`` argument.
7380
7481
References
7582
----------
@@ -137,13 +144,17 @@ def spa_c(time, latitude, longitude, pressure=101325, altitude=0,
137144
Parameters
138145
----------
139146
time : pandas.DatetimeIndex
140-
Localized or UTC.
147+
Must be localized or UTC will be assumed.
141148
latitude : float
149+
Latitude in decimal degrees. Positive north of equator, negative
150+
to south.
142151
longitude : float
152+
Longitude in decimal degrees. Positive east of prime meridian,
153+
negative to west.
143154
pressure : float, default 101325
144155
Pressure in Pascals
145156
altitude : float, default 0
146-
Elevation above sea level.
157+
Height above sea level. [m]
147158
temperature : float, default 12
148159
Temperature in C
149160
delta_t : float, default 67.0
@@ -276,10 +287,15 @@ def spa_python(time, latitude, longitude,
276287
Parameters
277288
----------
278289
time : pandas.DatetimeIndex
279-
Localized or UTC.
290+
Must be localized or UTC will be assumed.
280291
latitude : float
292+
Latitude in decimal degrees. Positive north of equator, negative
293+
to south.
281294
longitude : float
295+
Longitude in decimal degrees. Positive east of prime meridian,
296+
negative to west.
282297
altitude : float, default 0
298+
Distance above sea level.
283299
pressure : int or float, optional, default 101325
284300
avg. yearly air pressure in Pascals.
285301
temperature : int or float, optional, default 12
@@ -574,13 +590,15 @@ def pyephem(time, latitude, longitude, altitude=0, pressure=101325,
574590
Parameters
575591
----------
576592
time : pandas.DatetimeIndex
577-
Localized or UTC.
593+
Must be localized or UTC will be assumed.
578594
latitude : float
-
positive is north of 0
595+
Latitude in decimal degrees. Positive north of equator, negative
596+
to south.
580597
longitude : float
581-
positive is east of 0
598+
Longitude in decimal degrees. Positive east of prime meridian,
599+
negative to west.
582600
altitude : float, default 0
583-
distance above sea level in meters.
601+
Height above sea level in meters. [m]
584602
pressure : int or float, optional, default 101325
585603
air pressure in Pascals.
586604
temperature : int or float, optional, default 12
@@ -666,8 +684,13 @@ def ephemeris(time, latitude, longitude, pressure=101325, temperature=12):
666684
Parameters
667685
----------
668686
time : pandas.DatetimeIndex
687+
Must be localized or UTC will be assumed.
669688
latitude : float
689+
Latitude in decimal degrees. Positive north of equator, negative
690+
to south.
670691
longitude : float
692+
Longitude in decimal degrees. Positive east of prime meridian,
693+
negative to west.
671694
pressure : float or Series, default 101325
672695
Ambient pressure (Pascals)
673696
temperature : float or Series, default 12
@@ -845,7 +868,11 @@ def calc_time(lower_bound, upper_bound, latitude, longitude, attribute, value,
845868
lower_bound : datetime.datetime
846869
upper_bound : datetime.datetime
847870
latitude : float
871+
Latitude in decimal degrees. Positive north of equator, negative
872+
to south.
848873
longitude : float
874+
Longitude in decimal degrees. Positive east of prime meridian,
875+
negative to west.
849876
attribute : str
850877
The attribute of a pyephem.Sun object that
851878
you want to solve for. Likely options are 'alt'
@@ -909,7 +936,8 @@ def pyephem_earthsun_distance(time):
909936
910937
Parameters
911938
----------
912-
time : pd.DatetimeIndex
939+
time : pandas.DatetimeIndex
940+
Must be localized or UTC will be assumed.
913941
914942
Returns
915943
-------
@@ -934,7 +962,8 @@ def nrel_earthsun_distance(time, how='numpy', delta_t=67.0, numthreads=4):
934962
935963
Parameters
936964
----------
937-
time : pd.DatetimeIndex
965+
time : pandas.DatetimeIndex
966+
Must be localized or UTC will be assumed.
938967
939968
how : str, optional, default 'numpy'
940969
Options are 'numpy' or 'numba'. If numba >= 0.17.0

0 commit comments

Comments
 (0)
0