developers - coding rules

Coding Rules

The goal of FABLE has to produce code which can treat the TotalCryst scientific problems (peak finding, grain spotting, etc.), efficiently (time consuming processes will be farmed out to a compute cluster) and easy to use. FABLE will adopt software engineering best practices for code development and management. A working document on programming guidelines is now available. Read it and add your pearls of wisdom.

Meditate on these FABLE coding rules.

1. All analysis code must be able to be run from a command line interface
2. All analysis code modules should have a well defined api (no globals please !)
3. Make an effort to specify and document your code on the wiki
4. If you need a routine or user interface and it doesn't exist, extend the fable framework to do it
5. Comment your code following the code commenting guidelines