Project

General

Profile

Developers guide » History » Version 24

Amber Herold, 08/02/2011 10:14 AM

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