| 1 | = Web services for remote job submission = |
| 2 | |
| 3 | job_control.php |
| 4 | |
| 5 | == Describing a batch == |
| 6 | |
| 7 | A job is described by |
| 8 | {{{ |
| 9 | <job> |
| 10 | [<command_line>C</command_line>] |
| 11 | [<input_file>F</input_file>] |
| 12 | ... |
| 13 | </job> |
| 14 | }}} |
| 15 | |
| 16 | C and F are macro-substituted for sweep variables: see below. |
| 17 | |
| 18 | A parameter sweep is described by |
| 19 | {{{ |
| 20 | <sweep var=foo start=x end=y inc=z> |
| 21 | [<job>...<job>] or [<sweep>...<sweep>] |
| 22 | </sweep> |
| 23 | }}} |
| 24 | |
| 25 | In the body of the sweep, |
| 26 | the string "foo" is macro-substituted with values from x to y with increment z. |
| 27 | |
| 28 | A batch of jobs is described by: |
| 29 | {{{ |
| 30 | <batch> |
| 31 | <app>appname</app> |
| 32 | [<input_template>x</input_template>] |
| 33 | [<output_template>x</output_template>] |
| 34 | [<job>...<job>] or [<sweep>...<sweep>] |
| 35 | </batch> |
| 36 | }}} |
| 37 | |
| 38 | == Batch runtime estimation == |
| 39 | |
| 40 | Estimates the makespan of a batch. |
| 41 | Input: |
| 42 | {{{ |
| 43 | <batch_estimate> |
| 44 | <authenticator>X</authenticator> |
| 45 | <batch> ... </batch> |
| 46 | [<priority>N</priority>] |
| 47 | </batch_estimate> |
| 48 | }}} |
| 49 | |
| 50 | Output: |
| 51 | {{{ |
| 52 | <estimate> |
| 53 | <seconds>X</seconds> |
| 54 | </estimate> |
| 55 | }}} |
| 56 | |
| 57 | == Submitting a batch == |
| 58 | |
| 59 | Input: |
| 60 | {{{ |
| 61 | <batch_submit> |
| 62 | <authenticator>X</authenticator> |
| 63 | <batch> ... </batch> |
| 64 | [<priority>N</priority>] |
| 65 | </batch_submit> |
| 66 | }}} |
| 67 | |
| 68 | Output: |
| 69 | {{{ |
| 70 | <batch_id>N</batch_id> |
| 71 | }}} |
| 72 | |
| 73 | == Querying jobs == |
| 74 | |
| 75 | <query_batch> |
| 76 | <batch_id>N</batch_id> |
| 77 | </query_batch> |
| 78 | |
| 79 | <batch_status> |
| 80 | <fraction_done>X</fraction_done> |
| 81 | <completed_jobs>N</completed_jobs> |
| 82 | <remaining_time>X</remaining_time> |
| 83 | </batch_status> |
| 84 | |
| 85 | <query_job> |
| 86 | <name>X</name> |
| 87 | </query_job> |
| 88 | |
| 89 | <job_status> |
| 90 | <aborted/> |
| 91 | or |
| 92 | <unsent/> |
| 93 | or |
| 94 | <sent> |
| 95 | <hostid>N</hostid> |
| 96 | <userid>M</userid> |
| 97 | </job_status> |
| 98 | |
| 99 | == Aborting jobs == |
| 100 | |
| 101 | <abort_batch> |
| 102 | <batch_id>N</batch_id> |
| 103 | </abort_batch> |
| 104 | |
| 105 | == Implementation notes = |
| 106 | |