Developers guide¶

1. System Overview
   1. Leginon
      1. Scope
      2. Windows Machine
   2. Appion
      1. Web Parts - web server
      2. Python Parts - processing server
      3. 3rd party apps
   3. Clusters
   4. Myami code module diagram
       
2. Development Tools
   1. Redmine
      1. Issue reporting and life-cycle
         1. Issue Workflow Tutorial: A guide to setting the Issue status.
      2. Adding Documentation
   2. Eclipse
   3. SVN
      1. Checking your code into the main trunk
   4. Appion/Leginon Release Versioning
       
3. Languages and Technology
   1. html, css, PHP, Python, Javascript, mySQL
   2. best practices for these
   3. Object Oriented Programming
       
4. Installing Appion for development
   1. Running the code from your sandbox
       
5. Adding a new program to the pipeline
   1. General Insructions
      1. Processing parts (Python)
         1. database access
      2. Web Parts (PHP)
         1. launch page
         2. reporting page
            1. Using basicReport.inc for very simple PHP report pages
         3. database accesss
   2. Adding a refinement method (single and multi model)
      1. Python wrapper for 3rd party programs (Anchi)
      2. Modifications to runJob.py (Christopher)
      3. Uploading results to the databse (Dmitry)
      4. Adding the user interface (Amber)
          
6. Testing
   1. Automated testing
       
7. Error Handling
    
8. Adding pop-up Help
    
9. Where to find help
    
10. Common variables used