Changes between Version 5 and Version 6 of RemoteJob


Ignore:
Timestamp:
Sep 9, 2010, 9:23:02 AM (14 years ago)
Author:
Nicolas
Comment:

Split some lines (not finished yet)

Legend:

Unmodified
Added
Removed
Modified
  • RemoteJob

    v5 v6  
    66from a convenient command-line interface.
    77
    8 In the following, we will use the ''scientist'' term to denote the individual who submits and administers the workunits on their workstation through the RBoinc 'client tools'. RBoinc client tools are not to be confused with BOINC clients (i.e. the slaves of the distributed computing architecture); for utmost clarity, we shall prefer the term ''scientist'' and ''scientist workstation'' to indicate the user of the  RBoinc client and their machine.
     8In the following, we will use the ''scientist'' term
     9to denote the individual who submits and administers the workunits
     10on their workstation through the RBoinc 'client tools'.
     11RBoinc client tools are not to be confused with BOINC clients
     12(i.e. the slaves of the distributed computing architecture);
     13for utmost clarity, we shall prefer the term ''scientist'' and ''scientist workstation''
     14to indicate the user of the RBoinc client and their machine.
    915
    1016The system (Perl-based) is in boinc/rboinc/.
     
    4248== Annotating the WU template files ==
    4349
    44 Workunit template files should be marked as RBoinc-enabled at the top. This marks the template as RBoinc-enabled and thus ''scientist-visible'' as an application. This is achieved prepending the following tag to the relevant workunit template:
     50Workunit template files should be marked as RBoinc-enabled at the top.
     51This marks the template as RBoinc-enabled
     52and thus ''scientist-visible'' as an application.
     53This is achieved prepending the following tag
     54to the relevant workunit template:
    4555
    4656{{{
     
    4959}}}
    5060
    51 The ''application'' attribute will be the user-visible name of the application (which may or may not coincide with BOINC application names). The scientist will identify this template through the {{{-app }}} command line switch.
     61The ''application'' attribute will be the user-visible name of the application
     62(which may or may not coincide with BOINC application names).
     63The scientist will identify this template
     64through the {{{-app }}} command line switch.
    5265
    5366
    54 Additionally, input  files in the workunit template are augmented with RBoinc-related settings. In the WU template, each {{{file_ref}}} element should have a child ''rboinc'' element as follows:
     67Additionally, input files in the workunit template are augmented with RBoinc-related settings.
     68In the WU template, each {{{file_ref}}} element should have a child ''rboinc'' element as follows:
    5569
    5670{{{
     
    6781}}}
    6882
    69 The ''parameter_name'' attribute is the command line parameter that will be required by the ''boinc_submit'' command for that file. The argument passed by the scientist on the command line to that parameter will be interpreted as a local file, transferred to the BOINC server, and associated to the given BOINC-handled file (in this case, number 3, with BOINC open name "input.vel").
     83The ''parameter_name'' attribute is the command line parameter
     84that will be required by the ''boinc_submit'' command for that file.
     85The argument passed by the scientist
     86on the command line to that parameter
     87will be interpreted as a local file,
     88transferred to the BOINC server,
     89and associated to the given BOINC-handled file
     90(in this case, number 3, with BOINC open name "input.vel").
    7091
    71 The ''parameter_description'' is a descriptive text returned by the command line client when the scientist requests help for the attributes supported by the given application.
     92The ''parameter_description'' is a descriptive text
     93returned by the command line client
     94when the scientist requests help for the attributes
     95supported by the given application.
    7296
    73 The optional ''optional'' flag specifies whether supplying the given file upon submission is mandatory or not. If not, it will be replaced by a (server-supplied) default file.
     97The optional ''optional'' flag specifies
     98whether supplying the given file upon submission is mandatory or not.
     99If not, it will be replaced by a (server-supplied) default file.
    74100
    75101
     
    77103== Annotating the result template files ==
    78104
    79 Results template files are annotated with RBoinc-specific tags which identify which results should be transferred back to the scientist's workstation. The same tags can be used to build output-input ''chains'', i.e. to automatically submit new workunits as continuations of successfully-completed ones.
     105Results template files are annotated with RBoinc-specific tags
     106which identify which results should be transferred back to the scientist's workstation.
     107The same tags can be used to build output-input ''chains'',
     108i.e. to automatically submit new workunits
     109as continuations of successfully-completed ones.
    80110
    81111The syntax for the results template is as follows:
     
    94124}}}
    95125
    96 The optional ''chain'' attribute indicates that, upon successful WU completion, that output file should be used as a third input file for the next step in the chain. The ''aliases'' attribute (currently unimplemented) allows automatic renaming upon retrieval.
     126The optional ''chain'' attribute indicates that,
     127upon successful WU completion,
     128that output file should be used as a third input file
     129for the next step in the chain.
     130The ''aliases'' attribute (currently unimplemented)
     131allows automatic renaming upon retrieval.
    97132
    98133For details on the chaining mechanism, please see the paper T. Giorgino, M. J. Harvey and G. De Fabritiis, ''Distributed computing as a virtual supercomputer: Tools to run and manage large-scale BOINC simulations'', Comp. Phys. Commun. 181, 1402 (2010).  [[http://boinc.berkeley.edu/rboinc.pdf pdf]]