RHESSIClient

class sunpy.net.dataretriever.RHESSIClient[source]

Bases: sunpy.net.dataretriever.client.GenericClient

Provides access to the RHESSI observing summary time series data.

Uses this 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, a.Physobs.summary_lightcurve)  
>>> results  
<sunpy.net.fido_factory.UnifiedResponse object at ...>
Results from 1 Provider:

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

Attributes Summary

pattern

A string which is used to extract the desired metadata from urls correctly, using sunpy.extern.parse.parse.

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.

register_values()

This enables the client to register what kind of Attrs it can use directly.

search(*args, **kwargs)

Query this client for a list of results.

Attributes Documentation

pattern = '{}/catalog/hsi_obssumm_{year:4d}{month:2d}{day:2d}_{}'

A string which is used to extract the desired metadata from urls correctly, using sunpy.extern.parse.parse.

Methods Documentation

static get_observing_summary_dbase_file(time)[source]

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')  

References

Note

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

get_observing_summary_filename(time_range)[source]

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'))   
['https://.../hessidata/metadata/catalog/hsi_obssumm_20110404_058.fits']
classmethod register_values()[source]

This enables the client to register what kind of Attrs it can use directly.

Returns

dict – A dictionary with key values of Attrs and the values are a tuple of (“Attr Type”, “Name”, “Description”).

search(*args, **kwargs)[source]

Query this client for a list of results.

Parameters
  • *args (tuple) – sunpy.net.attrs objects representing the query.

  • **kwargs (dict) – Any extra keywords to refine the search.

Returns

A QueryResponse instance containing the query result.