Ciop-simjob » History » Version 2
Herve Caumont, 2013-06-18 16:24
1 | 1 | Herve Caumont | h1. Ciop-simjob |
---|---|---|---|
2 | |||
3 | 2 | Herve Caumont | Command Line (CLI) reference |
4 | {{>toc}} |
||
5 | 1 | Herve Caumont | |
6 | h2. NAME |
||
7 | |||
8 | ciop-simjob - runs individually a node of the sample workflow of the application |
||
9 | |||
10 | h2. SYNOPSIS |
||
11 | |||
12 | <pre> |
||
13 | /usr/bin/ciop-simjob {node} [option...] |
||
14 | </pre> |
||
15 | |||
16 | h2. DESCRIPTION |
||
17 | |||
18 | @ciop-simjob@ runs individually a node of the sample workflow of the application. This is useful to test unitarily a job. |
||
19 | |||
20 | h2. OPTIONS |
||
21 | |||
22 | *node* |
||
23 | |||
24 | p. This must be the id of the node registered in the workflow "sample" in the file ${_CIOP_APPLICATION_PATH}/application.xml |
||
25 | |||
26 | *-i input* |
||
27 | |||
28 | p. directory name or file name containing the input to map to the executable via stdin. This path must be relative to share path ${_CIOP_SHARE_PATH}. |
||
29 | By default the value is setup to find the best input for your job (more info in the documentation) |
||
30 | |||
31 | *-o output* |
||
32 | |||
33 | p. directory name where to put the output file with the stdout of the execution This directory must not exist (or use -f) and must be relative to share path ${_CIOP_SHARE_PATH} |
||
34 | By default the value is setup to find the best output dir for next job (more info in the documentation) |
||
35 | |||
36 | *-f* |
||
37 | |||
38 | p. delete existing output directory if it exists (default: no) |
||
39 | |||
40 | *-n* |
||
41 | |||
42 | p. list the node ids of the workflow |
||
43 | |||
44 | *-p name value* |
||
45 | |||
46 | p. define a processing parameter for the simulation. If a default value is defined in the application.xml, it will be overwritten (not yet implemented) |
||
47 | |||
48 | h2. EXIT STATUS |
||
49 | |||
50 | @ciop-simjob@ command exits 0 on success, and >0 if an error occurs. |
||
51 | |||
52 | h2. EXAMPLES |
||
53 | |||
54 | h3. Example 1. Get the workflow node IDs |
||
55 | |||
56 | <pre>ciop-simjob -n</pre> |
||
57 | |||
58 | h3. Example 2. First run of a given workflow node |
||
59 | |||
60 | <pre>ciop-simjob node_name</pre> |
||
61 | |||
62 | h3. Example 3. Following runs of a given workflow node (deletes the results of a previous run) |
||
63 | |||
64 | <pre>ciop-simjob -f node_name</pre> |
||
65 | |||
66 | h2. SEE ALSO |
||
67 | |||
68 | p. [[ciop-simwf]] |
||
69 | |||
70 | h2. AUTHOR |
||
71 | |||
72 | p. Terradue Srl |