Tools for downloading and reading space-weather data and geomagnetic indices.
This package provides tools to read, process, and analyze several key solar and geomagnetic indices. For each index, the available data sources and the corresponding reader classes are listed below:
- Kp Index:
A global geomagnetic activity index with a 3-hour cadence, ranging from 0 (quiet) to 9 (extremely disturbed). Used to assess geomagnetic storm conditions.
-
Sources & Classes:
- OMNI:
KpOMNI
- SWPC:
KpSWPC
- Niemegk:
KpNiemegk (alias: KpGFZ)
- Ensemble:
KpEnsemble
- BGS:
KpBGS
- SIDC:
KpSIDC
- Combined:
read_kp_from_multiple_models
-
Dst Index:
The Disturbance Storm Time (Dst) index measures the intensity of the Earth's ring current, related to geomagnetic storms. Provided hourly and is negative during storm conditions.
-
Sources & Classes:
- OMNI:
DSTOMNI
- WDC:
DSTWDC
- Combined:
read_dst_from_multiple_models
-
Hp Index:
The Hp30 and Hp60 indices are high-cadence (30-minute and 60-minute) geomagnetic indices provided by GFZ, used for detailed geomagnetic activity studies.
-
Sources & Classes:
- GFZ:
HpGFZ
- Ensemble:
HpEnsemble
- Combined:
read_hp_from_multiple_models
-
F10.7 Index:
The F10.7 solar radio flux index is a daily measure of solar activity (flux density at 10.7 cm), a standard proxy for solar EUV emissions.
-
Sources & Classes:
- OMNI:
F107OMNI
- SWPC:
F107SWPC
- Combined:
read_f107_from_multiple_models
-
SuperMAG electrojet indices:
SME, SML, and SMU describe the auroral electrojet using the SuperMAG ground-magnetometer network at one-minute cadence. Access requires a valid SuperMAG account.
-
Sources & Classes:
-
Substorm-onset events:
Sparse onset catalogues identified from SuperMAG SML or auroral images. The available techniques are Newell, Forsyth/SOPHIE, Ohtani, Frey, and Liou.
-
Sources & Classes:
- SuperMAG:
SubstormsSuperMAG
-
Solar Wind Parameters:
Access to solar wind data (speed, density, magnetic field components) from various spacecraft. Essential for solar-terrestrial interaction studies.
-
Sources & Classes:
- ACE:
SWACE
- DSCOVR:
DSCOVR
- IMAP:
SWIMAP
- OMNI:
SWOMNI
- SWIFT:
SWSWIFTEnsemble
- ENLIL:
SWENLIL_BKG (ambient background runs), SWENLIL_CME (CME simulation runs)
- MIDL:
SWMIDL (merged L1 record from ACE, DSCOVR, WIND and SOHO)
- Combined:
read_solar_wind_from_multiple_models
-
Plasmasphere Density Predictions:
Reader utilities for PAGER plasmasphere density grids and model combined inputs.
- Sources & Classes:
- Density predictions:
PlasmaspherePredictionReader
- Combined inputs:
PlasmasphereCombinedInputsReader
- Density cube container:
PlasmasphereDensityCube
Each index can be accessed via these dedicated reader classes, which handle downloading and read methods.
