SRSClient

class sunpy.net.dataretriever.SRSClient[source]

Bases: sunpy.net.dataretriever.client.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

baseurl

A regex string that can match all urls supported by the client.

pattern

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

Methods Summary

fetch(*args, **kwargs)

Download a set of results.

register_values()

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

Attributes Documentation

baseurl = 'ftp://ftp.ngdc.noaa.gov/STP/swpc_products/daily_reports/solar_region_summaries/%Y/%m/%Y%m%dSRS.txt'

A regex string that can match all urls supported by the client.

pattern = '{}/{year:4d}/{month:2d}/{year:4d}{month:2d}{day:2d}SRS.txt'

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

Methods Documentation

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

Download a set of results.

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