Changes between Version 28 and Version 29 of client_user_guide

Show
Ignore:
Timestamp:
08/07/13 17:50:47 (11 years ago)
Author:
piontek
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • client_user_guide

    v28 v29  
    5858Set of tools allowing to submit/control tasks and to reserve/control resources managed by the QCG infrastructure. 
    5959 
    60 === qcg-cancel === 
     60Submission and controlling of tasks: 
     61* qcg-cancel - cancel task(s) 
     62* qcg-clean - clean the working directories of given tasks 
     63* qcg-connect - connect interactive session to the task 
     64* qcg-info - display detailed information about the given tasks 
     65* qcg-list - lists tasks in the system 
     66* qcg-peek - display ending of (stdout, stderr) streams 
     67* qcg-proxy - create user proxy certificate 
     68* qcg-refetch - try to copy once again output files/directories 
     69* qcg-refresh_proxy - refresh user proxy certificate for given tasks 
     70* qcg-sub - submit the task to be processes by QCG services 
    6171 
    62 {{{ 
    63 Cancel task(s) 
    64   
    65 usage: qcg-cancel [-h] [-v]   JOBID[/TASKID] [JOBID[/TASKID]] ... 
    66 usage: qcg-client cancel_task [-h] [-v]   JOBID[/TASKID] [JOBID[/TASKID]] ... 
    67   
    68 Options: 
    69  -h,--help      display help message 
    70  -v,--version   display version 
    71   
    72 Arguments: 
    73  JOBID  identifier of the job 
    74  TASKID optional identifier of the task 
    75                 The default identifier of task is 'task' 
    76 }}} 
     72Resources reservation and controll: 
     73* qcg-rcancel - cancel reservation(s) 
     74* qcg-reserve - reserve resources 
     75* qcg-rinfo - display information about the given reservation(s) 
     76* qcg-rlist - list reservation in the system 
    7777 
    78 === qcg-clean === 
    79 {{{ 
    80 Clean task(s). Remove working directory 
    81   
    82 usage: qcg-clean [-h] [-v]   JOBID[/TASKID] [JOBID[/TASKID]] ... 
    83 usage: qcg-client clean_task [-h] [-v]   JOBID[/TASKID] [JOBID[/TASKID]] ... 
    84   
    85 Options: 
    86  -h,--help      display help message 
    87  -v,--version   display version 
    88   
    89 Arguments: 
    90  JOBID  identifier of the job 
    91  TASKID optional identifier of the task 
    92                 The default identifier of task is 'task' 
    93 }}} 
    94  
    95 === qcg-connect === 
    96 {{{ 
    97 Connect to the task. Open interactive terminal in the working directory of the task 
    98   
    99 usage: qcg-connect [-h] [-v]   JOBID[/TASKID] 
    100 usage: qcg-client connect_to_tasks [-h] [-v]   JOBID[/TASKID] 
    101   
    102 Options: 
    103  -h,--help      display help message 
    104  -v,--version   display version 
    105   
    106 Arguments: 
    107  JOBID  identifier of the job 
    108  TASKID optional identifier of the task 
    109                 The default identifier of task is 'task' 
    110 }}} 
    111  
    112 === qcg-info === 
    113 {{{ 
    114 Display information about task(s) 
    115   
    116 usage: qcg-info [-d] [-h] [-v]   JOBID[/TASKID] [JOBID[/TASKID]] ... 
    117 usage: qcg-client task_info [-d] [-h] [-v]   JOBID[/TASKID] [JOBID[/TASKID]] ... 
    118   
    119 Options: 
    120  -d,--description   display user's job description 
    121  -h,--help          display help message 
    122  -v,--version       display version 
    123   
    124 Arguments: 
    125  JOBID  identifier of the job 
    126  TASKID optional identifier of the task 
    127                 The default identifier of task is 'task' 
    128 }}} 
    129  
    130 === qcg-list === 
    131 {{{ 
    132 Display information about tasks 
    133   
    134 usage: qcg-list [-C <period>] [-h] [-n <NOTE>] [-N] [-p <PURGED>] [-R] [-S <period>] [-s <status(es)>] [-v] 
    135 usage: qcg-client get_tasks [-C <period>] [-h] [-n <NOTE>] [-N] [-p <PURGED>] [-R] [-S <period>] [-s <status(es)>] [-v] 
    136   
    137 Options: 
    138  -C,--changed <period>                           changed in the period of time (not supported yet) 
    139  -h,--help                                       display help message 
    140  -n,--note <NOTE>                              list elements with the given note 
    141  -N,--no-list                                    do not display list 
    142  -p,--purged <PURGED>                            display whether the working directory is purged or 
    143                                                  not (PURGED=true|false). 
    144  -R,--report                                     display summary report. 
    145  -S,--submitted <period>                         submited in the period of time. If the status is 
    146                                                  defined the default value of the period is 1 day. 
    147  -s,--status <status(es)>                        status(es) of the job. Lack of this option is 
    148                                                  equivalent to requesting unterminated activities. 
    149  -v,--version                                    display version 
    150 }}} 
    151  
    152 === qcg-peak === 
    153 {{{ 
    154 Peek the output file(s) 
    155   
    156 usage: qcg-peek [-c <NUMBER>] [-f <FILE>] [-h] [-v]   JOBID[/TASKID] [JOBID[/TASKID]] ... 
    157 usage: qcg-client peek_output [-c <NUMBER>] [-f <FILE>] [-h] [-v]   JOBID[/TASKID] [JOBID[/TASKID]] ... 
    158   
    159 Options: 
    160  -c,--characters <NUMBER>   number of characters 
    161  -f,--file <FILE>           file to peek 
    162  -h,--help                  display help message 
    163  -v,--version               display version 
    164   
    165 Arguments: 
    166  JOBID  identifier of the job 
    167  TASKID optional identifier of the task 
    168                 The default identifier of task is 'task' 
    169 }}} 
    170  
    171 === qcg-proxy === 
    172 {{{ 
    173 Create user proxy 
    174   
    175 usage: proxy_init [-h] [-v] 
    176   
    177 Options: 
    178  -h,--help      display help message 
    179  -v,--version   display version 
    180 }}} 
    181  
    182 === qcg-refetch === 
    183 {{{ 
    184 Refetch output files 
    185   
    186 usage: qcg-refetch [-h] [-v]   JOBID[/TASKID] [JOBID[/TASKID]] ... 
    187 usage: qcg-client stage_out [-h] [-v]   JOBID[/TASKID] [JOBID[/TASKID]] ... 
    188   
    189 Options: 
    190  -h,--help      display help message 
    191  -v,--version   display version 
    192   
    193 Arguments: 
    194  JOBID  identifier of the job 
    195  TASKID optional identifier of the task 
    196                 The default identifier of task is 'task' 
    197 }}} 
    198  
    199 === qcg-refresh_proxy === 
    200 {{{ 
    201 Refresh proxy for the given job(s) 
    202   
    203 usage: qcg-client refresh_proxy [-h] [-v]   JOBID [JOBID] ... 
    204   
    205 Options: 
    206  -h,--help      display help message 
    207  -v,--version   display version 
    208   
    209 Arguments: 
    210  JOBID  identifier of the job 
    211 }}} 
    212  
    213 === qcg-sub === 
    214 {{{ 
    215 Submit job(s) to the QCG infrastructure 
    216   
    217 usage: qcg-sub [-D <DIRECTIVE>] [-h] [-I] [-J | -S | -X] [-R <NUMBER>]  [-v]   FILE [FILE] ... 
    218 usage: qcg-client submit_job [-D <DIRECTIVE>] [-h] [-I] [-J | -S | -X] [-R <NUMBER>]  [-v]   FILE [FILE] ... 
    219   
    220 Options: 
    221  -D,--directive <DIRECTIVE>   adds #QCG directives to the description 
    222  -h,--help                    display help message 
    223  -I,--interactive             Interactive mode 
    224  -J,--jsdl                    JSDL dialect 
    225  -R,--repeat <NUMBER>         repeat submission (only for testing) 
    226  -S,--simple                  QCG Simple dialect 
    227  -v,--version                 display version 
    228  -X,--xml                     QCG XML dialect 
    229 }}} 
    230  
    231 === qcg-rcancel === 
    232 {{{ 
    233 Cancel reservation(s) 
    234   
    235 usage: qcg-rcancel [-h] [-v]   RESID [RESID] ... 
    236 usage: qcg-client cancel_reservation [-h] [-v]   RESID [RESID] ... 
    237   
    238 Options: 
    239  -h,--help      display help message 
    240  -v,--version   display version 
    241   
    242 Arguments: 
    243  RESID  identifier of the reservation 
    244 }}} 
    245  
    246 === qcg-reserve === 
    247 {{{ 
    248 Create reservation(s) 
    249   
    250 usage: qcg-reserve [-h] [-J | -S | -X]  [-v]   FILE [FILE] ... 
    251 usage: qcg-client create_reservation [-h] [-J | -S | -X]  [-v]   FILE [FILE] ... 
    252   
    253 Options: 
    254  -h,--help      display help message 
    255  -J,--jsdl      JSDL dialect 
    256  -S,--simple    QCG Simple dialect 
    257  -v,--version   display version 
    258  -X,--xml       QCG XML dialect 
    259   
    260 Arguments: 
    261  FILE   Path to file with job description 
    262 }}} 
    263  
    264 === qcg-rinfo === 
    265 {{{ 
    266 Display information about the given reservation(s) 
    267   
    268 usage: qcg-rinfo [-d] [-D] [-h] [-v]   RESID [RESID] ... 
    269 usage: qcg-client reservation_info [-d] [-D] [-h] [-v]   RESID [RESID] ... 
    270   
    271 Options: 
    272  -d,--description       display user's job description 
    273  -D,--qcg_description   display QCG job description 
    274  -h,--help              display help message 
    275  -v,--version           display version 
    276   
    277 Arguments: 
    278  RESID  identifier of the reservation 
    279 }}} 
    280  
    281 === qcg-rlist === 
    282 {{{ 
    283 Display information about reservations 
    284   
    285 usage: qcg-rlist [-C <period>] [-h] [-n <NOTE>] [-N] [-R] [-S <period>] [-s <status(es)>] [-v] 
    286 usage: qcg-client get_reservations [-C <period>] [-h] [-n <NOTE>] [-N] [-R] [-S <period>] [-s <status(es)>] [-v] 
    287   
    288 Options: 
    289  -C,--changed <period>                           changed in the period of time (not supported yet) 
    290  -h,--help                                       display help message 
    291  -n,--note                                       list elements with the given note 
    292  -N,--no-list                                    do not display list 
    293  -R,--report                                     display summary report. 
    294  -S,--submitted <period>                         submited in the period of time. If the status is 
    295                                                  defined the default value of the period is 1 day. 
    296  -s,--status <status(es)>                        status(es) of the job. Lack of this option is 
    297                                                  equivalent to requesting unterminated activities. 
    298  -v,--version                                    display version 
    299 }}} 
     78[[qcg-tools | The detailed description of the qcg-* tools]] 
    30079 
    30180== QCG-Simple description format ==