Savu
latest
Introduction
About
Introduction
What is a Process list
What is a Savu plugin
Frequently Asked Questions
How To's
Installation Guide
User Guide
Savu Developer Guide
Plugin Developer Guide
Contributing to Savu on Github
How to generate a Savu Plugin
How to develop a Savu plugin
Example of plugin parameters in yaml format
Key for the plugin parameters in yaml format
YAML format
Plugin templates
Reference
Savu Commands
Savu Config Commands
Plugin Documentation
Framework API
Statistics Documentation
Iterative plugins API
Iterative functionality - developer documentation
Savu pre-run
Tutorials
Training Examples
Savu Confluence Pages
Citations
How to cite Savu software
Savu
Docs
»
Plugin Developer Guide
Edit on GitHub
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
Read the Docs
v: latest
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.