1. Premise

The purpose of this documentation template is to provide a recommended structure for describing your own work. Doing so is a little more work up front, but this work should pay off in the long run. Writing this documentation should allow other researchers to easily understand the purpose of the software and decide whether they want to use it in their own work and will facilitate conversations with developers about the project requirements and implementation.

Please describe the scientific premise and overall goals of the software in this document. The goal of this document is to communicate the purpose of the software to other researchers who many not know the specifics of this project. Please create section headings and sub-pages as appropriate for the scope and level of detail required to explain the project. You can provide links and references to outside sources as needed.