= Web services for remote job submission =

job_control.php

== Describing a batch ==

A job is described by
{{{
<job>
   [<command_line>C</command_line>]
   [<input_file>F</input_file>]
   ...
</job>
}}}

C and F are macro-substituted for sweep variables: see below.

A parameter sweep is described by
{{{
<sweep var=foo start=x end=y inc=z>
   [<job>...<job>] or [<sweep>...<sweep>]
</sweep>
}}}

In the body of the sweep,
the string "foo" is macro-substituted with values from x to y with increment z.

A batch of jobs is described by:
{{{
<batch>
   <app>appname</app>
   [<input_template>x</input_template>]
   [<output_template>x</output_template>]
   [<job>...<job>] or [<sweep>...<sweep>]
</batch>
}}}

== Batch runtime estimation ==

Estimates the makespan of a batch.
Input:
{{{
<batch_estimate>
   <authenticator>X</authenticator>
   <batch> ... </batch>
   [<priority>N</priority>]
</batch_estimate>
}}}

Output:
{{{
<estimate>
   <seconds>X</seconds>
</estimate>
}}}

== Submitting a batch ==

Input:
{{{
<batch_submit>
   <authenticator>X</authenticator>
   <batch> ... </batch>
   [<priority>N</priority>]
</batch_submit>
}}}

Output:
{{{
<batch_id>N</batch_id>
}}}

== Querying jobs ==

<query_batch>
   <batch_id>N</batch_id>
</query_batch>

<batch_status>
   <fraction_done>X</fraction_done>
   <completed_jobs>N</completed_jobs>
   <remaining_time>X</remaining_time>
</batch_status>

<query_job>
   <name>X</name>
</query_job>

<job_status>
   <aborted/>
   or
   <unsent/>
   or
   <sent>
   <hostid>N</hostid>
   <userid>M</userid>
</job_status>

== Aborting jobs ==

<abort_batch>
   <batch_id>N</batch_id>
</abort_batch>

== Implementation notes =