NOAAIndicesClient#

class sunpy.net.dataretriever.NOAAIndicesClient[source]#

Bases: GenericClient

Provides access to the NOAA solar cycle indices.

Uses the SWPC NOAA archive. This is a fixed dataset so the result is independent of the time range.

Examples

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

1 Results from the NOAAIndicesClient:
Source: https://services.swpc.noaa.gov/json/solar-cycle/observed-solar-cycle-indices.json

 Instrument     Physobs     Source Provider
------------ -------------- ------ --------
NOAA-Indices sunspot number   SIDC     SWPC

Attributes Summary

`info_url`	This should return a string that is a URL to the data server or documentation on the data being served.
`required`

Methods Summary

`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

info_url#

required = {<class 'sunpy.net.attrs.Instrument'> sunpy.net.attrs.Instrument Specifies the Instrument name for the search. Attribute Name ... --------------------------- ... adapt ... aia ... aia ... bcs ... be_continuum ... be_halpha ... bigbear ... c1 ... c2 ... caii ... cds ... celias ... cerrotololo ... chp ... clasp1 ... cook ... costep ... cp ... cryo_nirsp ... dpm ... eis ... eit ... elteide ... epd ... erne ... eui ... eui ... eve ... eve ... film ... five_12_channelmagnetograph ... foxsi ... gbm ... goes ... golf ... gong ... ha2 ... hi_c ... hi_c21 ... hmi ... hxeclipse ... hxt ... imax ... impact ... iris ... isoon ... iss ... ivm ... k_cor ... kpdc ... l1 ... l2 ... lasco ... learmonth ... longwave_lobe_06 ... longwave_lobe_07 ... longwave_slit_06 ... longwave_slit_07 ... lyra ... lyra ... mag ... maunaloa ... mdi ... mees ... mergedgong ... metis ... metis ... meudonspectroheliograph ... mk4 ... nfi_0 ... noaa_indices ... noaa_predict ... norh ... phi ... phi ... phoenix ... phoka ... plastic ... polar ... ptmc ... rhessi ... rhessi ... rpw ... secchi ... shortwave_lobe_06 ... shortwave_lobe_07 ... shortwave_slit_06 ... shortwave_slit_07 ... six_0_ftshg ... sj ... solarftsspectrometer ... solohi ... solohi ... soon ... sot ... sp1 ... sp2 ... spectroheliograph ... spectromagnetograph ... spice ... spice ... srs_table ... stix ... stix ... sufi ... sumer ... sutri ... suvi ... suvi ... swa ... swan ... swap ... swaves ... sxt ... t1_halpha ... t4_cak ... t4_continuum ... t4_gband ... tm_1001 ... tm_1010 ... trace ... udaipur ... unpolarized ... uvcs ... vault_1999 ... vault_2002 ... vault_2014 ... vbi ... virgo ... visp ... vsm ... wbs ... wfi_1 ... wfi_2 ... wfi_3 ... wispr ... x123 ... xrs ... xrt ...}#

Methods Documentation

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.