HEKClient

class sunpy.net.hek.HEKClient(url='https://www.lmsal.com/hek/her?')[source]

Bases: sunpy.net.base_client.BaseClient

Provides access to the Heliophysics Event Knowledgebase (HEK).

The HEK stores solar feature and event data generated by algorithms and human observers.

Attributes Summary

default

Methods Summary

fetch(*args, **kwargs)

This is a no operation function as this client does not download data.

search(*args, **kwargs)

Retrieves information about HEK records matching the criteria given in the query expression.

Attributes Documentation

default = {'cmd': 'search', 'cosec': '2', 'event_coordsys': 'helioprojective', 'event_type': '**', 'type': 'column', 'x1': -5000, 'x2': 5000, 'y1': -5000, 'y2': 5000}

Methods Documentation

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

This is a no operation function as this client does not download data.

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

Retrieves information about HEK records matching the criteria given in the query expression. If multiple arguments are passed, they are connected with AND. The result of a query is a list of unique HEK Response objects that fulfill the criteria.

Examples

>>> from sunpy.net import attrs as a, Fido
>>> timerange = a.Time('2011/08/09 07:23:56', '2011/08/09 12:40:29')
>>> res = Fido.search(timerange, a.hek.FL, a.hek.FRM.Name == "SWPC")  
>>> res  
<sunpy.net.fido_factory.UnifiedResponse object at ...>
Results from 1 Provider:

2 Results from the HEKClient:
         SOL_standard          active ... skel_startc2 sum_overlap_scores
------------------------------ ------ ... ------------ ------------------
SOL2011-08-09T07:19:00L227C090   true ...         None                  0
SOL2011-08-09T07:48:00L296C073   true ...         None                  0