SRSClient

class sunpy.net.dataretriever.SRSClient

Bases: GenericClient

Provides access to the NOAA SWPC solar region summary data.

Uses the ftp archive.

Notes

Data pre-1996 is in free-form text, which cannot be parsed by sunpy, and therefore only results from 1996 onwards are returned by this client.

Examples

>>> from sunpy.net import Fido, attrs as a
>>> results = Fido.search(a.Time("2016/1/1", "2016/1/2"),
...                       a.Instrument.soon)  
>>> results  
<sunpy.net.fido_factory.UnifiedResponse object at ...>
Results from 1 Provider:

2 Results from the SRSClient:
       Start Time               End Time        Instrument ... Source Provider
----------------------- ----------------------- ---------- ... ------ --------
2016-01-01 00:00:00.000 2016-01-01 23:59:59.999       SOON ...   SWPC     NOAA
2016-01-02 00:00:00.000 2016-01-02 23:59:59.999       SOON ...   SWPC     NOAA

Attributes Summary

enqueue_file_kwargs
pattern

Methods Summary

register_values()

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

Attributes Documentation

enqueue_file_kwargs = {'passive_commands': ['pasv']}

pattern = 'ftp://ftp.ngdc.noaa.gov/STP/swpc_products/daily_reports/solar_region_summaries/{{year:4d}}/{{month:2d}}/{{year:4d}}{{month:2d}}{{day:2d}}SRS.txt'

Methods Documentation

classmethod register_values()

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”).