Python interface for space weather indices
Project description
Python interface for space weather indices
This python module interfaces the space weather indices available at https://celestrak.com/SpaceData/. It includes the geomagnetic Ap and Kp indices, both the 3h values and the daily sum/averages. The data also include the solar f10.7 cm radio fluxes, the observed values as well as the 1 AU adjusted values, daily values and the 81-day running means. The data sources and file format are described at http://celestrak.com/SpaceData/SpaceWx-format.php (see file_format.txt for a local copy of the format description).
:warning: This package is in alpha stage, that is, it may or may not work, and the interface might change in future versions.
Install
Requirements
numpy
- requiredpytest
- optional, for testing
pyspaceweather
As binary package support is limited, pyspaceweather can be installed
with pip
directly from github
(see https://pip.pypa.io/en/stable/reference/pip_install/#vcs-support
and https://pip.pypa.io/en/stable/reference/pip_install/#git):
$ pip install [-e] git+https://github.com/st-bender/pyspaceweather.git
The other option is to use a local clone:
$ git clone https://github.com/st-bender/pyspaceweather.git
$ cd pyspaceweather
and then using pip
(optionally using -e
, see
https://pip.pypa.io/en/stable/reference/pip_install/#install-editable):
$ pip install [-e] .
or using setup.py
:
$ python setup.py install
Optionally, test the correct function of the module with
$ py.test [-v]
or even including the doctests in this document:
$ py.test [-v] --doctest-glob='*.md'
Usage
The python module itself is named spaceweather
and is imported as usual.
This module provides mainly two functions sw_daily()
for the daily data
as available from the website, and ap_kp_3h()
for the 3h Ap and Kp values.
Both functions return pandas.DataFrame
s.
The index file will be downloaded locally on the first run.
>>> import spaceweather as sw
>>> df_d = sw.sw_daily()
>>> df_d.loc["2000-01-01"].Apavg
30.0
>>> df_3h = sw.ap_kp_3h()
>>> df_3h.loc["2000-01-01 01:30:00"]
Ap 56.0
Kp 5.3
Name: 2000-01-01 01:30:00, dtype: float64
>>> # All 3h values for one day
>>> df_3h.loc["2000-01-01"]
Ap Kp
2000-01-01 01:30:00 56 5.3
2000-01-01 04:30:00 39 4.7
2000-01-01 07:30:00 27 4.0
2000-01-01 10:30:00 18 3.3
2000-01-01 13:30:00 32 4.3
2000-01-01 16:30:00 15 3.0
2000-01-01 19:30:00 32 4.3
2000-01-01 22:30:00 22 3.7
Basic class and method documentation is accessible via pydoc
:
$ pydoc spaceweather
License
This python interface is free software: you can redistribute it or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2 (GPLv2), see local copy or online version.
The original data can be found at https://celestrak.com/SpaceData/ and is included with kind permission from Dr. T.S. Kelso at celestrak, for details see the included COPYING.data file.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for spaceweather-0.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9711cd9ad00d91fd87256ed7fc8a19a38b26d0e4640d81023da625faec784f78 |
|
MD5 | 011ebd006145fb3edaee0ca80518034b |
|
BLAKE2b-256 | 7f58ffda3b006516fd85cbb89b09f0163b8d336bcdc759b9aae1d78a7939c972 |