1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
# -*- python -*-
'''
xpybar – xmobar replacement written in python
Copyright © 2014, 2015, 2016 Mattias Andrée (maandree@member.fsf.org)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
'''
import solar_python
class Solar:
'''
Solar information
'''
SOLAR_ELEVATION_SUNSET_SUNRISE = solar_python.SOLAR_ELEVATION_SUNSET_SUNRISE
'''
:float The Sun's elevation at sunset and sunrise,
measured in degrees
'''
SOLAR_ELEVATION_CIVIL_DUSK_DAWN = solar_python.SOLAR_ELEVATION_CIVIL_DUSK_DAWN
'''
:float The Sun's elevation at civil dusk and civil
dawn, measured in degrees
'''
SOLAR_ELEVATION_NAUTICAL_DUSK_DAWN = solar_python.SOLAR_ELEVATION_NAUTICAL_DUSK_DAWN
'''
:float The Sun's elevation at nautical dusk and
nautical dawn, measured in degrees
'''
SOLAR_ELEVATION_ASTRONOMICAL_DUSK_DAWN = solar_python.SOLAR_ELEVATION_ASTRONOMICAL_DUSK_DAWN
'''
:float The Sun's elevation at astronomical dusk
and astronomical dawn, measured in degrees
'''
SOLAR_ELEVATION_AMATEUR_ASTRONOMICAL_DUSK_DAWN = solar_python.SOLAR_ELEVATION_AMATEUR_ASTRONOMICAL_DUSK_DAWN
'''
:float The Sun's elevation at amateur astronomical dusk
and amateur astronomical dawn, measured in degrees
'''
SOLAR_ELEVATION_RANGE_TWILIGHT = solar_python.SOLAR_ELEVATION_RANGE_TWILIGHT
'''
:(float, float) The Sun's lowest and highest elevation during
all periods of twilight, measured in degrees
'''
SOLAR_ELEVATION_RANGE_CIVIL_TWILIGHT = solar_python.SOLAR_ELEVATION_RANGE_CIVIL_TWILIGHT
'''
:(float, float) The Sun's lowest and highest elevation
during civil twilight, measured in degrees
'''
SOLAR_ELEVATION_RANGE_NAUTICAL_TWILIGHT = solar_python.SOLAR_ELEVATION_RANGE_NAUTICAL_TWILIGHT
'''
:(float, float) The Sun's lowest and highest elevation
during nautical twilight, measured in degrees
'''
SOLAR_ELEVATION_RANGE_ASTRONOMICAL_TWILIGHT = solar_python.SOLAR_ELEVATION_RANGE_ASTRONOMICAL_TWILIGHT
'''
:(float, float) The Sun's lowest and highest elevation during
astronomical twilight, measured in degrees
'''
SOLAR_ELEVATION_RANGE_AMATEUR_ASTRONOMICAL_TWILIGHT = solar_python.SOLAR_ELEVATION_RANGE_AMATEUR_ASTRONOMICAL_TWILIGHT
'''
:(float, float) The Sun's lowest and highest elevation during
amateur astronomical twilight, measured in degrees
'''
SOLAR_ELEVATION_RANGE_GOLDEN_HOUR = solar_python.SOLAR_ELEVATION_RANGE_GOLDEN_HOUR
'''
:(float, float) The Sun's lowest and highest elevation during
the golden "hour" (also known as magic hour),
measured in degrees. These elevations are
approximate.
'''
SOLAR_ELEVATION_RANGE_BLUE_HOUR = solar_python.SOLAR_ELEVATION_RANGE_BLUE_HOUR
'''
:(float, float) The Sun's lowest and highest elevation during
the blue "hour", measured in degrees. These
elevations are approximate.
'''
EQUINOX = 0
SUMMER = 1
WINTER = 2
def __init__(self, latitude, longitude, t = None):
'''
Constructor
@param latitude:float The latitude in degrees northwards from
the equator, negative for southwards
@param longitude:float The longitude in degrees eastwards from
Greenwich, negative for westwards
@param t:float? The time in Julian Centuries, `None`
for the current time of when the functions
are called
'''
self.lat = latitude
self.lon = longitude
self.t = t
self.u = solar_python.julian_centuries_to_epoch
def now(self):
return solar_python.julian_centuries() if self.t is None else self.t
def season(self):
t = self.now()
rc = Solar.SUMMER + solar_python.is_summer(self.lat, t)
rc += Solar.WINTER + solar_python.is_winter(self.lat, t)
return rc % 3
def have_sunrise_and_sunset(self):
'''
Determine whether solar declination currently is
so that there can be sunrises and sunsets. If not,
you either have 24-hour daytime or 24-hour nighttime.
@return Whether there can be sunrises and sunsets where you are located
'''
return solar_python.have_sunrise_and_sunset(self.lat, self.now())
def declination(self):
'''
Calculates the Sun's declination
@return :float The Sun's declination, in degrees
'''
return solar_python.degrees(solar_python.solar_declination(self.now()))
def elevation(self):
'''
Calculates the Sun's elevation as apparent
from a geographical position
@return :float The Sun's apparent at the specified time
as seen from the specified position,
measured in degrees
'''
return solar_python.solar_elevation(self.lat, self.lon, self.now())
def future_equinox(self):
'''
Predict the time point of the next equinox
@return :float The calculated time point, in POSIX time
'''
return self.u(solar_python.future_equinox(self.now()))
def past_equinox(self):
'''
Predict the time point of the previous equinox
@return :float The calculated time point, in POSIX time
'''
return self.u(solar_python.past_equinox(self.now()))
def future_solstice(self):
'''
Predict the time point of the next solstice
@return :float The calculated time point, in POSIX time
'''
return self.u(solar_python.future_solstice(self.now()))
def past_solstice(self):
'''
Predict the time point of the previous solstice
@return :float The calculated time point, in POSIX time
'''
return self.u(solar_python.past_solstice(self.now()))
def future_elevation(self, elevation):
'''
Predict the time point of the next time the
Sun reaches a specific elevation
@param elevation:float The elevation of interest
@return :float? The calculated time point, in POSIX time,
`None` if none were found within a year
'''
return self.u(solar_python.future_elevation(self.lat, self.lon, elevation, self.now()))
def past_elevation(self, elevation):
'''
Predict the time point of the previous time the Sun
reached a specific elevation
@param elevation:float The elevation of interest
@return :float? The calculated time point, in POSIX time,
`None` if none were found within a year
'''
return self.u(solar_python.past_elevation(self.lat, self.lon, elevation, self.now()))
def future_elevation_derivative(self, derivative):
'''
Predict the time point of the next time the
Sun reaches a specific elevation derivative
@param derivative:float The elevation derivative value of interest
@return :float? The calculated time point, in POSIX time,
`None` if none were found within a year
'''
return self.u(solar_python.future_elevation_derivative(self.lat, self.lon, derivative, self.now()))
def past_elevation_derivative(self, derivative):
'''
Predict the time point of the previous time
the Sun reached a specific elevation derivative
@param derivative:float The elevation derivative value of interest
@return :float? The calculated time point, in POSIX time,
`None` if none were found within a year
'''
return self.u(solar_python.past_elevation_derivative(self.lat, self.lon, derivative, self.now()))
|
