k_index module

Gets Planetary k-index and geomagnetic storm levels from NOAA SWPC.

class k_index.KIndex

Bases: object

Class for getting Planetary k-index data from NOAA SWPC

get_obs()

Get observed k-index values

Returns:

table of observed k-index time series

Return type:

pandas.DataFrame

get_pred()

Get predicted k-index values

Returns:

table of predicted k-index time series

Return type:

pandas.DataFrame

make_plot()

Make a plot of the k-index

make_summary()

Make a text summary of the recent k-index observations

run()

Get observed and predicted k-index values and make a plot of them

k_index.bar_color(k)

Get color for bar plot of k-index corresponding to NOAA SWPC palette :param k: planetary k-index value :type k: float

Returns:

hex code for corresponding color

Return type:

str

k_index.g_level(k)

Get geomagnetic storm level (G-scale) and plot color corresponding to k-index value :param k: Planetary k-index value :type k: float

Returns:

• g_scale (str): Geomagnetic storm level, e.g. ‘G1’, ‘G2’, etc.

• short_desc (str): Description of storm level, e.g. ‘Minor’, ‘Moderate’, etc.

• color (str): hex color corresponding to NOAA SWPC color palette for storm level

Return type:

tuple