Plugin Developer Guide

• Contributing to Savu on Github
  • Github Savu
    • Set up your Savu Github repository (DO THIS ONCE)
    • Maintain YOUR Savu repository
    • Keep YOUR repository up-to-date with the ORIGINAL
    • Tracking and untracking files
    • Add your changes to the ORIGINAL repository
• How to generate a Savu Plugin
  • savu_plugin_generator
    • Positional Arguments
    • Named Arguments
  • Plugin Documentation
    • Plugin Documentation
• How to develop a Savu plugin
  • Required Files
  • 1. Introduction to creating a Plugin
  • 2. How to create the tools class and documentation
    • Yaml Text
    • Optional fields:
    • Citation Text
    • Document your plugin in restructured text
    • Plugin Documentation
  • 3. How to create a test
    • Test templates
    • Test data
    • Amending the parameters
• Example of plugin parameters in yaml format
  • TomobarRecon
• Key for the plugin parameters in yaml format
  • Key
  • Detailed Key
• YAML format
  • Format examples
  • References
• Plugin templates
  • Plugin Template With Detailed Notes 1
  • Further Examples