Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Core Modules - Modules considered to be critical to the core IGB application
  • Plugins - Modules providing content which expands the functionality of the core IGB application, but which are not required for its basic operation.  Default Plugins - Although many plugins are not required, we choose to enable many plugins by default (e.g. weblinks, bookmarks).  The line between default plugins packaged with IGB and IGB's core modules can be fuzzy since many of the functions provided by the default plugins are very important to our application, and the . This classification system may evolve to eliminate this categoryOptional Plugins - Plugins which are providing useful functionality, but for one reason or another have been deemed to be an opt in feature for users (e.g. ProtAnnot, igb-command-socket)
  • Development Plugins - An opt-in set of potentially incomplete work or functionality not well tested and therefore are available from a development plugin repository not "turned on" by default in IGB

...

Important IGB modules for external developers

  • igb-services-api - An API module containing most of what would be needed by any external contributor.  This is the primary API jar of the project.
  • igb-swing-ext - A Library module which may be needed by contributors interested in leveraging some of the swing components used elsewhere throughout the codebase.
  • common - A Library module which has many useful utilities used frequently in our internal modules. 
  • genometry - A blended Blended module containing much of the data model used in the project. As of this writing, the genometry module needs more work and will in the future be reworked into additional modules, but there is a high likelihood developers contributing significant functionality to the project will need to depend on this module. 
  • genoviz-sdk - A Library Library module containing many custom components built on by IGB for visualization.  Developers working on custom visualizations may have a need to depend on this module. Unlike the above, the Genoviz SDK is managed in a separate repository and has an independent release cycle. See: https://bitbucket.org/lorainelab/genoviz-sdk