Changes between Version 17 and Version 18 of CondorBoinc

Timestamp:

Mar 20, 2013, 11:07:20 PM (12 years ago)

Author:

davea

Comment:

--

CondorBoinc

@@ -80 +80 @@
 The commands are:
 
+=== Specify BOINC project and credentials ===
+{{{
+BOINC_PROJECT <req id> project_url authenticator
+}}}
+Result: NULL or error message
+
+Specify the URL of a BOINC project and the authenticator of
+an account on that project to which requests will be sent.
+
 === Submit a new job batch ===
 {{{
@@ -89 +98 @@
       ...
     ...
-  ALL|<#output files>
-    <filename> ...
+
 Result:
   NULL (success) or <err msg>
@@ -99 +107 @@
    But there is a single set of output filenames.
  * The input <dst filename>s must agree with the app's template.
- * If 'ALL' is given instead of <#output files>,
-   then no filenames will follow.
- * If output filenames are provided, then they must agree with
-   the app's output template.
  * As of now, <dst filename> will always be the filename part
    of <src path>
@@ -120 +124 @@
 {{{
 BOINC_FETCH_OUTPUT <req id> <job name> <dir> <stderr filename>
-    ALL|<#files>
-    <src name> <dst name>
+    <mode: ZIP | ALL | SOME>
+    <#file-specs>
+    <src name> <dst>
     ...
 Result:
@@ -127 +132 @@
 }}}
 
- * <dir> is a directory on the local machine to be used to
-   resolve relative pathnames.
- * <src name> is a filename written by the job
- * <dst name> is a filename on the local machine where the
-   corresponding <src name> file's contents should be written
- * If 'ALL' is given instead of <#files>, then no filenames will follow.
-
+Get the results of a completed job, including some or all of its output files.
 BOINC may replicate jobs to ensure that results are valid.
 One replica, the "canonical instance", is designated as the authoritative result.
-A job can fail for various reasons: e.g. all the instances crash,
-or there is no consensus among the instances,
-or no instances could be dispatched.
-
 If the status is DONE, then the output files of the canonical instance,
 and its stderr output, are fetched.
 <exit status> will be zero in this case.
-
-If the status is ERROR, the BOINC GAHP will look for an instance
+ 
+ * <dir> is a directory on the local machine where output files are placed by default.
+ * If mode is ZIP, then the job must have a single zipped output file.
+   This file is unzipped into the output directory.
+   File specs are then applied to rename or move output files.
+ * If mode is ALL, all the job's output files are fetched.
+   File specs are then applied to rename or move output files.
+ * If mode is SOME, only those output files described by file specs are fetched.
+ * Each file spec consists of <src name> and <dst> is a filename written by the job.
+   <dst> specifies where that file should be placed on the local machine.
+   It may be either:
+  * An absolute path
+  * A relative path, in which case <dir> is prepended.
+    Any directories within <dst> must already exist.
+
+If the status is ERROR, the BOINC GAHP looks for an instance
 for which some information is available (e.g., exit status and stderr output),
-and will return this information.
-If there is no such instance, it will return an error message.
+and returns this information.
+If there is no such instance, it returns an error message.
+(A job can fail for various reasons: e.g. all the instances crash,
+or there is no consensus among the instances,
+or no instances could be dispatched.)
 
 === Abort jobs ===