Project

General

Profile

Developers guide » History » Version 28

Amber Herold, 08/02/2011 11:43 AM

1 1 Amber Herold
h1. Developers guide
2
3 24 Amber Herold
# *System Overview*
4 7 Amber Herold
## Leginon
5
### Scope
6
### Windows Machine
7
## Appion
8 1 Amber Herold
### Web Parts - web server
9
### Python Parts - processing server
10
### 3rd party apps
11
## Clusters
12 24 Amber Herold
## Myami Code Tree
13 20 Amber Herold
 
14 24 Amber Herold
# *Development Tools*
15 1 Amber Herold
## [[appion:AMI Redmine Quick Start Guide|Redmine]]
16 22 Amber Herold
### Issue reporting and life-cycle
17
#### [[appion:Issue Workflow Tutorial]]: A guide to setting the Issue status.
18 24 Amber Herold
### Adding Documentation
19 27 Amber Herold
## [[AMI_Eclipse_Quick_Start_Guide|Eclipse]]
20 1 Amber Herold
## SVN
21 22 Amber Herold
### Checking your code into the main trunk
22
## Appion/Leginon Release Versioning
23 1 Amber Herold
 
24 24 Amber Herold
# *Languages and Technology*
25 1 Amber Herold
## html, css, PHP, Python, Javascript, mySQL
26 20 Amber Herold
## [[Coding standards|best practices for these]] 
27 28 Amber Herold
## [[Object Oriented Programming]]
28 20 Amber Herold
 
29 24 Amber Herold
# *Installing Appion for development*
30
## Running the code from your sandbox
31 1 Amber Herold
 
32 24 Amber Herold
# *Adding a new program to the pipeline*
33 1 Amber Herold
## General Insructions
34 22 Amber Herold
### Processing parts (Python)
35
#### database access
36
### Web Parts (PHP)
37 1 Amber Herold
#### launch page
38 22 Amber Herold
#### reporting page
39 23 Amber Herold
##### [[Using basicReport.inc]] for very simple PHP report pages
40 22 Amber Herold
#### database accesss
41 4 Neil Voss
## Adding a refinement method (single and multi model)
42 26 Amber Herold
### [[Adding refine python parts|Python wrapper for 3rd party programs]] (Anchi)
43
### [[Adding refine runjob|Modifications to runJob.py]] (Christopher)
44 4 Neil Voss
### [[how to add a new refinement method|Uploading results to the databse]] (Dmitry)
45
### [[Refine_Refactor_documentation|Adding the user interface]] (Amber)
46 22 Amber Herold
 
47 24 Amber Herold
# *Testing*
48 23 Amber Herold
## [[Appion Testing|Automated testing]]
49 22 Amber Herold
 
50 24 Amber Herold
# *[[Error Handling]]*
51 22 Amber Herold
 
52 24 Amber Herold
# *Adding pop-up Help*
53 22 Amber Herold
 
54 6 Amber Herold
# Where to find help
55 1 Amber Herold
 
56
# [[Common variables used]]