Appion

h1. Developers guide

# *System Overview*

## Leginon

### Scope

### Windows Machine

## Appion

### Web Parts - web server

### Python Parts - processing server

### 3rd party apps

## Clusters

## "Myami code module diagram":http://emg.nysbc.org/projects/appion/wiki/Myami_code_diagram 

 

# *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

## [[AMI_Eclipse_Quick_Start_Guide|Eclipse]]

## SVN

### Checking your code into the main trunk

## [[Useful shell commands]]

 

# *Languages and Technology*

## html, css, PHP, Python, Javascript, mySQL

## [[Coding standards|best practices for these]] 

## [[Object Oriented Programming]]

 

# *Installing Appion for development*

## Running the code from your sandbox

 

# *Adding a new program to the pipeline*

## General Instructions

### 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)

### [[Adding refine python parts|Python wrapper for 3rd party programs]] (Anchi)

### [[Adding refine runjob|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*

## [[Appion Testing|Automated testing]]

 

# *[[Error Handling]]*

 

# *Adding pop-up Help*

 

# Where to find help

 

# [[Common variables used]]