Supported Instruments

ACE

The Space Weather Prediction Center (SWPC) provides several Advanced Composition Explorer (ACE) instrument data sets for use as real-time and historic measurements of the solar wind. This differs from the ACE scientific data, which is available at a greater latency from CDAWeb. Information about these data sets can be found at the SWPC ACE Solar-Wind page.

ACE EPAM

EPAM is the Electron, Proton, and Alpha Monitor onboard ACE.

Supports ACE Electron, Proton, and Alpha Monitor data.

Properties

platform

‘ace’ Advanced Composition Explorer

name

‘epam’ Electron, Proton, and Alpha Monitor

tag

‘realtime’ Real-time data from the Space Weather Prediction Center (SWPC)
‘historic’ Historic data from the SWPC

inst_id

‘’

Note

This is not the ACE scientific data set, which will be available at pysatNASA

Examples

The real-time data is stored by generation date, where each file contains the data for the current day. If you leave download dates empty, though, it will grab today’s file three times and assign dates from yesterday, today, and tomorrow.

epam = pysat.Instrument('ace', 'epam', tag='realtime')
epam.download(start=epam.today())
epam.load(date=epam.today())

Warnings

The ‘realtime’ data contains a changing period of time. Loading multiple files, loading multiple days, the data padding feature, and multi_file_day feature available from the pyast.Instrument object is not appropriate for ‘realtime’ data.

pysatSpaceWeather.instruments.ace_epam.clean(self)[source]: Clean the real-time ACE data using the status flag.

pysatSpaceWeather.instruments.ace_epam.init(self)[source]: Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.ace_epam.load(fnames, tag='', inst_id='')[source]

Load the ACE space weather prediction data.

Parameters

fnamesarray-like: Series, list, or array of filenames.
tagstr: Instrument tag (default=’’).
inst_idstr: ACE instrument ID (default=’’).

Returns

datapandas.DataFrame: Object containing instrument data
metapysat.Meta: Object containing metadata such as column names and units

See also

pysat.instruments.methods.general.load_csv_data

ACE MAG

Supports ACE Magnetometer data.

Properties

platform

‘ace’ Advanced Composition Explorer

name

‘mag’ Magnetometer

tag

‘realtime’ Real-time data from the Space Weather Prediction Center (SWPC)
‘historic’ Historic data from the SWPC

inst_id

‘’

Note

This is not the ACE scientific data set, which will be available at pysatNASA

Examples

The real-time data is stored by generation date, where each file contains the data for the current day. If you leave download dates empty, though, it will grab today’s file three times and assign dates from yesterday, today, and tomorrow.

mag = pysat.Instrument('ace', 'mag', tag='realtime')
mag.download(start=mag.today())
mag.load(date=mag.today())

Warnings

The ‘realtime’ data contains a changing period of time. Loading multiple files, loading multiple days, the data padding feature, and multi_file_day feature available from the pyast.Instrument object is not appropriate for ‘realtime’ data.

pysatSpaceWeather.instruments.ace_mag.clean(self)[source]: Clean real-time ACE data using the status flag.

pysatSpaceWeather.instruments.ace_mag.init(self)[source]: Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.ace_mag.load(fnames, tag='', inst_id='')[source]

Load the ACE space weather prediction data.

Parameters

fnamesarray-like: Series, list, or array of filenames
tagstr: Instrument tag, not used. (default=’’)
inst_idstr: ACE instrument ID, not used. (default=’’)

Returns

datapandas.DataFrame: Object containing instrument data
metapysat.Meta: Object containing metadata such as column names and units

See also

pysat.instruments.methods.general.load_csv_data

ACE SIS

Supports ACE Solar Isotope Spectrometer data.

Properties

platform

‘ace’ Advanced Composition Explorer

name

‘sis’ Solar Isotope Spectrometer

tag

‘realtime’ Real-time data from the Space Weather Prediction Center (SWPC)
‘historic’ Historic data from the SWPC

inst_id

‘’

Note

This is not the ACE scientific data set, which will be available at pysatNASA

Examples

The real-time data is stored by generation date, where each file contains the data for the current day. If you leave download dates empty, though, it will grab today’s file three times and assign dates from yesterday, today, and tomorrow.

sis = pysat.Instrument('ace', 'sis', tag='realtime')
sis.download(start=sis.today())
sis.load(date=sis.today())

Warnings

The ‘realtime’ data contains a changing period of time. Loading multiple files, loading multiple days, the data padding feature, and multi_file_day feature available from the pyast.Instrument object is not appropriate for ‘realtime’ data.

pysatSpaceWeather.instruments.ace_sis.clean(self)[source]: Clean real-time ACE data using the status flag.

pysatSpaceWeather.instruments.ace_sis.init(self)[source]: Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.ace_sis.load(fnames, tag='', inst_id='')[source]

Load the ACE space weather prediction data.

Parameters

fnamesarray-like: Series, list, or array of filenames.
tagstr: Instrument tag, not used. (default=’’)
inst_idstr: ACE instrument ID, not used. (default=’’)

Returns

datapandas.DataFrame: Object containing instrument data
metapysat.Meta: Object containing metadata such as column names and units

See also

pysat.instruments.methods.general.load_csv_data

ACE SWEPAM

Supports ACE Solar Wind Electron Proton Alpha Monitor data.

Properties

platform

‘ace’ Advanced Composition Explorer

name

‘swepam’ Solar Wind Electron Proton Alpha Monitor

tag

‘realtime’ Real-time data from the Space Weather Prediction Center (SWPC)
‘historic’ Historic data from the SWPC

inst_id

‘’

Note

This is not the ACE scientific data set, which will be available at pysatNASA

Examples

The real-time data is stored by generation date, where each file contains the data for the current day. If you leave download dates empty, though, it will grab today’s file three times and assign dates from yesterday, today, and tomorrow.

swepam = pysat.Instrument('ace', 'swepam', tag='realtime')
swepam.download(start=swepam.today())
swepam.load(date=swepam.today())

Warnings

The ‘realtime’ data contains a changing period of time. Loading multiple files, loading multiple days, the data padding feature, and multi_file_day feature available from the pyast.Instrument object is not appropriate for ‘realtime’ data.

pysatSpaceWeather.instruments.ace_swepam.clean(self)[source]: Clean real-time ACE data using the status flag.

pysatSpaceWeather.instruments.ace_swepam.init(self)[source]: Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.ace_swepam.load(fnames, tag='', inst_id='')[source]

Load the ACE space weather prediction data.

Parameters

fnamesarray-like: Series, list, or array of filenames.
tagstr: Instrument tag, not used. (default=’’)
inst_idstr: ACE instrument ID, not used. (default=’’)

Returns

datapandas.DataFrame: Object containing instrument data
metapysat.Meta: Object containing metadata such as column names and units

See also

pysat.instruments.methods.general.load_csv_data

Dst

The Disturbance Storm Time (Dst) Index is a measure of magnetic activity associated with the ring current. The National Geophysical Data Center (NGDC) maintains the current database from which the historic Dst is downloaded. LASP performs the calculates and provides the predicted Dst for the last 96 hours. You can learn more about the Dst Index at the WDC Kyoto Observatory page.

Supports Dst values. Downloads data from NGDC.

Properties

platform: ‘sw’
name: ‘dst’
tag: ‘noaa’ - Historic Dst data coalated by and maintained by NOAA/NCEI ‘lasp’ - Predicted Dst from real-time ACE or DSCOVR provided by LASP
inst_id: ‘’

Note

Will only work until 2057.

This material is based upon work supported by the National Science Foundation under Grant Number 1259508.

Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.

pysatSpaceWeather.instruments.sw_dst.clean(self)[source]: Clean the Dst index, empty function.

pysatSpaceWeather.instruments.sw_dst.download(date_array, tag, inst_id, data_path)[source]

Download the Dst index data from the appropriate repository.

Parameters

date_arrayarray-like or pandas.DatetimeIndex: Array-like or index of datetimes for which files will be downloaded.
tagstr: Instrument tag, used to determine download location.
inst_idstr: Instrument ID, not used.
data_pathstr: Path to data directory.

pysatSpaceWeather.instruments.sw_dst.init(self)[source]: Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_dst.list_files(tag='', inst_id='', data_path='', format_str=None)[source]

List local data files for Dst data.

Parameters

tagstr: Instrument tag, accepts any value from tags. (default=’’)
inst_idstr: Instrument ID, not used. (default=’’)
data_pathstr: Path to data directory. (default=’’)
format_strstr or NoneType: User specified file format. If None is specified, the default formats associated with the supplied tags are used. (default=None)

Returns

filespysat.Files: A class containing the verified available files

pysatSpaceWeather.instruments.sw_dst.load(fnames, tag='', inst_id='')[source]

Load the Dst index files.

Parameters

fnamespandas.Series: Series of filenames
tagstr: Instrument tag string. (default=’’)
inst_idstr: Instrument ID, not used. (default=’’)

Returns

datapandas.DataFrame: Object containing satellite data
pysat.Meta: Object containing metadata such as column names and units

F _10.7

F _10.7 is the 10.7 cm radio solar flux (measured in solar flux units, sfu) [Cortie 1912]. Historic indices, real-time indices, and forecasted indices are available from LASP and the SWPC F107 page.

Supports F10.7 index values. Downloads data from LASP and the SWPC.

Properties

platform

‘sw’

name

‘f107’

tag

‘historic’ LASP F10.7 data (downloads by month, loads by day)
‘prelim’ Preliminary SWPC daily solar indices
‘daily’ Daily SWPC solar indices (contains last 30 days)
‘forecast’ Grab forecast data from SWPC (next 3 days)
‘45day’ 45-Day Forecast data from the Air Force

Examples

Download and load all of the historic F10.7 data. Note that it will not stop on the current date, but a point in the past when post-processing has been successfully completed.

f107 = pysat.Instrument('sw', 'f107', tag='historic')
f107.download(start=f107.lasp_stime, stop=f107.today(), freq='MS')
f107.load(date=f107.lasp_stime, end_date=f107.today())

Note

The forecast data is stored by generation date, where each file contains the forecast for the next three days. Forecast data downloads are only supported for the current day. When loading forecast data, the date specified with the load command is the date the forecast was generated. The data loaded will span three days. To always ensure you are loading the most recent data, load the data with tomorrow’s date.

f107 = pysat.Instrument('sw', 'f107', tag='forecast')
f107.download()
f107.load(date=f107.tomorrow())

Warnings

The ‘forecast’ F10.7 data loads three days at a time. Loading multiple files, loading multiple days, the data padding feature, and multi_file_day feature available from the pyast.Instrument object is not appropriate for ‘forecast’ data.

Like ‘forecast’, the ‘45day’ forecast loads a specific period of time (45 days) and subsequent files contain overlapping data. Thus, loading multiple files, loading multiple days, the data padding feature, and multi_file_day feature available from the pyast.Instrument object is not appropriate for ‘45day’ data.

pysatSpaceWeather.instruments.sw_f107.clean(self)[source]: Clean the F10.7 data, empty function as this is not necessary.

pysatSpaceWeather.instruments.sw_f107.download(date_array, tag, inst_id, data_path, update_files=False)[source]

Download F107 index data from the appropriate repository.

Parameters

date_arrayarray-like: Sequence of dates for which files will be downloaded.
tagstr: Denotes type of file to load.
inst_idstr: Specifies the satellite ID for a constellation.
data_pathstr: Path to data directory.
update_filesbool: Re-download data for files that already exist if True (default=False)

Raises

IOError: If a problem is encountered connecting to the gateway or retrieving data from the repository.

Warning

Only able to download current forecast data, not archived forecasts.

pysatSpaceWeather.instruments.sw_f107.init(self)[source]: Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_f107.list_files(tag='', inst_id='', data_path='', format_str=None)[source]

List local F10.7 data files.

Parameters

tagstr: Instrument tag, accepts any value from tags. (default=’’)
inst_idstr: Instrument ID, not used. (default=’’)
data_pathstr: Path to data directory. (default=’’)
format_strstr or NoneType: User specified file format. If None is specified, the default formats associated with the supplied tags are used. (default=None)

Returns

out_filespysat._files.Files: A class containing the verified available files

pysatSpaceWeather.instruments.sw_f107.load(fnames, tag='', inst_id='')[source]

Load F10.7 index files.

Parameters

fnamespandas.Series: Series of filenames.
tagstr: Instrument tag. (default=’’)
inst_idstr: Instrument ID, not used. (default=’’)

Returns

datapandas.DataFrame: Object containing satellite data.
metapysat.Meta: Object containing metadata such as column names and units.

See also

pysat.instruments.methods.general.load_csv_data

Kp

Kp is a geomagnetic index that reflects the magnitude of geomagnetic disturbances at Earth. Historic, recent (last 30 days), and forecasted values are available from the German Research Centre for Geosciences at Potsdam, GFZ, and the SWPC Kp page.

Supports Kp index values.

Properties

platform

‘sw’

name

‘kp’

tag

‘’ Standard Kp data
‘forecast’ Grab forecast data from SWPC (next 3 days)
‘recent’ Grab last 30 days of Kp data from SWPC

inst_id

‘’

Note

Downloads data from ftp.gfz-potsdam.de or SWPC.

Standard Kp files are stored by the first day of each month. When downloading use kp.download(start, stop, freq=’MS’) to only download days that could possibly have data. ‘MS’ gives a monthly start frequency.

The forecast data is stored by generation date, where each file contains the forecast for the next three days. Forecast data downloads are only supported for the current day. When loading forecast data, the date specified with the load command is the date the forecast was generated. The data loaded will span three days. To always ensure you are loading the most recent data, load the data with tomorrow’s date.

Recent data is also stored by the generation date from the SWPC. Each file contains 30 days of Kp measurements. The load date issued to pysat corresponds to the generation date.

Examples

kp = pysat.Instrument('sw', 'kp', tag='recent')
kp.download()
kp.load(date=kp.tomorrow())

Warnings

The ‘forecast’ and ‘recent’ tags load Kp data for a specific period of time. Loading multiple files, loading multiple days, the data padding feature, and multi_file_day feature available from the pyast.Instrument object is not appropriate for these tags data.

This material is based upon work supported by the National Science Foundation under Grant Number 1259508.

Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.

pysatSpaceWeather.instruments.sw_kp.clean(self)[source]: Clean the Kp, not required for this index (empty function).

pysatSpaceWeather.instruments.sw_kp.download(date_array, tag, inst_id, data_path)[source]

Download the Kp index data from the appropriate repository.

Parameters

date_arrayarray-like or pandas.DatetimeIndex: Array-like or index of datetimes to be downloaded.
tagstr: Denotes type of file to load.
inst_idstr: Specifies the instrument identification, not used.
data_pathstr: Path to data directory.

Raises

Exception: Bare raise upon FTP failure, facilitating useful error messages.

Warning

Only able to download current forecast data, not archived forecasts.

pysatSpaceWeather.instruments.sw_kp.init(self)[source]: Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_kp.list_files(tag='', inst_id='', data_path='', format_str=None)[source]

List local files for the requested Instrument tag.

Parameters

tagstr: Instrument tag, accepts any value from tags. (default=’’)
inst_idstr: Instrument ID, not used. (default=’’)
data_pathstr: Path to data directory. (default=’’)
format_strstr or NoneType: User specified file format. If None is specified, the default formats associated with the supplied tags are used. (default=None)

Returns

filespysat._files.Files: A class containing the verified available files

pysatSpaceWeather.instruments.sw_kp.load(fnames, tag='', inst_id='')[source]

Load Kp index files.

Parameters

fnamespandas.Series: Series of filenames
tagstr: Instrument tag (default=’’)
inst_idstr: Instrument ID, not used. (default=’’)

Returns

datapandas.DataFrame: Object containing satellite data
metapysat.Meta: Object containing metadata such as column names and units

Supported Instruments

ACE

ACE EPAM

Properties

Note

Examples

Warnings

ACE MAG

Properties

Note

Examples

Warnings

ACE SIS

Properties

Note

Examples

Warnings

ACE SWEPAM

Properties

Note

Examples

Warnings

Dst

Properties

Note

F 10.7

Properties

Examples

Note

Warnings

Kp

Properties

Note

Examples

Warnings

F _10.7