hamsci_psws.goes.classify_flare

hamsci_psws.goes.classify_flare(value)

Convert GOES X-Ray flux into a string flare classification. You should use the 1-8 Angstrom band for classification [1] (B_AVG in the NOAA data files).

A 0.001 W/m**2 measurement in the 1-8 Angstrom band is classified as an X10 flare..

This function currently only works on scalars.

Parameters

value – numerical value of the GOES 1-8 Angstrom band X-Ray Flux in W/m^2.

Returns

flare_class – class of solar flare

Return type

string

References

[1] http://www.spaceweatherlive.com/en/help/the-classification-of-solar-flares

Example

flare_class = classify_flare(0.001)

Written by Nathaniel Frissell 2014 Sept 07