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
This should return a string that is a URL to the data server or documentation on the data being served.
Methods Summary
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 ... bcs ... be_continuum ... be_halpha ... bigbear ... caii ... cds ... celias ... cerrotololo ... chp ... cook ... costep ... cp ... dpm ... eis ... eit ... elteide ... erne ... 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 ... lasco ... learmonth ... longwave_lobe_06 ... longwave_lobe_07 ... longwave_slit_06 ... longwave_slit_07 ... lyra ... lyra ... maunaloa ... mdi ... mees ... mergedgong ... meudonspectroheliograph ... mk4 ... noaa_indices ... noaa_predict ... norh ... phoenix ... phoka ... plastic ... ptmc ... rhessi ... rhessi ... secchi ... shortwave_lobe_06 ... shortwave_lobe_07 ... shortwave_slit_06 ... shortwave_slit_07 ... six_0_ftshg ... sj ... solarftsspectrometer ... solohi ... soon ... sot ... sp1 ... sp2 ... spectroheliograph ... spectromagnetograph ... spice ... srs_table ... sufi ... sumer ... sutri ... suvi ... suvi ... swan ... swap ... swaves ... sxt ... t1_halpha ... tm_1001 ... tm_1010 ... trace ... udaipur ... uvcs ... vault_1999 ... vault_2002 ... vault_2014 ... virgo ... vsm ... wbs ... 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.