XRSClient#
- class sunpy.net.dataretriever.XRSClient[source]#
Bases:
GenericClient
Provides access to several GOES XRS files archive.
For older GOES satellites (7 and below), NASA servers are used. For newer GOES satellites (8 and above), NOAA servers are used.
For GOES 8-15, the data is the re-processed science-quality data.
Note
The new science quality data have the scaling factors removed for GOES 8-15 and they are not added to GOES 16 AND 17 data products. This means the peak flux will be different to the older version of the data, such as those collected from the NASA servers.
See the following readmes about these data:
GOES 1 - 7: https://umbra.nascom.nasa.gov/goes/fits/goes_fits_files_notes.txt
Reprocessed 8 - 15: https://www.ncei.noaa.gov/data/goes-space-environment-monitor/access/science/xrs/GOES_1-15_XRS_Science-Quality_Data_Readme.pdf
GOES-R 16 - 17: https://data.ngdc.noaa.gov/platforms/solar-space-observing-satellites/goes/goes16/l2/docs/GOES-R_XRS_L2_Data_Readme.pdf
Examples
>>> from sunpy.net import Fido, attrs as a >>> results = Fido.search(a.Time("2016/1/1", "2016/1/2"), ... a.Instrument.xrs) >>> results <sunpy.net.fido_factory.UnifiedResponse object at ...> Results from 1 Provider: 8 Results from the XRSClient: Source: <8: https://umbra.nascom.nasa.gov/goes/fits 8-15: https://www.ncei.noaa.gov/data/goes-space-environment-monitor/access/science/ 16-17: https://data.ngdc.noaa.gov/platforms/solar-space-observing-satellites/goes/ Start Time End Time ... Provider Resolution ----------------------- ----------------------- ... -------- ---------- 2016-01-01 00:00:00.000 2016-01-01 23:59:59.999 ... NOAA flx1s 2016-01-02 00:00:00.000 2016-01-02 23:59:59.999 ... NOAA flx1s 2016-01-01 00:00:00.000 2016-01-01 23:59:59.999 ... NOAA avg1m 2016-01-02 00:00:00.000 2016-01-02 23:59:59.999 ... NOAA avg1m 2016-01-01 00:00:00.000 2016-01-01 23:59:59.999 ... NOAA flx1s 2016-01-02 00:00:00.000 2016-01-02 23:59:59.999 ... NOAA flx1s 2016-01-01 00:00:00.000 2016-01-01 23:59:59.999 ... NOAA avg1m 2016-01-02 00:00:00.000 2016-01-02 23:59:59.999 ... NOAA avg1m
Attributes Summary
This should return a string that is a URL to the data server or documentation on the data being served.
Methods Summary
post_search_hook
(i, matchdict)Helper function used after
search()
which makes the extracted metadata representable in a query response table.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
- baseurl_new = 'https://www.ncei.noaa.gov/data/goes-space-environment-monitor/access/science/xrs/goes{SatelliteNumber:02d}/{filename_res}-l2-{resolution}_science/%Y/%m/sci_{filename_res}-l2-{resolution}_g{SatelliteNumber:02d}_d%Y%m%d_.*\\.nc'#
- baseurl_old = 'https://umbra.nascom.nasa.gov/goes/fits/%Y/go(\\d){2}(\\d){6,8}\\.fits'#
- baseurl_r = 'https://data.ngdc.noaa.gov/platforms/solar-space-observing-satellites/goes/goes{SatelliteNumber}/l2/data/xrsf-l2-{Resolution}_science/%Y/%m/sci_xrsf-l2-{Resolution}_g{SatelliteNumber}_d%Y%m%d_.*\\.nc'#
- info_url#
- pattern_new = '{}/goes{SatelliteNumber:02d}/{filename_res}-l2-{resolution}_science/{year:4d}/{month:2d}/sci_{filename_res}-l2-{resolution}_g{SatelliteNumber:02d}_d{year:4d}{month:2d}{day:2d}_{}.nc'#
- pattern_old = '{}/fits/{year:4d}/go{SatelliteNumber:02d}{}{month:2d}{day:2d}.fits'#
- pattern_r = '{}/goes/goes{SatelliteNumber:02d}/l2/data/xrsf-l2-{Resolution}_science/{year:4d}/{month:2d}/sci_xrsf-l2-{Resolution}_g{SatelliteNumber:02d}_d{year:4d}{month:2d}{day:2d}_{}.nc'#
Methods Documentation
- post_search_hook(i, matchdict)[source]#
Helper function used after
search()
which makes the extracted metadata representable in a query response table.- Parameters:
- Returns:
rowdict (
OrderedDict
) – An Ordered Dictionary which is used byQueryResponse
to show 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”).
- 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.