Mule User Guide

Who is this guide for?

This guide is designed for a user of the Mule API. It will aim to cover the practical usage of the API, only explaining internal details where absolutely necessary.

A tour of Mule by example

This guide to getting started is intended to be relatively interactive, you should be able to follow along in a python session and try out the examples for yourself.

• The Basics
  • Opening files
  • Header Components
  • Field Objects
  • Manipulation and Writing Out
  • Working with STASHmaster files
  • Working with pp files
  • Conclusion
• Data Operators
  • The principles behind operators
  • Defining an operator
  • Your first operator
  • Multi-field or other operators
  • Provided Operators for LBCs
  • Conclusion
• Creating files from scratch
  • Creating a new file from a template
  • Creating Fields from Scratch
  • Getting Data into the new Field
  • Putting it all Together
  • Conclusion
• Handling Validation/Fixing Broken Files
  • Fixing a file which triggers a fatal validation error
  • Fixing a file which fails validation with warnings
  • Re-casting parts of a UMFile object
  • Problems with Field objects
  • Conclusion