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)

Clean the real-time ACE data using the status flag.

pysatSpaceWeather.instruments.ace_epam.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.ace_epam.load(fnames, tag='', inst_id='')

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.

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)

Clean real-time ACE data using the status flag.

pysatSpaceWeather.instruments.ace_mag.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.ace_mag.load(fnames, tag='', inst_id='')

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.

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)

Clean real-time ACE data using the status flag.

pysatSpaceWeather.instruments.ace_sis.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.ace_sis.load(fnames, tag='', inst_id='')

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.

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)

Clean real-time ACE data using the status flag.

pysatSpaceWeather.instruments.ace_swepam.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.ace_swepam.load(fnames, tag='', inst_id='')

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

SW

The Space Weather (SW) platform encompasses space weather indices that may be found across a variety of platforms. Many of the remote centers that provide these data sets include multiple types of data in each file. From pysatSpaceWeather version 0.1.0, the remote information is separated by pysat.Instrument and saved into appropriate files. For example, the definitive Kp data from the German Research Centre for Geosciences at Potsdam (GFZ) will also download Ap and Cp data files.

AE

AE is an auroral electrojet index that reflects the level of magnetic deflection in the auroral zone due to the difference between the eastward and westward electroject currents at Earth. Real-time predictions (last 96 hours) are provided by LASP.

Supports the auroral electrojet AE values.

Properties

platform

‘sw’

name

‘ae’

tag

• ‘lasp’ Predicted AE from real-time ACE or DSCOVR provided by LASP

inst_id

• ‘’

pysatSpaceWeather.instruments.sw_ae.clean(self)

Clean the AE index, empty function.

pysatSpaceWeather.instruments.sw_ae.download(date_array, tag, inst_id, data_path, mock_download_dir=None)

Download the AE 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.

mock_download_dirstr or NoneType

Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were downloaded (default=None)

Raises:

IOError

If the data link has an unexpected format or an unknown mock download directory is supplied.

pysatSpaceWeather.instruments.sw_ae.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_ae.list_files(tag='', inst_id='', data_path='', format_str=None)

List local data files for AE 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_ae.load(fnames, tag='', inst_id='')

Load the AE 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

AL

AL is an auroral electrojet index that reflects the lower envelope, the negative peak of the electroject currents at Earth. Real-time predictions (last 96 hours) are provided by LASP.

Supports the auroral electrojet AL values.

Properties

platform

‘sw’

name

‘al’

tag

• ‘lasp’ Predicted AL from real-time ACE or DSCOVR provided by LASP

inst_id

• ‘’

pysatSpaceWeather.instruments.sw_al.clean(self)

Clean the AL index, empty function.

pysatSpaceWeather.instruments.sw_al.download(date_array, tag, inst_id, data_path, mock_download_dir=None)

Download the AL 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.

mock_download_dirstr or NoneType

Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were downloaded (default=None)

Raises:

IOError

If the data link has an unexpected format or if an unknown mock download directory is supplied.

pysatSpaceWeather.instruments.sw_al.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_al.list_files(tag='', inst_id='', data_path='', format_str=None)

List local data files for AL 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_al.load(fnames, tag='', inst_id='')

Load the AL 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

AU

AU is an auroral electrojet index that reflects the upper envelope, the positive peak of the electroject currents at Earth. Real-time predictions (last 96 hours) are provided by LASP.

Supports the auroral electrojet AU values.

Properties

platform

‘sw’

name

‘au’

tag

• ‘lasp’ Predicted AU from real-time ACE or DSCOVR provided by LASP

inst_id

• ‘’

pysatSpaceWeather.instruments.sw_au.clean(self)

Clean the AU index, empty function.

pysatSpaceWeather.instruments.sw_au.download(date_array, tag, inst_id, data_path, mock_download_dir=None)

Download the AU 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.

mock_download_dirstr or NoneType

Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were downloaded (default=None)

Raises:

IOError

If the data link has an unexpected format or if an unknown mock download directory is supplied.

pysatSpaceWeather.instruments.sw_au.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_au.list_files(tag='', inst_id='', data_path='', format_str=None)

List local data files for AU 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_au.load(fnames, tag='', inst_id='')

Load the AU 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

Ap

Ap is a geomagnetic index that reflects the magnitude of geomagnetic disturbances at Earth but unlike Kp uses a linear scale. Historic, recent (last 30 days), and forecasted values are available from GFZ and the SWPC Forecasts page.

Supports ap index values.

Properties

platform

‘sw’

name

‘ap’

tag

• ‘def’ Definitive ap data from GFZ

• ‘now’ Nowcast ap data from GFZ

• ‘prediction’ Predictions from SWPC for the next 3 days

• ‘forecast’ Forecast data from SWPC (next 3 days)

• ‘recent’ The last 30 days of Ap data from SWPC

• ‘45day’ 45-Day forecast data from the Air Force

inst_id

• ‘’

Note

Downloads data from ftp.gfz-potsdam.de or SWPC. These files also contain Kp data (with the GFZ data additionally containing Cp data), and so the additional data files will be saved to the appropriate data directories to avoid multiple downloads.

The historic definitive and nowcast Kp files are stored in yearly files, with the current year being updated remotely on a regular basis. If you are using historic data for the current year, we recommend re-downloading it before performing your data processing.

The forecast data is stored by generation date, where each file contains the forecast for the next three days, the observed daily Ap from the prior day, and the estimated Ap from the current day. 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 Ap measurements. The load date issued to pysat corresponds to the generation date.

Examples

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

Warnings

The ‘forecast’, ‘recent’, and ‘45day’ tags load Ap 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 this tag data.

pysatSpaceWeather.instruments.sw_ap.clean(self)

Clean the Kp, not required for this index (empty function).

pysatSpaceWeather.instruments.sw_ap.download(date_array, tag, inst_id, data_path, mock_download_dir=None)

Download the Ap 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.

mock_download_dirstr or NoneType

Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were downloaded (default=None)

Raises:

IOError

If an unknown mock download directory is supplied.

Warning

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

pysatSpaceWeather.instruments.sw_ap.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_ap.list_files(tag='', inst_id='', data_path='', format_str=None)

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_ap.load(fnames, tag='', inst_id='')

Load Ap index files.

Parameters:

fnamespandas.Series

Series of filenames

tagstr

Instrument tag (default=’’)

inst_idstr

Instrument ID, not used. (default=’’)

Returns:

resultpandas.DataFrame

Object containing satellite data

metapysat.Meta

Object containing metadata such as column names and units

apo

apo is a linear (half)-hourly, planetary, open-ended, geomagnetic index that reflects the magnitude of geomagnetic disturbances at Earth. It is like Ap but does not have an upper limit. Values from 1995 onwards are available from GFZ.

Supports apo index values.

Properties

platform

‘sw’

name

‘apo’

tag

• ‘now’ Near real-time nowcast apo data from GFZ

inst_id

• ‘30min’ Half-hourly indices

• ‘60min’ Hourly indices

Note

Downloads data from ftp.gfz-potsdam.de

Examples

ap30 = pysat.Instrument('sw', 'apo', tag='now', inst_id='30min')
ap30.download(2009, 1)
ap30.load(yr=2009, doy=1)

pysatSpaceWeather.instruments.sw_apo.clean(self)

Clean the Kp, not required for this index (empty function).

pysatSpaceWeather.instruments.sw_apo.download(date_array, tag, inst_id, data_path, update_files=False, mock_download_dir=None)

Download the apo 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.

update_filesbool

Re-download data for files that already exist if True (default=False)

mock_download_dirstr or NoneType

Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were downloaded (default=None)

Raises:

IOError

If an unknown mock download directory is supplied.

Warning

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

pysatSpaceWeather.instruments.sw_apo.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_apo.list_files(tag='', inst_id='', data_path='', format_str=None)

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_apo.load(fnames, tag='', inst_id='')

Load apo index files.

Parameters:

fnamespandas.Series

Series of filenames

tagstr

Instrument tag (default=’’)

inst_idstr

Instrument ID, not used. (default=’’)

Returns:

resultpandas.DataFrame

Object containing satellite data

metapysat.Meta

Object containing metadata such as column names and units

Cp

Cp is a derivative geomagnetic index that provides a qualitative estimate of the overall level of magnetic activity for the day. The C9 index provides the same information on a scale from 0-9 instead of 0.0-2.5. Historic values are available from GFZ.

Supports Cp index values.

Properties

platform

‘sw’

name

‘cp’

tag

• ‘def’ Definitive Cp data from GFZ

• ‘now’ Nowcast Cp data from GFZ

inst_id

• ‘’

Note

Downloads data from ftp.gfz-potsdam.de (GFZ). These files also contain ap and Kp data, and so the additional data files will be saved to the appropriate data directories to avoid multiple downloads.

The historic definitive and nowcast Cp files are stored in yearly files, with the current year being updated remotely on a regular basis. If you are using historic data for the current year, we recommend re-downloading it before performing your data processing.

Examples

cp_ind = pysat.Instrument('sw', 'cp', tag='def')
cp_ind.download(start=dt.datetime(2010, 1, 1))
cp_ind.load(2010, 1)

pysatSpaceWeather.instruments.sw_cp.clean(self)

Clean the Kp, not required for this index (empty function).

pysatSpaceWeather.instruments.sw_cp.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_cp.load(fnames, tag='', inst_id='')

Load Cp 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

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.

pysatSpaceWeather.instruments.sw_dst.clean(self)

Clean the Dst index, empty function.

pysatSpaceWeather.instruments.sw_dst.download(date_array, tag, inst_id, data_path, mock_download_dir=None)

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. If not None, will process any files with the correct name and date as if they were downloaded.

mock_download_dirstr or NoneType

Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were downloaded. (default=None)

Raises:

IOError

If an unknown mock download directory is supplied.

pysatSpaceWeather.instruments.sw_dst.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_dst.list_files(tag='', inst_id='', data_path='', format_str=None)

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='')

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.

Properties

platform

‘sw’

name

‘f107’

tag

• ‘historic’ LASP F10.7 data (downloads by month, loads by day)

• ‘prelim’ Preliminary SWPC daily solar indices

• ‘now’ A mix of nowcast and definitive values from GFZ

• ‘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

inst_id

• ‘’ No distinction, may include observed, adjusted, or both

• ‘obs’ Observed F10.7

• ‘adj’ Adjusted F10.7

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())
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)

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, mock_download_dir=None)

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)

mock_download_dirstr or NoneType

Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were downloaded (default=None)

Raises:

IOError

If a problem is encountered connecting to the gateway or retrieving data from the remote or local repository.

Warning

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

pysatSpaceWeather.instruments.sw_f107.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_f107.list_files(tag='', inst_id='', data_path='', format_str=None)

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='')

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

Solar Flares

Solar flares have been monitored for decades and the data has been compiled into standard measurements from different data sets. Historic indices, real-time indices, and forecasted indices are available from SWPC.

Supports solar flare values.

Properties

platform

‘sw’

name

‘flare’

tag

• ‘prelim’ Preliminary SWPC daily solar indices

• ‘daily’ Daily SWPC solar indices (contains last 30 days)

• ‘prediction’ Predictions from SWPC for the next 3 days

Examples

Download and load the most recent flare predictions. To always ensure you are loading the most recent data, load the data with tomorrow’s date.

flare = pysat.Instrument('sw', 'flare', tag='prediction')
flare.download(start=flare.tomorrow())
flare.load(date=flare.tomorrow())

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.

Warnings

The ‘prediction’ flare 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 ‘prediction’ data.

pysatSpaceWeather.instruments.sw_flare.clean(self)

Clean the F10.7 data, empty function as this is not necessary.

pysatSpaceWeather.instruments.sw_flare.download(date_array, tag, inst_id, data_path, update_files=False, mock_download_dir=None)

Download solar flare 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)

mock_download_dirstr or NoneType

Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were downloaded (default=None)

Raises:

IOError

If a problem is encountered connecting to the gateway or retrieving data from the remote or local repository.

Warning

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

pysatSpaceWeather.instruments.sw_flare.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_flare.list_files(tag='', inst_id='', data_path='', format_str=None)

List local solar flare 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_flare.load(fnames, tag='', inst_id='')

Load the solar flare 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

Hpo

Hpo is a (half)-Hourly, planetary, open-ended, geomagnetic index that reflects the magnitude of geomagnetic disturbances at Earth. It is like Kp but does not have an upper limit. Values from 1995 onwards are available from GFZ.

Supports Hpo index values.

Properties

platform

‘sw’

name

‘hpo’

tag

• ‘now’ Near real-time nowcast Hpo data from GFZ

inst_id

• ‘30min’ Half-hourly resolution indices

• ‘60min’ Hourly resolution indices

Note

Downloads data from ftp.gfz-potsdam.de

Examples

hp30 = pysat.Instrument('sw', 'hpo', tag='now', inst_id='30min')
hp30.download(2009, 1)
hp30.load(yr=2009, doy=1)

pysatSpaceWeather.instruments.sw_hpo.clean(self)

Clean the Kp, not required for this index (empty function).

pysatSpaceWeather.instruments.sw_hpo.download(date_array, tag, inst_id, data_path, update_files=False, mock_download_dir=None)

Download the Hpo 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.

update_filesbool

Re-download data for files that already exist if True (default=False)

mock_download_dirstr or NoneType

Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were downloaded (default=None)

Raises:

IOError

If an unknown mock download directory is supplied.

Warning

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

pysatSpaceWeather.instruments.sw_hpo.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_hpo.list_files(tag='', inst_id='', data_path='', format_str=None)

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_hpo.load(fnames, tag='', inst_id='')

Load Hpo index files.

Parameters:

fnamespandas.Series

Series of filenames.

tagstr

Instrument tag. (default=’’)

inst_idstr

Instrument ID, not used. (default=’’)

Returns:

resultpandas.DataFrame

Object containing satellite data

metapysat.Meta

Object containing metadata such as column names and units

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 GFZ, and the SWPC Kp page.

Supports Kp index values.

Properties

platform

‘sw’

name

‘kp’

tag

• ‘’ Deprecated, mixed definitive and nowcast Kp data from GFZ

• ‘def’ Definitive Kp data from GFZ

• ‘now’ Nowcast Kp data from GFZ

• ‘prediction’ Predictions from SWPC for the next 3 days

• ‘forecast’ Forecast data from SWPC (next 3 days)

• ‘recent’ The last 30 days of Kp data from SWPC

inst_id

• ‘’

Note

Downloads data from ftp.gfz-potsdam.de or SWPC. These files also contain ap data (with the GFZ data additionally containing Cp data), and so the additional data files will be saved to the appropriate data directories to avoid multiple downloads.

The historic definitive and nowcast Kp files are stored in yearly files, with the current year being updated remotely on a regular basis. If you are using historic data for the current year, we recommend re-downloading it before performing your data processing.

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’, ‘prediction’, 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.

pysatSpaceWeather.instruments.sw_kp.clean(self)

Clean the Kp, not required for this index (empty function).

pysatSpaceWeather.instruments.sw_kp.download(date_array, tag, inst_id, data_path, mock_download_dir=None)

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.

mock_download_dirstr or NoneType

Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were downloaded (default=None)

Raises:

IOError

If an unknown mock download directory is supplied or there is a problem downloading the data.

Warning

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

The ‘’ tag has been deprecated and downloads are no longer supported by the source. Use ‘dep’ or ‘now’ instead.

pysatSpaceWeather.instruments.sw_kp.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_kp.list_files(tag='', inst_id='', data_path='', format_str=None)

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

Warning

The ‘’ tag has been deprecated and local file listing support will be removed in version 0.2.0+

pysatSpaceWeather.instruments.sw_kp.load(fnames, tag='', inst_id='')

Load Kp index files.

Parameters:

fnamespandas.Series

Series of filenames

tagstr

Instrument tag (default=’’)

inst_idstr

Instrument ID, not used. (default=’’)

Returns:

resultpandas.DataFrame

Object containing satellite data

metapysat.Meta

Object containing metadata such as column names and units

Warning

tag ‘’ has been deprecated, will be removed in version 0.2.0+

MgII Core-to-Wing Ratio

The core-to-wing ratio of the solar MgII line is a proxy for solar chromospheric variability. It has been used to extract a precise measurement of solar activity at Earth. The two data sets provided by LASP together provide index values from 1978 through 2020.

Supports the MgII core-to-wing ratio index.

Properties

platform

‘sw’

name

‘mgii’

tag

• ‘composite’ Composite data set of MgII core-to-wing index

• ‘sorce’ SORCE SOLSTICE MgII core-to-wing index

Examples

Download a month of the composite MgII data and load the second day of the month.

stime = dt.datetime(1981, 2, 2)
mgii = pysat.Instrument('sw', 'mgii', tag='composite')
mgii.download(start=stime)
mgii.load(date=stime)

pysatSpaceWeather.instruments.sw_mgii.clean(self)

Clean the MGII data, empty function as this is not necessary.

pysatSpaceWeather.instruments.sw_mgii.download(date_array, tag, inst_id, data_path, mock_download_dir=None)

Download MGII core-to-wing 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 ID for the Instrument (not used).

data_pathstr

Path to data directory.

mock_download_dirstr or NoneType

Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were downloaded. (default=None)

Raises:

IOError

If a problem is encountered connecting to the gateway or retrieving data from the remote or local repository.

pysatSpaceWeather.instruments.sw_mgii.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_mgii.list_files(tag='', inst_id='', data_path='', format_str=None)

List local MGII core-to-wing ratio index 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_mgii.load(fnames, tag='', inst_id='')

Load MGII core-to-wing ratio 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

Polar Cap

Polar cap indices have been developed to provide information about high-latitude conditions and inform ionospheric space weather models. Currently, this Instrument provides absorption predictions from SWPC.

Supports polar cap indexes.

Properties

platform

‘sw’

name

‘polarcap’

tag

• ‘prediction’ Predictions from SWPC for the next 3 days

inst_id

• ‘’

Note

Downloads data from SWPC. These files also contain other data indices, and so the additional data files will be saved to the appropriate data directories to avoid multiple downloads.

The forecast/prediction 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.

Examples

pc = pysat.Instrument('sw', 'polarcap', tag='prediction')
pc.download()
pc.load(date=pc.tomorrow())

Warnings

The ‘prediction’ tag loads polar cap absoprtion predictions 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.

pysatSpaceWeather.instruments.sw_polarcap.clean(self)

Clean the polar cap indexes, not required (empty function).

pysatSpaceWeather.instruments.sw_polarcap.download(date_array, tag, inst_id, data_path, mock_download_dir=None)

Download the polar cap indices 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.

mock_download_dirstr or NoneType

Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were downloaded. (default=None)

Raises:

IOError

If an unknown mock download directory is supplied.

Warning

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

pysatSpaceWeather.instruments.sw_polarcap.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_polarcap.load(fnames, tag='', inst_id='')

Load storm probability 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

Warning

tag ‘’ has been deprecated, will be removed in version 0.2.0+

Solar Magnetic Field

The solar mean field provides a measure of of mean solar magnetic field using full-disk optical observations of the iron line. The first observations were made at Stanford by Scherrer et al..

Supports solar magnetic field values.

Properties

platform

‘sw’

name

‘sbfield’

tag

• ‘prelim’ Preliminary SWPC daily solar indices

• ‘daily’ Daily SWPC solar indices (contains last 30 days)

Examples

Download and load some preliminary solar magnetic field data.

smf = pysat.Instrument('sw', 'sbfield', tag='prelim')
smf.download(start=dt.datetime(2001, 1, 1))
smf.load(date=dt.datetime(2001, 1, 1))

pysatSpaceWeather.instruments.sw_sbfield.clean(self)

Clean the data, empty function as this is not necessary.

pysatSpaceWeather.instruments.sw_sbfield.download(date_array, tag, inst_id, data_path, update_files=False, mock_download_dir=None)

Download solar magnetic field 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)

mock_download_dirstr or NoneType

Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were downloaded. (default=None)

Raises:

IOError

If a problem is encountered connecting to the gateway or retrieving data from the remote or local repository.

Warning

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

pysatSpaceWeather.instruments.sw_sbfield.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_sbfield.list_files(tag='', inst_id='', data_path='', format_str=None)

List local solar magnetic field 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_sbfield.load(fnames, tag='', inst_id='')

Load solar magnetic field 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

Sunspot Number

The Sunspot Number (SSN) is one of the oldest continuously measured solar indices. Currently, this Instrument provides preliminary and daily values from SWPC (for example, here is the forecast page).

Supports Sunspot Number (SSN) and related indices.

Properties

platform

‘sw’

name

‘ssn’

tag

• ‘prelim’ Preliminary SWPC daily solar indices

• ‘daily’ Daily SWPC solar indices (contains last 30 days)

• ‘now’ Nowcast and definitive international sunspot number data from GFZ

Examples

Download and load some preliminary SSN data.

ssn = pysat.Instrument('sw', 'ssn', tag='prelim')
ssn.download(start=dt.datetime(2001, 1, 1))
ssn.load(date=dt.datetime(2001, 1, 1))

pysatSpaceWeather.instruments.sw_ssn.clean(self)

Clean the data, empty function as this is not necessary.

pysatSpaceWeather.instruments.sw_ssn.download(date_array, tag, inst_id, data_path, update_files=False, mock_download_dir=None)

Download solar magnetic field 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)

mock_download_dirstr or NoneType

Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were downloaded. (default=None)

Raises:

IOError

If a problem is encountered connecting to the gateway or retrieving data from the remote or local repository.

Warning

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

pysatSpaceWeather.instruments.sw_ssn.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_ssn.list_files(tag='', inst_id='', data_path='', format_str=None)

List local solar magnetic field 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_ssn.load(fnames, tag='', inst_id='')

Load SSN 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

Storm Probability

Geomagnetic storm predictions are provided by SWPC for global, high-latitude, and mid-latitude regions. SWPC uses the NOAA SW scales, which are explained here.

Supports storm probabilities.

Properties

platform

‘sw’

name

‘stormprob’

tag

• ‘prediction’ Predictions from SWPC for the next 3 days

• ‘forecast’ Grab forecast data from SWPC (next 3 days)

inst_id

• ‘’

Note

Downloads data from SWPC. These files also contain other data indices, and so the additional data files will be saved to the appropriate data directories to avoid multiple downloads.

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.

Examples

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

Warnings

The ‘forecast’ tag loads storm probabilities 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.

pysatSpaceWeather.instruments.sw_stormprob.clean(self)

Clean the Kp, not required for this index (empty function).

pysatSpaceWeather.instruments.sw_stormprob.download(date_array, tag, inst_id, data_path, mock_download_dir=None)

Download the storm probabilities 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.

mock_download_dirstr or NoneType

Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were downloaded. (default=None)

Raises:

IOError

If an unknown mock download directory is supplied.

Warning

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

pysatSpaceWeather.instruments.sw_stormprob.init(self)

Initialize the Instrument object with instrument specific values.

pysatSpaceWeather.instruments.sw_stormprob.load(fnames, tag='', inst_id='')

Load storm probability 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

Warning

tag ‘’ has been deprecated, will be removed in version 0.2.0+