CDAWEBClient

class sunpy.net.cdaweb.CDAWEBClient[source]

Bases: sunpy.net.base_client.BaseClient

Provides access to query and download from the Coordinated Data Analysis Web (CDAWeb).

Examples

>>> from sunpy.net import Fido, attrs as a
>>> print(a.cdaweb.Dataset)
sunpy.net.cdaweb.attrs.Dataset

Dataset ID.


                    Attribute Name                    Client ...                                   Description
----------------------------------------------------- ------ ... --------------------------------------------------------------------------------
a1_k0_mpa                                             CDAWEB ... LANL 2001 Magnetospheric Plasma Analyzer Key Parameters - Mike Henderson (LANL)
a2_k0_mpa                                             CDAWEB ... LANL 2002 Magnetospheric Plasma Analyzer Key Parameters - Mike Henderson (LANL)
ac_at_def                                             CDAWEB ... ACE Hourly RTN, GSE and J2000 GCI Attitude direction cosines - E. C. Stone (C...
...
wi_strahl0_swe                                        CDAWEB ... Wind Solar Wind Experiment (SWE) strahl detector, ~1/2 sec solar wind electro...
wi_sw_ion_dist_swe_faraday                            CDAWEB ... Faraday Cup orientation and charge flux - Keith Ogilvie (NASA GSFC)
wild2_helio1day_position                              CDAWEB ... Position in heliocentric coordinates from SPDF Helioweb - Natalia Papitashvil...
>>>
>>> res = Fido.search(a.Time('2021/07/01', '2021/07/08'),
...                   a.cdaweb.Dataset('SOLO_L2_MAG-RTN-NORMAL-1-MINUTE')) 
>>> res 
<sunpy.net.fido_factory.UnifiedResponse object at ...>
Results from 1 Provider:

7 Results from the CDAWEBClient:
Source: https://cdaweb.gsfc.nasa.gov/index.html

           Dataset                    Start time               End time
------------------------------- ----------------------- -----------------------
SOLO_L2_MAG-RTN-NORMAL-1-MINUTE 2021-07-01 00:00:29.000 2021-07-01 23:59:30.000
SOLO_L2_MAG-RTN-NORMAL-1-MINUTE 2021-07-02 00:00:29.000 2021-07-02 23:59:30.000
SOLO_L2_MAG-RTN-NORMAL-1-MINUTE 2021-07-03 00:00:29.000 2021-07-03 23:59:30.000
SOLO_L2_MAG-RTN-NORMAL-1-MINUTE 2021-07-04 00:00:29.000 2021-07-04 23:59:30.000
SOLO_L2_MAG-RTN-NORMAL-1-MINUTE 2021-07-05 00:00:29.000 2021-07-05 23:59:30.000
SOLO_L2_MAG-RTN-NORMAL-1-MINUTE 2021-07-06 00:00:29.000 2021-07-06 23:59:30.000
SOLO_L2_MAG-RTN-NORMAL-1-MINUTE 2021-07-07 00:00:29.000 2021-07-07 23:59:30.000

See also

sunpy.net.cdaweb.get_datasets

Find dataset IDs for a given observatory

sunpy.net.cdaweb.get_observatory_groups

Get all observatories avaiable from CDAWeb

Attributes Summary

info_url

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

Methods Summary

fetch(query_results, *, path, downloader, ...)

This enables the user to fetch the data using the client, after a search.

load_dataset_values()

register_values()

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

search(*query, **kwargs)

Search for datasets provided by the Space Physics Data Facility.

Attributes Documentation

info_url

Methods Documentation

fetch(query_results, *, path, downloader, **kwargs)[source]

This enables the user to fetch the data using the client, after a search.

Parameters
  • query_results – Results to download.

  • path (str or pathlib.Path, optional) – Path to the download directory

  • downloader (parfive.Downloader) – The download manager to use.

Returns

parfive.Results – The results object, can be None if wait is False and downloader is not None.

static load_dataset_values()[source]
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(*query, **kwargs)[source]

Search for datasets provided by the Space Physics Data Facility.