heliopy.data.util.
Downloader
¶Bases: object
A template class, that should be sub-classed to provide methods for downloading a single dataset.
The following methods must be implemented by sub-classes:
Downloader.intervals()
: given a time interval, this
method should split the interval up into sub-intervals. Each of these
sub-intervals corresponds directly to a single file to download, store,
and read in.
Downloader.local_dir()
: given an interval, returns the
local directory in which the file is stored.
Downloader.fname()
: given an interval, returns the
local filename in which the file is stored.
Downloader.download()
: given an interval, download the data for
that interval.
Downloader.load_local_file()
: given an interval, load the local
file and return a pandas.DataFrame
object containing the data.
Methods Summary
|
Download data for a given interval. |
|
Return the filename for a given interval. |
|
The complete list of sub-intervals that cover a time range Each sub-interval is associated with a single file to be downloaded and read in. |
|
Load all data between starttime and endtime. |
|
Load local file for a given interval. |
|
Local directory for a given interval. |
|
|
|
|
|
Methods Documentation
download
(interval)¶Download data for a given interval.
interval (sunpy.time.TimeRange) –
dl_path – Path to the downloaded file.
fname
(interval)¶Return the filename for a given interval.
interval (sunpy.time.TimeRange) –
fname – Filename
intervals
(starttime, endtime)¶The complete list of sub-intervals that cover a time range Each sub-interval is associated with a single file to be downloaded and read in.
starttime (datetime.datetime) –
endtime (datetime.datetime) –
fnames – List of intervals
list of sunpy.time.TimeRange
load
(starttime, endtime)¶Load all data between starttime and endtime.
load_local_file
(interval)¶Load local file for a given interval.
interval (sunpy.time.TimeRange) –
data
local_dir
(interval)¶Local directory for a given interval.
interval (sunpy.time.TimeRange) –
dir – Local directory
local_file_exists
(interval)¶local_hdf_path
(interval)¶local_path
(interval)¶