NOAAPredictClient#

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

Bases: GenericClient

Provides access to the NOAA SWPC predicted sunspot Number and 10.7 cm radio flux values.

Uses the SWPC NOAA archive. This is a fixed prediction 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_predict)  
>>> results  
<sunpy.net.fido_factory.UnifiedResponse object at ...>
Results from 1 Provider:

1 Results from the NOAAPredictClient:
Source: https://services.swpc.noaa.gov/json/solar-cycle/predicted-solar-cycle.json

 Instrument     Physobs     Source Provider
------------ -------------- ------ --------
NOAA-Predict sunspot number   ISES     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            ... bcs            ... be_continuum   ... be_halpha      ... bigbear        ... caii           ... cds            ... celias         ... cerrotololo    ... ...            ... vault_1999     ... vault_2002     ... vault_2014     ... virgo          ... vsm            ... wbs            ... wispr          ... x123           ... xrs            ... xrt            ... Length = 108 rows}#

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.