ProCKSI

= Data Management and Representation =

== Definitions ==

 * '''User''' (to be implemented in the future):

   * Represented by a unique email-address

   * Authentication to gain access to user data (requests, personalised settings)

   * Manage multiple requests

 * '''Request''':

   * Unique handle for the combination of a dataset, tasks, and request parameters

   * Request parameters: e.g. request description, settings for notification by email

 * '''Task''':

   * Something to be performed with the given dataset[[br]]

     e.g. calculation of PDB structure pictures (1D), or comparison of pairs of proteins with a given similarity method (2D)

   * Task parameters: e.g. parameters for each comparison method, output parameters for picture generation, ...

 * '''Job''':

   * Everything that lives in a queue[[br]]

     e.g. local queue (ProCKSI cluster), remote queue (University cluster), external queue (web service, grid)

   * Currently, a job is equal to a task:[[br]]

     e.g. task = pairwise comparison of the proteins in the ''entire'' dataset with ''several'' given similarity methods[[br]]

     jobs = ''separate'' jobs calculating all pairwise comparisons of the entire dataset with ''one'' similarity method

   * Future plans:[[br]]

     Divide 3D problem space into subsets of datasets and methods, each subset being an independent job[[br]]

     See next section for further details on the ''3D Problem Space''

 * '''Dataset''':

   * Currently: Collection of PDB structures, previously calculated similarity matrices 

   * Future plans: Previously calculated similarity matrices should be uploaded in a post-processing step, not in a pre-processing step (ticket:28)

 * '''Results''':

   * Currently, entire similarity matrices of different sources 

   * Future plans: Generate similarity matrices directly from single pairwise comparison results stored in the database

== The 3D Problem and Solution Spaces ==

 * '''Problem Space''':[[br]]

   The problem space for an all-against-all comparison of a dataset of P protein structures using M different similarity comparison methods can be represented a 3D cube: [[br]]

   x: Dataset: list of proteins[[br]]

   y: Dataset: list of proteins[[br]]

   z: Tasks: list of similarity comparison methods

 * '''Partitionig the Problem Space''':[[br]]

   For a most efficient calculation of all cells in the 3D problem space, it can be subdivided into sub-cubes, which are called jobs when placed into the queue of a queing system. Examples:[[br]]

   a. Comparison of ''one pair of proteins'' using ''one method'' in the task list => PxPxM jobs, each performing 1 comparison

   b. All-against-all comparison of the ''entire dataset'' with ''one one method'' => M jobs, each performing PxP comparisons

   c. Comparison of ''one pair of proteins'' using ''all methods'' in the task list => PxP jobs, each performing M comparisons

   d. Intelligent partitioning of the 3D problem space, comparing a subset of proteins with a subset of methods

 * '''Solution Space''':[[br]]

   Each similarity comparison ''methods'' can provide several similarity ''measures''[[br]]

   For one slice in the 3D problems space using one particular method, we might get several slices in the 3D solution space providing several measures

 * '''Special Cases''':[[br]]

   The 3D problem space is reduced to a 2D problem space (1xPxM) when using methods that to not compare pairs of proteins but work on one single protein, e.g. calculating the PDB picture, or getting additional data from the iHOP web service.      

== Lifecycle of Requests ==

A new request is submitted in the browser:[[br]]

 * the request is registered in the database, request parameters, the dataset (structures and matrices) and user tasks are added[[br]]

   Request Status: P = prepared[[br]]

The ''cron'' administrational tools check the status of all tasks periodically:[[br]]

 * As soon as the first task has started (R), the request is said to be ''running'' and the status of the request is changed in the database.[[br]]

   Request Status: R = running

 * As soon as the last task has finished successfully (F) or with errors (E), the request is said to have ''finished'' and its status is changed in the database. The user gets a nofification email if requested.[[br]]

   Request Status: F = finished

 * If a request has finished, and the expiration date (soft limit) has been exceeded, the request is said to have ''expired'' and its status is changed in the database. The user gets a nofification email if requested.[[br]]

   Request Status: X = Expired

 * If a request has been expired and the deletion date (hard limit) has been exceeded, the complete requeste including all tasks and data is deleted from the database and hard disk. The user gets a nofification email if requested.

== Lifecycle of Tasks ==

'''Attention:''' Currently, a ''Job'' equals a ''Task''.

A new request is submitted in the browser:[[br]]

 * ProCKSI's main scheduler is always registered as the "Root Task" into the database[[br]] 

   Status of Root Task: P = prepared

 * All ''User Tasks'', which the user has selected to be performed, are prepared and registered into the database.[[br]] 

   Status of User Tasks: P = prepared

 * The ''Root Task'' is submitted to the queing system.[[br]]

   Status of Root Task: Q = Queued

The queing system automatically starts the tasks according to the order in which they were queued:[[br]]

 * As soon as the ''Root Task'' starts, it changes its own status in the database, analyses all ''User Tasks'', partitions the 3D problem space into sub-cubes, and submits these to the queing system.[[br]]

   Status of Root Task:  R = Running

   Status of User Tasks: Q = Queued

 * As soon as a ''User Task'' starts, it changes its own status in the database, and performs its calculations

   Status of User Task: R = Running

 * As soon as any task finishes, it changes its own status in the database[[br]]

   Task Status: C = Completed

The ''cron'' administrational tools check the status of tasks periodically:[[br]]

 * If a ''Task'' has been completed, its results are post-processed (e.g. registered in the database), and the status of the task is changed in the database, and an expiration and deletion date is set. The user gets a nofification email if requested.[[br]]

   Task Status: F = Finished (successfully)

 * In case that there have occured any serious problems, the status of the task is changed in the database accordingly.[[br]]

   Task Status; E = Errors

== Task and Job Dependencies ==

 * Some tasks must have finished successfully before a dependent task can be started:[[br]]

   e.g. ''Contacts'' must have been calculated before ''USM'' and ''MaxCMO'' similarities can be calculated