Project

General

Profile

Developers guide » History » Revision 24

Revision 23 (Amber Herold, 08/02/2011 10:12 AM) → Revision 24/62 (Amber Herold, 08/02/2011 10:14 AM)

h1. Developers guide 

 Proposed content: 
   
 # *System Overview* System Overview 
 ## Leginon 
 ### Scope 
 ### Windows Machine 
 ## Appion 
 ### Web Parts - web server 
 ### Python Parts - processing server 
 ### 3rd party apps 
 ## Clusters 
 ## Myami Code Tree 
   
 # *Development Tools* Development Tools 
 ## [[appion:AMI Redmine Quick Start Guide|Redmine]] 
 ### Issue reporting and life-cycle 
 #### [[appion:Issue Workflow Tutorial]]: A guide to setting the Issue status. 
 ### # Adding Documentation 
 ## Eclipse 
 ## SVN 
 ### Checking your code into the main trunk 
 ## Appion/Leginon Release Versioning 
   
 # *Languages Languages and Technology* Technology 
 ## html, css, PHP, Python, Javascript, mySQL 
 ## [[Coding standards|best practices for these]]  
   
 # *Installing Installing Appion for development* development 
 ## # Myami Code Tree 
 # Running the code from your sandbox 
   
 # *Adding Adding a new program to the pipeline* pipeline 
 ## General Insructions 
 ### Processing parts (Python) 
 #### database access 
 ### Web Parts (PHP) 
 #### launch page 
 #### reporting page 
 ##### [[Using basicReport.inc]] for very simple PHP report pages 
 #### database accesss 
 ## Adding a refinement method (single and multi model) 
 ### Python wrapper for 3rd party programs (Anchi) 
 ### Modifications to runJob.py (Christopher) 
 ### [[how to add a new refinement method|Uploading results to the databse]] (Dmitry) 
 ### [[Refine_Refactor_documentation|Adding the user interface]] (Amber) 
   
 # *Testing* Testing 
 ## [[Appion Testing|Automated testing]] 
   
 # *[[Error Handling]]* [[Error Handling]] 
   
 # *Adding Adding pop-up Help* Help 
   
 # Where to find help 
   
 # [[Common variables used]]