RHESSIClient

class sunpy.net.dataretriever.RHESSIClient[source] [edit on github]

Bases: sunpy.net.dataretriever.GenericClient

Provides access to the RHESSI observing summary time series data from the archive 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'))  #doctest: +REMOTE_DATA
>>> results  #doctest: +REMOTE_DATA +ELLIPSIS
<sunpy.net.fido_factory.UnifiedResponse object at ...>
Results from 1 Provider:
<BLANKLINE>
2 Results from the RHESSIClient:
     Start Time           End Time      Source Instrument Wavelength
       str19               str19         str6     str6       str3
------------------- ------------------- ------ ---------- ----------
2016-01-01 00:00:00 2016-01-01 23:59:59 rhessi     rhessi        nan
2016-01-02 00:00:00 2016-01-02 23:59:59 rhessi     rhessi        nan
<BLANKLINE>
<BLANKLINE>

Methods Summary

get_observing_summary_dbase_file(time)

Download the RHESSI observing summary database file for the time given.

get_observing_summary_filename(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.

Methods Documentation

static get_observing_summary_dbase_file(time)[source] [edit on github]

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

Note

This API is currently limited to providing data from whole days only.

get_observing_summary_filename(time_range)[source] [edit on github]

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, TimeRange) – A 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_042.fits']