hamsci_psws.goes.find_flares

hamsci_psws.goes.find_flares(goes_data, window_minutes=60, min_class='X1', sTime=None, eTime=None, tmp_dir='data')[source]

Find flares of a minimum class in a GOES data dict created by read_goes(). This works with 1-minute averaged GOES data.

Classifications are based on the 1-8 Angstrom X-Ray Band for the GOES Spacecraft.[1]

Parameters

  • goes_data (dict) – GOES data dict created by read_goes()

  • window_minutes (Optional[int]) – Window size to look for peaks in minutes. I.E., if window_minutes=60, then no more than 1 flare will be found inside of a 60 minute window.

  • min_class (Optional[str]) – Only flares >= to this class will be reported. Use a format such as ‘M2.3’, ‘X1’, etc.

  • sTime (Optional[datetime.datetime]) – Only report flares at or after this time. If None, the earliest available time in goes_data will be used.

  • eTime (Optional[datetime.datetime]) – Only report flares before this time. If None, the last available time in goes_data will be used.

Returns

flares –

  • time of flares

  • GOES 1-8 Angstrom band x-ray flux

  • Classification of flare

Return type

Pandas dataframe listing:

References

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

Example

sTime = datetime.datetime(2014,1,1) eTime = datetime.datetime(2014,6,30) sat_nr = 15 # GOES15 goes_data = read_goes(sTime,eTime,sat_nr) flares = find_flares(goes_data,window_minutes=60,min_class=’X1’)

Written by Nathaniel Frissell 2014 Sept 09