Changes between Version 51 and Version 52 of RemoteJobs

Timestamp:

Jan 20, 2017, 3:26:26 PM (9 years ago)

Author:

davea

Comment:

--

RemoteJobs

@@ -12 +12 @@
 
 At the bottom level, the interface consists of Web RPCs.
-BOINC provides client-side bindings in PHP and C++.
+BOINC provides client-side bindings in PHP, C++, and Python.
 These bindings differ slightly; they expose different details of the Web RPCs.
 
-As jobs are completed, their output files are available to the submitting user via HTTP.
-When a batch is complete, a zipped archive of all its output files is available via HTTP.
-Details are [RemoteOutputFiles here].
+Interfaces for [RemoteInputFiles staging input files]
+and [RemoteOutputFiles fetching output files] are described separately.
+
+There are various options for managing input files.
+If you use the [RemoteInputFiles#Job-basedfilemanagement Job-based file management],
+which maintains batch/file associations,
+the order of operations is:
+
+ * Create a batch (initially empty); returns the batch ID.
+ * Stage input files, passing the batch ID
+ * Submit jobs, passing the batch ID
+
+If you manage input files a different way,
+then you create the batch and submit jobs in a single API call.
 
 == PHP interface ==
@@ -35 +46 @@
  * '''app_name''': the name of the application for which jobs are being submitted
  * '''batch_name''': a symbolic name for the batch.
-    Need not be unique.
-    If omitted, a name of the form "batch_unixtime" will be used.
+   Need not be unique.
+   If omitted, a name of the form "batch_unixtime" will be used.
  * '''workunit_template_file''': an optional [JobTemplates input template file name].
  * '''result_template_file''': an optional [JobTemplates output template file name].
@@ -454 +465 @@
 struct JOB_STATUS {
     string job_name;
-    string status;              // DONE, ERROR, or IN_PROGRESS
+    string status;           // DONE, ERROR, or IN_PROGRESS
 };
 
@@ -467 +478 @@
 
 The file tools/submit_api.py contains a Python binding of some of above RPCs.
-For examples of its use, se tools/submit_api_test.py.
+For examples of its use, see tools/submit_api_test.py.
 
 To build a description of a batch of jobs,
-use the BATCH_DESC, JOB_DESC, and FILE_DESC objects:
+use the BATCH_DESC, JOB_DESC, and FILE_DESC classes:
 {{{
 def make_batch():
@@ -487 +498 @@
     batch.app_name = "uppercase"
     batch.batch_name = "blah"
+    # or batch_id = n, if you previously created an empty batch.
     batch.jobs = []
 
@@ -498 +510 @@
 You can then pass this to either estimate_batch() or submit_batch():
 {{{
+    from submit_api import *
     batch = make_batch()
     r = estimate_batch(batch)
@@ -533 +546 @@
 }}}
 
-Other available functions include
-{{{
-abort_batch()
-abort_jobs()
-create_batch()
-query_batches()
-query_completed_job()
-query_job()
-get_output_file()
-retire_batch()
-}}}
+Possible attributes of FILE_DESC:
+ * mode
+ * url
+ * nbytes
+ * md5
+ * source
+
+Possible attributes of JOB_DESC:
+ * rsc_fpops
+ * command_line
+ * wu_template
+ * result_template
+ * files (list of FILE_DESC)
+
+Possible attributes of BATCH_DESC:
+ * project (URL of project)
+ * authenticator (submitter's account key)
+ * app_name
+ * batch_id
+ * batch_name
+ * jobs (list of JOB_DESC)
+
+Available functions are listed below.
+Each function takes a request object whose attributes include
+at least project and authenticator.
+
+ abort_batch(req)::
+    req attributes: batch_id
+ abort_jobs(req)::
+    req attributes: jobs (list of job names)
+ create_batch(req)::
+    req attributes: app_name, batch_name, expire_time
+ estimate_batch(req)::
+    req is a BATCH_DESC
+ query_batche(req)::
+    req attributes: batch_id, get_cpu_time
+ query_batches(req)::
+    req attributes_ get_cpu_time
+ query_completed_job(req)::
+    req attributes: job_name
+ query_job(req)::
+    req attributes: job_id
+ get_output_file(req)::
+    req attributes: instance_name, file_num
+ get_output_files(req)::
+    req attributes: batch_id
+ retire_batch(req)::
+    req attributes: batch_id
 
 == HTTP/XML interface ==
@@ -563 +613 @@
 applications and web site.
 
+