- Installation guide
- Example workflow
- Users guide
- Configuration topics
- Developing Roddy
- Plugin development
- Plugin developers guide
- Workflow development primer
- 1. Setup a plugins folder
- 2. Prepare the plugin folder
- 3. Create the first files and folders
- 4. Create the src folder and the inital java package
- 5. Create a workflow class
- 6. Create your analysis XML file
- 7. Extend the workflow
- 8. Create the first script
- 9. Create a new properties file for Roddy
- 10. Last steps
- Command code block
- JVM plugins
- Brawl plugins
- Native plugins
- A How-To to Roddy Job scripts
The Roddy WMS¶
What is Roddy¶
Roddy is a framework for development and management of script based workflows on a batch processing cluster.
You can find the Roddy source code and its releases on our GitHub project site
Key Features¶
Roddy has several key features which make it a good choice to be used as a base for workflows:
- Multi-Level configuration system
- Modular application design
- A variety of supported workflows
- Access to several cluster backends
- Callable stand-alone or integratable in other applications
- Different versions of plugins/workflows and the Roddy core application are handled in a single installation
- Only a few dependencies and no database for the Roddy core application necessary
- Various execution modes to support users to get their work done faster
The multi-layer configuration system and the handling of plugin versions make Roddy particularly well suited for multi-user, multi-project environments.
Where to start?¶
Take a look at the example workflow package: Example workflow
Do you want to use it to run existing workflows? Then head over to the Users guide
Do you want to develop it? See the Developers guide
Do you want to develop workflows with it? Open up the Plugin developers guide
Do you have questions? Please visit the F.A.Q. section in our GitHub Wiki
License and associated projects¶
Roddy is offered under and MIT based license.
We extracted two possibly helpful open source libraries, again under MIT license:
- RoddyToolLib is a Java / Groovy library which provides several tools used in BatchEuphoria and Roddy. See the project description for more information.
- BatchEuphoria is a Java / Groovy library designed to offer easy access to cluster systems. Currently supported are PBS, SGE and LSF Rest