-
Notifications
You must be signed in to change notification settings - Fork 0
/
SetUpDownloadRequests.py
304 lines (256 loc) · 11.8 KB
/
SetUpDownloadRequests.py
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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
from sunpy.net import jsoc, Fido, attrs as a
from sunpy.net.jsoc import *
import astropy.units as u
import time
import os
import re
class DownloadStager(object):
"""
Represents a month of a specific year that you want to stage download requests for.
Scroll all the way to the bottom for usage.
"""
MAX_ATTEMPTS = 10 # Max attempts of program before quitting and logging time range. If your requests typically fail while using the terminal, you may want to increase this value.
MAX_FILES_FOR_HALVING = 2500 # Max number of files to have in a download request. If your computer consistently throws HTTP Errors while using the terminal, you may want to decrease this value.
def __init__(self, year, month, days_in_month):
"""
Initialize data for a specific month's download request.
year: year of month you want data for
month: numerical value of month; ordinal-based, not zero-based (DO NOT FILL IN 0s FOR SINGLE-DIGIT MONTHS)
days_in_month: the number of days in the month for that that specific year
"""
self.year = year
self.month = month
self.days_in_month = days_in_month
self.client = jsoc.JSOCClient()
self.series_name = 'hmi.sharp_cea_720s'
self.notify_address = 'fernandesi2244@gmail.com'
self.no_tries = 0
def log_problem(self, start, end):
"""
Logs any problematic time ranges to 'DownloadRequestData/problem_requests.txt'
start: the start day
end: the end day
"""
time.sleep(5)
with open(os.path.join('DownloadRequestData', 'problem_requests.txt'), "a") as problems_file:
message = f"FAIL! Timespan: {self.month:02d}/{start:02d}/{self.year} to {self.month:02d}/{end:02d}/{self.year}\n"
problems_file.write(message)
print(message)
def log_success(self, start, end, id):
"""
Logs successful staging requests (with their IDs) to 'DownloadRequestData/request_numbers.txt'
start: the start day
end: the end day
id: the id of the request
"""
time.sleep(5)
with open(os.path.join('DownloadRequestData', 'request_numbers.txt'), "a") as successes_file:
message = f"SUCCESS! Timespan: {self.month:02d}/{start:02d}/{self.year} to {self.month:02d}/{end:02d}/{self.year}; ID: {id}\n"
successes_file.write(message)
print(message)
def run(self):
"""
Calls function to stage request.
"""
self.no_tries = 0
self.get_files(1, self.days_in_month)
def get_files(self, start, end):
"""
Recursively makes stage requests (on shorter timespans, as necessary) to the JSOCClient and attempts
to address any server errors that may occur during program execution.
start: the day to start from
end: the day to end on
"""
start_time = f"{self.year}-{self.month:02d}-{start:02d}T00:00:00"
end_time = f"{self.year}-{self.month:02d}-{end:02d}T23:00:00"
print("Attempting to get request for:")
print("\tStart Time:", start_time)
print("\tEnd Time: ", end_time)
try:
res = self.client.search(
a.Time(start_time, end_time),
a.jsoc.Series(self.series_name),
a.jsoc.Notify(self.notify_address),
a.vso.Sample(3600*u.second),
a.jsoc.Segment('bitmap'))
file_num = len(res)
if file_num > DownloadStager.MAX_FILES_FOR_HALVING:
print(f'Halving (Number of files = {file_num})...')
first_upper_bound = (start+end)//2
self.no_tries = 0
self.get_files(start, first_upper_bound)
self.no_tries = 0
self.get_files(first_upper_bound+1, end)
return
self.no_tries += 1
print("search() function successful; attempting to request data...")
time.sleep(5)
requests = self.client.request_data(res)
print("request_data() function successful")
except Exception as e:
print('Caught Exception:')
print('\t'+repr(e))
if self.no_tries > DownloadStager.MAX_ATTEMPTS:
print('Max tries reached in try-except')
self.log_problem(start, end)
return
print('Waiting 60 seconds to try again...')
time.sleep(60)
self.get_files(start, end)
return
print('Request ID:', requests.id)
print('Request Status:', requests.status)
'''
Status Code | Meaning
-----------------------------------------------------------------------------------------------------------------------------------------
0 | Ready to download; this is one of the optimal statuses, but this status is not expected to be seen during script execution.
1 | Staging, will be ready to download; this is the status we want when running the program.
2 | Need to “nudge” it to stage; tell it to download using client.get_request() (JSOC Client won’t actually download yet)
4 | Request failed/timed out; run staging process again
6 | Request failed/timed out; tell it to "download" again using client.get_request()
'''
if requests.status == 2:
try:
print('Running get_request()...')
res = self.client.get_request(requests, path = 'HMI Downloaded Files')
except Exception:
pass
if requests.status == 1 or requests.status == 0:
print(f'Status = {requests.status}; good to go!')
time.sleep(1)
self.log_success(start, end, requests.id)
elif requests.status == 6:
# Double-tapping method simply re-runs the get_request() command after a short period of time; this usually works
print('Status = 6; trying double-tapping method')
code6Max = 5
currentTries = 0
while(currentTries < code6Max):
currentTries +=1
time.sleep(10)
try:
print('Running get_request()...')
res = self.client.get_request(requests, path = 'HMI Downloaded Files')
except Exception:
pass
if requests.status == 1 or requests.status == 0:
break
if requests.status == 1 or requests.status == 0:
print('Double-tapping method worked!')
time.sleep(1)
self.log_success(start, end, requests.id)
else:
print("Double-tapping method didn't work!")
if self.no_tries > DownloadStager.MAX_ATTEMPTS:
self.log_problem(start, end)
return
print('Waiting 15 seconds to try again...')
time.sleep(15)
self.get_files(start, end)
else:
print('Request Status:', requests.status)
print("Let's try again...")
if self.no_tries > DownloadStager.MAX_ATTEMPTS:
self.log_problem(start, end)
return
print('Waiting 20 seconds to try again...')
time.sleep(20)
self.get_files(start, end)
elif requests.status == 4:
print("Let's try again...")
if self.no_tries > DownloadStager.MAX_ATTEMPTS:
self.log_problem(start, end)
return
print('Waiting 30 seconds to try again...')
time.sleep(30)
self.get_files(start, end)
elif requests.status == 6:
# Double-tapping method simply re-runs the get_request() command after a short period of time; this usually works
print('Status = 6; trying double-tapping method')
code6Max = 5
currentTries = 0
while(currentTries < code6Max):
currentTries +=1
time.sleep(10)
try:
print('Running get_request()...')
res = self.client.get_request(requests, path = 'HMI Downloaded Files')
except Exception:
pass
if requests.status == 1 or requests.status == 0:
break
if requests.status == 1 or requests.status == 0:
print('Double-tapping method worked!')
time.sleep(1)
self.log_success(start, end, requests.id)
else:
print("Double-tapping method didn't work!")
if self.no_tries > DownloadStager.MAX_ATTEMPTS:
self.log_problem(start, end)
return
print('Waiting 15 seconds to try again...')
time.sleep(15)
self.get_files(start, end)
elif requests.status == 1 or requests.status == 0:
print(f'Status = {requests.status}; good to go!')
time.sleep(1)
self.log_success(start, end, requests.id)
else:
print("Let's try again...")
if self.no_tries > DownloadStager.MAX_ATTEMPTS:
self.log_problem(start, end)
return
print('Waiting 60 seconds to try again...')
time.sleep(60)
self.get_files(start, end)
def run_range(self, start, end):
"""
Stages download request for a specific range of dates.
This function is commonly used when the program stalls on a particular month so that you can easily
request the data yourself without visiting the terminal. See bottom of script for usage.
start: the start day
end: the end day
"""
self.no_tries = 0
print(f'Running with custom timeframe: {self.month:02d}/{start:02d}/{self.year} to {self.month:02d}/{end:02d}/{self.year}')
self.get_files(start, end)
self.no_tries = 0
@staticmethod
def obtain_JSOC_nums():
"""
Extracts just the ID numbers from the 'request_numbers.txt' file and writes them to the 'JSOC_IDs.txt' file.
"""
IDs = []
input_path = os.path.join('DownloadRequestData', 'request_numbers.txt')
with open(input_path, 'r') as read_file:
all_lines = read_file.readlines()
regex = 'JSOC_\\d+_\\d+'
for line in all_lines:
match = re.search(regex, line)
if match:
IDs.append(match.group()+'\n')
else:
print('Could not extract ID from:', line)
output_path = os.path.join('DownloadRequestData', 'JSOC_IDs.txt')
with open(output_path, 'w') as write_file:
write_file.writelines(IDs)
print("Check the 'JSOC_IDs.txt' file for the IDs.")
'''
EXAMPLE USAGE:
Recall that you call the constructor with (year, month, days in month)
august_2013 = DownloadStager(2013, 8, 31)
august_2013.run()
september_2013 = DownloadStager(2013, 9, 30)
september_2013.run()
october_2013 = DownloadStager(2013, 10, 31)
october_2013.run()
november_2013 = DownloadStager(2013, 11, 30)
november_2013.run()
december_2013 = DownloadStager(2013, 12, 31)
december_2013.run()
IF THE PROGRAM GETS STUCK ON A MONTH AND YOU NEED TO MANUALLY RUN ON SPECIFIC RANGES AFTER STOPPING THE PROGRAM:
january_2015 = DownloadStager(2015, 1, 31)
january_2015.run_range(16, 23)
TO TURN OUTPUT (request_numbers.txt) INTO JUST ID NUMBERS:
DownloadStager.obtain_JSOC_nums()
'''
# START ENTERING YOUR COMMANDS HERE: