NRAO Home  >  Green Bank  |  Wiki Topic:    GB > Data > GbtFitsMonitor > GbtFitsMonitorTroubleshooting > GbtFitsMonitorProgrammersManual

Changes | Index | Contents | Search | Statistics | Jump to Topic

• Background Information
• Plugin Creation Overview
  • What do I need to import?
  • How do I declare the class for my plugin?

Background Information

GFM is part of the Sparrow package. To become a developer, you will need to register for a Source Forge account and ask AmyShelton to add you as a developer. Source Forge hosts the repository for Sparrow and hence GFM.

GFM itself was written using the DEAP programming framework. Details on the usage of this framework can be found in the DEAP Programmer's Manual.

One can write plugins to GFM without knowing much about the DEAP programming framework. However, a working knowledge of the DEAP User's Manual is required to take advantage of DEAP's plotting capabilities.

Plugin Creation Overview

This overview shows how one might create a GFM plugin. Plugin files are placed in the gfm/plugins/ directory where represents the backend from which the plugin extracts its data.

What do I need to import?

# DEAP imports
from   document    import Document
from   gui         import DEAPPanel

# Other imports
from   wxPython.wx import *
import plugins

How do I declare the class for my plugin?

For simplistic plugins, use:

class MyPlugin(plugins.GFMPlugin)

For more sophisticated functionality, use:

class MyPlugin(plugins.PlotPlugin)

Note: A PlotPlugin is a GFMPlugin.