Source code for sunpy.net.dataretriever.sources.rhessi

# Author: Rishabh Sharma <rishabh.sharma.gunner@gmail.com>
# This module was developed under funding provided by
# Google Summer of Code 2014
import socket
from datetime import datetime
from urllib.error import URLError
from urllib.request import urlopen, urlretrieve

from dateutil.rrule import MONTHLY, rrule

from sunpy.extern.parse import parse
from sunpy.extern.sunkit_instruments.rhessi import parse_observing_summary_dbase_file
from sunpy.net.dataretriever import GenericClient, QueryResponse
from sunpy.time import TimeRange, parse_time

__all__ = ['RHESSIClient']

data_servers = ('https://hesperia.gsfc.nasa.gov/hessidata/',
                'http://hessi.ssl.berkeley.edu/hessidata/',
                'http://soleil.i4ds.ch/hessidata/')

lc_linecolors = ('black', 'pink', 'green', 'blue', 'brown', 'red',
                 'navy', 'orange', 'green')


def get_base_url():
    """
    Find the first mirror which is online
    """
    for server in data_servers:
        try:
            urlopen(server, timeout=1)
            return server
        except (URLError, socket.timeout):
            pass

    raise OSError(f'Unable to find an online HESSI server from {data_servers}')


[docs]class RHESSIClient(GenericClient): """ Provides access to the RHESSI observing summary time series data. Uses this `archive <https://hesperia.gsfc.nasa.gov/hessidata/>`__ or its mirrors. Examples -------- >>> from sunpy.net import Fido, attrs as a >>> results = Fido.search(a.Time("2016/1/1", "2016/1/2"), ... a.Instrument.rhessi, a.Physobs.summary_lightcurve) #doctest: +REMOTE_DATA >>> results #doctest: +REMOTE_DATA <sunpy.net.fido_factory.UnifiedResponse object at ...> Results from 1 Provider: <BLANKLINE> 2 Results from the RHESSIClient: Start Time End Time Instrument ... Source Provider ----------------------- ----------------------- ---------- ... ------ -------- 2016-01-01 00:00:00.000 2016-01-01 23:59:59.999 RHESSI ... RHESSI NASA 2016-01-02 00:00:00.000 2016-01-02 23:59:59.999 RHESSI ... RHESSI NASA <BLANKLINE> <BLANKLINE> """ pattern = '{}/catalog/hsi_obssumm_{year:4d}{month:2d}{day:2d}_{}'
[docs] def get_observing_summary_filename(self, time_range): """ Download the RHESSI observing summary data from one of the RHESSI servers, parses it, and returns the name of the observing summary files relevant for the time range. Parameters ---------- time_range : str, `sunpy.time.TimeRange` A `sunpy.time.TimeRange` or time range compatible string. Returns ------- out : list Returns the urls of the observation summary file Examples -------- >>> from sunpy.net.dataretriever.sources.rhessi import RHESSIClient >>> RHESSIClient().get_observing_summary_filename(('2011/04/04', '2011/04/04')) # doctest: +REMOTE_DATA ['https://.../hessidata/metadata/catalog/hsi_obssumm_20110404_058.fits'] """ dt = TimeRange(time_range) # remove time from dates dt = TimeRange(dt.start.strftime('%Y-%m-%d'), dt.end.strftime('%Y-%m-%d')) filenames = [] diff_months = (dt.end.datetime.year - dt.start.datetime.year) * \ 12 + dt.end.datetime.month - dt.start.datetime.month first_month = datetime(dt.start.datetime.year, dt.start.datetime.month, 1) month_list = rrule(MONTHLY, dtstart=first_month, count=diff_months+1) # need to download and inspect the dbase file to determine the filename # for the observing summary data # the dbase files are monthly but contain the daily filenames for this_month in month_list: dbase_file_name, hdrs = self.get_observing_summary_dbase_file(this_month) dbase_dat = parse_observing_summary_dbase_file(dbase_file_name) this_month_obssumm_filenames = dbase_dat.get('filename') daily_filenames_dates = [datetime.strptime( d[0:20], 'hsi_obssumm_%Y%m%d') for d in this_month_obssumm_filenames] for i, this_date in enumerate(daily_filenames_dates): if dt.start <= this_date <= dt.end: filenames.append( get_base_url()+f'metadata/catalog/{this_month_obssumm_filenames[i]}s') return filenames
[docs] @staticmethod def get_observing_summary_dbase_file(time): """ Download the RHESSI observing summary database file for the time given. One file covers an entire month. This file lists the name of observing summary files for specific times. Parameters ---------- time : `str`, datetime Returns ------- value : `tuple` Return a `tuple` (filename, headers) where filename is the local file name under which the object can be found, and headers is whatever the info() method of the object returned by urlopen. Examples -------- >>> from sunpy.net.dataretriever.sources.rhessi import RHESSIClient >>> fname, headers = RHESSIClient.get_observing_summary_dbase_file('2011/04/04') # doctest: +REMOTE_DATA References ---------- | http://hesperia.gsfc.nasa.gov/ssw/hessi/doc/guides/hessi_data_access.htm#Observing Summary Data .. note:: This API is currently limited to providing data from whole days only. """ _time = parse_time(time) if _time < parse_time("2002/02/01"): raise ValueError("RHESSI summary files are not available before 2002-02-01") url = get_base_url() + f'dbase/{_time.strftime("hsi_obssumm_filedb_%Y%m.txt")}' return urlretrieve(url)
[docs] def search(self, *args, **kwargs): _, pattern, matchdict = self.pre_search_hook(*args, **kwargs) timerange = TimeRange(matchdict['Start Time'], matchdict['End Time']) metalist = [] for url in self.get_observing_summary_filename(timerange): exdict = parse(pattern, url).named exdict['url'] = url rowdict = super().post_search_hook(exdict, matchdict) metalist.append(rowdict) return QueryResponse(metalist, client=self)
[docs] @classmethod def register_values(cls): from sunpy.net import attrs adict = {attrs.Instrument: [('RHESSI', 'Reuven Ramaty High Energy Solar Spectroscopic Imager.')], attrs.Physobs: [("summary_lightcurve", "A summary lightcurve.")], attrs.Source: [('RHESSI', 'Reuven Ramaty High Energy Solar Spectroscopic Imager.')], attrs.Provider: [('NASA', 'The National Aeronautics and Space Administration.')]} return adict