Project

General

Profile

Developers guide » History » Version 22

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

1 1 Amber Herold
h1. Developers guide
2
3 7 Amber Herold
Proposed content:
4 20 Amber Herold
 
5 7 Amber Herold
# System Overview
6
## 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 7 Amber Herold
## Clusters
14 20 Amber Herold
 
15
# Development Tools
16
## [[appion:AMI Redmine Quick Start Guide|Redmine]]
17 22 Amber Herold
### Issue reporting and life-cycle
18
#### [[appion:Issue Workflow Tutorial]]: A guide to setting the Issue status.
19
# Adding Documentation
20 20 Amber Herold
## Eclipse
21
## SVN
22 22 Amber Herold
### Checking your code into the main trunk
23
## Appion/Leginon Release Versioning
24 20 Amber Herold
 
25 1 Amber Herold
# Languages and Technology
26
## html, css, PHP, Python, Javascript, mySQL
27
## [[Coding standards|best practices for these]] 
28 20 Amber Herold
 
29
# Installing Appion for development
30 7 Amber Herold
# Myami Code Tree
31 1 Amber Herold
# Running the code from your sandbox
32
 
33
# Adding a new program to the pipeline
34
## 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
#### database accesss
41 4 Neil Voss
## Adding a refinement method (single and multi model)
42
### Python wrapper for 3rd party programs (Anchi)
43
### Modifications to runJob.py (Christopher)
44
### [[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 4 Neil Voss
# Testing
48 22 Amber Herold
 
49 4 Neil Voss
# [[Error Handling]]
50 22 Amber Herold
 
51 4 Neil Voss
# Adding pop-up Help
52 22 Amber Herold
 
53 6 Amber Herold
# Where to find help
54 22 Amber Herold
 
55
# [[Common variables used]]
56 6 Amber Herold
57 1 Amber Herold
h3. [[Appion Testing|Automated testing]]
58
59
60
h3. [[Using basicReport.inc]] for PHP report pages