gme.plotting.gmeplot

Module: gme.plotting.gmeplot

• gme.plotting.plotGME()

gme.plotting.gmeplot.plotGME(gmiList, parameter=None, sTime=None, eTime=None, ymin=None, ymax=None, NoX=False, NoY=False, NoCredit=False, NoLegend=False, legendSize=None)

plot ground magnetic indicies, including AE, SYMH, ASYMH, and DST.

Args:

• gmiList: gmiList object returned from ae.readAe(), symAsy.readSymAsy(), or dst.readDst()
• [parameter]: List of parameters to plot. Valid values are:
  • aeList: [‘ae’, ‘al’, ‘au’, ‘ao’] (Defaults to ‘ae’)
  • symAsyList: [‘symh’, ‘symd’, ‘asymh’, ‘asymd’] (Defaults to ‘symh’)
  • dstList: [‘dst’]
• [sTime]: datetime.datetime object for start of plotting. If not given, earliest data availble from aeList is used.
• [eTime]: datetime.datetime object for end of plotting. If not given, latest data availble from aeList is used.
• [ymin]: Y-Axis minimum limit
• [ymax]: Y-Axis maximum limit
• [NoX]: Suppress X-Axis Titles and Ticks
• [NoY]: Suppress Y-Axis Titles and Ticks
• [NoCredit]: Suppress printing source of data on plot
• [NoLegend]: Suppress a legend if more than one parameter is plotted
• [legendSize]: Character size of the legend

Returns:

• Nothing.

Note

If a matplotlib figure currently exists, it will be modified by this routine. If not, a new one will be created.

Written by Nathaniel Frissell 20130216

gme.plotting.gmeplot

alias of gme.plotting.gmeplot