doc/user/cwl/cwl-runner.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Using Common Workflow Language
   5 ...
   6
   7 The "Common Workflow Language (CWL)":http://commonwl.org is a multi-vendor open standard for describing analysis tools and workflows that are portable across a variety of platforms.  CWL is the recommended way to develop and run workflows for Arvados.  Arvados supports the "CWL v1.0":http://commonwl.org/v1.0 specification.
   8
   9 {% include 'tutorial_expectations' %}
  10
  11 h2. Setting up
  12
  13 The @arvados-cwl-runner@ client is installed by default on Arvados shell nodes.  However, if you do not have @arvados-cwl-runner@, you may install it using @pip@:
  14
  15 <notextile>
  16 <pre><code>~$ <span class="userinput">virtualenv ~/venv</span>
  17 ~$ <span class="userinput">. ~/venv/bin/activate</span>
  18 ~$ <span class="userinput">pip install arvados-cwl-runner</span>
  19 </code></pre>
  20 </notextile>
  21
  22 h3. Docker
  23
  24 Certain features of @arvados-cwl-runner@ require access to Docker.  You can determine if you have access to Docker by running @docker version@:
  25
  26 <notextile>
  27 <pre><code>~$ <span class="userinput">docker version</span>
  28 Client:
  29  Version:      1.9.1
  30  API version:  1.21
  31  Go version:   go1.4.2
  32  Git commit:   a34a1d5
  33  Built:        Fri Nov 20 12:59:02 UTC 2015
  34  OS/Arch:      linux/amd64
  35
  36 Server:
  37  Version:      1.9.1
  38  API version:  1.21
  39  Go version:   go1.4.2
  40  Git commit:   a34a1d5
  41  Built:        Fri Nov 20 12:59:02 UTC 2015
  42  OS/Arch:      linux/amd64
  43 </code></pre>
  44 </notextile>
  45
  46 If this returns an error, contact the sysadmin of your cluster for assistance.  Alternatively, if you have Docker installed on your local workstation, you may follow the instructions above to install @arvados-cwl-runner@.
  47
  48 h3. Getting the example files
  49
  50 The tutorial files are located in the documentation section of the Arvados source repository:
  51
  52 <notextile>
  53 <pre><code>~$ <span class="userinput">git clone https://github.com/curoverse/arvados</span>
  54 ~$ <span class="userinput">cd arvados/doc/user/cwl/bwa-mem</span>
  55 </code></pre>
  56 </notextile>
  57
  58 The tutorial data is hosted on "https://cloud.curoverse.com":https://cloud.curoverse.com (also referred to by the identifier *qr1hi*).  If you are using a different Arvados instance, you may need to copy the data to your own instance.  The easiest way to do this is with "arv-copy":{{site.baseurl}}/user/topics/arv-copy.html (this requires signing up for a free cloud.curoverse.com account).
  59
  60 <notextile>
  61 <pre><code>~$ <span class="userinput">arv-copy --src qr1hi --dst settings 2463fa9efeb75e099685528b3b9071e0+438</span>
  62 ~$ <span class="userinput">arv-copy --src qr1hi --dst settings ae480c5099b81e17267b7445e35b4bc7+180</span>
  63 </code></pre>
  64 </notextile>
  65
  66 If you do not wish to create an account on "https://cloud.curoverse.com":https://cloud.curoverse.com, you may download the files anonymously and upload them to your local Arvados instance:
  67
  68 "https://cloud.curoverse.com/collections/2463fa9efeb75e099685528b3b9071e0+438":https://cloud.curoverse.com/collections/2463fa9efeb75e099685528b3b9071e0+438
  69
  70 "https://cloud.curoverse.com/collections/ae480c5099b81e17267b7445e35b4bc7+180":https://cloud.curoverse.com/collections/ae480c5099b81e17267b7445e35b4bc7+180
  71
  72 h2. Submitting a workflow to an Arvados cluster
  73
  74 Use @arvados-cwl-runner@ to submit CWL workflows to Arvados.  After submitting the job, it will wait for the workflow to complete and print out the final result to standard output.  Note that once submitted, the workflow runs entirely on Arvados, so even if you interrupt @arvados-cwl-runner@ or log out, the workflow will continue to run.
  75
  76 <notextile>
  77 <pre><code>~/arvados/doc/user/cwl/bwa-mem$ <span class="userinput">arvados-cwl-runner bwa-mem.cwl bwa-mem-input.yml</span>
  78 arvados-cwl-runner 1.0.20160628195002, arvados-python-client 0.1.20160616015107, cwltool 1.0.20160629140624
  79 2016-06-30 14:56:36 arvados.arv-run[27002] INFO: Upload local files: "bwa-mem.cwl"
  80 2016-06-30 14:56:36 arvados.arv-run[27002] INFO: Uploaded to qr1hi-4zz18-h7ljh5u76760ww2
  81 2016-06-30 14:56:40 arvados.cwl-runner[27002] INFO: Submitted job qr1hi-8i9sb-fm2n3b1w0l6bskg
  82 2016-06-30 14:56:41 arvados.cwl-runner[27002] INFO: Job bwa-mem.cwl (qr1hi-8i9sb-fm2n3b1w0l6bskg) is Running
  83 2016-06-30 14:57:12 arvados.cwl-runner[27002] INFO: Job bwa-mem.cwl (qr1hi-8i9sb-fm2n3b1w0l6bskg) is Complete
  84 2016-06-30 14:57:12 arvados.cwl-runner[27002] INFO: Overall process status is success
  85 {
  86     "aligned_sam": {
  87         "path": "keep:54325254b226664960de07b3b9482349+154/HWI-ST1027_129_D0THKACXX.1_1.sam",
  88         "checksum": "sha1$0dc46a3126d0b5d4ce213b5f0e86e2d05a54755a",
  89         "class": "File",
  90         "size": 30738986
  91     }
  92 }
  93 </code></pre>
  94 </notextile>
  95
  96 To submit a workflow and exit immediately, use the @--no-wait@ option.  This will print out the uuid of the job that was submitted to standard output.
  97
  98 <notextile>
  99 <pre><code>~/arvados/doc/user/cwl/bwa-mem$ <span class="userinput">arvados-cwl-runner --no-wait bwa-mem.cwl bwa-mem-input.yml</span>
 100 arvados-cwl-runner 1.0.20160628195002, arvados-python-client 0.1.20160616015107, cwltool 1.0.20160629140624
 101 2016-06-30 15:07:52 arvados.arv-run[12480] INFO: Upload local files: "bwa-mem.cwl"
 102 2016-06-30 15:07:52 arvados.arv-run[12480] INFO: Uploaded to qr1hi-4zz18-eqnfwrow8aysa9q
 103 2016-06-30 15:07:52 arvados.cwl-runner[12480] INFO: Submitted job qr1hi-8i9sb-fm2n3b1w0l6bskg
 104 qr1hi-8i9sb-fm2n3b1w0l6bskg
 105 </code></pre>
 106 </notextile>
 107
 108 To run a workflow with local control, use @--local@.  This means that the host where you run @arvados-cwl-runner@ will be responsible for submitting jobs. With @--local@, if you interrupt @arvados-cwl-runner@ or log out, the workflow will be terminated.
 109
 110 <notextile>
 111 <pre><code>~/arvados/doc/user/cwl/bwa-mem$ <span class="userinput">arvados-cwl-runner --local bwa-mem.cwl bwa-mem-input.yml</span>
 112 arvados-cwl-runner 1.0.20160628195002, arvados-python-client 0.1.20160616015107, cwltool 1.0.20160629140624
 113 2016-07-01 10:05:19 arvados.cwl-runner[16290] INFO: Pipeline instance qr1hi-d1hrv-92wcu6ldtio74r4
 114 2016-07-01 10:05:28 arvados.cwl-runner[16290] INFO: Job bwa-mem.cwl (qr1hi-8i9sb-2nzzfbuf9zjrj4g) is Queued
 115 2016-07-01 10:05:29 arvados.cwl-runner[16290] INFO: Job bwa-mem.cwl (qr1hi-8i9sb-2nzzfbuf9zjrj4g) is Running
 116 2016-07-01 10:05:45 arvados.cwl-runner[16290] INFO: Job bwa-mem.cwl (qr1hi-8i9sb-2nzzfbuf9zjrj4g) is Complete
 117 2016-07-01 10:05:46 arvados.cwl-runner[16290] INFO: Overall process status is success
 118 {
 119     "aligned_sam": {
 120         "size": 30738986,
 121         "path": "keep:15f56bad0aaa7364819bf14ca2a27c63+88/HWI-ST1027_129_D0THKACXX.1_1.sam",
 122         "checksum": "sha1$0dc46a3126d0b5d4ce213b5f0e86e2d05a54755a",
 123         "class": "File"
 124     }
 125 }
 126 </code></pre>
 127 </notextile>
 128
 129 h2. Work reuse
 130
 131 Workflows submitted with @arvados-cwl-runner@ will take advantage of Arvados job reuse.  If you submit a workflow which is identical to one that has run before, it will short cut the execution and return the result of the previous run.  This also applies to individual workflow steps.  For example, a two step workflow where the first step has run before will reuse results for first step and only execute the new second step.  You can disable this behavior with @--disable-reuse@.
 132
 133 h2. Referencing files
 134
 135 When running a workflow on an Arvados cluster, the input files must be stored in Keep.  There are several ways this can happen.
 136
 137 A URI reference to Keep uses the @keep:@ scheme followed by the portable data hash, collection size, and path to the file inside the collection.  For example, @keep:2463fa9efeb75e099685528b3b9071e0+438/19.fasta.bwt@.
 138
 139 If you reference a file in "arv-mount":{{site.baseurl}}/user/tutorials/tutorial-keep-mount.html, such as @/home/example/keep/by_id/2463fa9efeb75e099685528b3b9071e0+438/19.fasta.bwt@, then @arvados-cwl-runner@ will automatically determine the appropriate Keep URI reference.
 140
 141 If you reference a local file which is not in @arv-mount@, then @arvados-cwl-runner@ will upload the file to Keep and use the Keep URI reference from the upload.
 142
 143 h2. Registering a workflow with Workbench
 144
 145 Use @--create-template@ to register a CWL workflow with Arvados Workbench.  This enables you to run workflows by clicking on the <span class="btn btn-sm btn-primary"><i class="fa fa-fw fa-gear"></i> Run a pipeline...</span> on the Workbench Dashboard.
 146
 147 <notextile>
 148 <pre><code>~/arvados/doc/user/cwl/bwa-mem$ <span class="userinput">arvados-cwl-runner --create-template bwa-mem.cwl</span>
 149 arvados-cwl-runner 1.0.20160628195002, arvados-python-client 0.1.20160616015107, cwltool 1.0.20160629140624
 150 2016-07-01 12:21:01 arvados.arv-run[15796] INFO: Upload local files: "bwa-mem.cwl"
 151 2016-07-01 12:21:01 arvados.arv-run[15796] INFO: Uploaded to qr1hi-4zz18-7e0hedrmkuyoei3
 152 2016-07-01 12:21:01 arvados.cwl-runner[15796] INFO: Created template qr1hi-p5p6p-rjleou1dwr167v5
 153 qr1hi-p5p6p-rjleou1dwr167v5
 154 </code></pre>
 155 </notextile>
 156
 157 You can provide a partial input file to set default values for the workflow input parameters:
 158
 159 <notextile>
 160 <pre><code>~/arvados/doc/user/cwl/bwa-mem$ <span class="userinput">arvados-cwl-runner --create-template bwa-mem.cwl bwa-mem-template.yml</span>
 161 arvados-cwl-runner 1.0.20160628195002, arvados-python-client 0.1.20160616015107, cwltool 1.0.20160629140624
 162 2016-07-01 14:09:50 arvados.arv-run[3730] INFO: Upload local files: "bwa-mem.cwl"
 163 2016-07-01 14:09:50 arvados.arv-run[3730] INFO: Uploaded to qr1hi-4zz18-0f91qkovk4ml18o
 164 2016-07-01 14:09:50 arvados.cwl-runner[3730] INFO: Created template qr1hi-p5p6p-0deqe6nuuyqns2i
 165 qr1hi-p5p6p-0deqe6nuuyqns2i
 166 </code></pre>
 167 </notextile>
 168
 169 h2. Making workflows directly executable
 170
 171 You can make a workflow file directly executable (@cwl-runner@ should be an alias to @arvados-cwl-runner@) by adding the following line to the top of the file:
 172
 173 <notextile>
 174 <pre><code>#!/usr/bin/env cwl-runner
 175 </code></pre>
 176 </notextile>
 177
 178 <notextile>
 179 <pre><code>~/arvados/doc/user/cwl/bwa-mem$ <span class="userinput">./bwa-mem.cwl bwa-mem-input.yml</span>
 180 arvados-cwl-runner 1.0.20160628195002, arvados-python-client 0.1.20160616015107, cwltool 1.0.20160629140624
 181 2016-06-30 14:56:36 arvados.arv-run[27002] INFO: Upload local files: "bwa-mem.cwl"
 182 2016-06-30 14:56:36 arvados.arv-run[27002] INFO: Uploaded to qr1hi-4zz18-h7ljh5u76760ww2
 183 2016-06-30 14:56:40 arvados.cwl-runner[27002] INFO: Submitted job qr1hi-8i9sb-fm2n3b1w0l6bskg
 184 2016-06-30 14:56:41 arvados.cwl-runner[27002] INFO: Job bwa-mem.cwl (qr1hi-8i9sb-fm2n3b1w0l6bskg) is Running
 185 2016-06-30 14:57:12 arvados.cwl-runner[27002] INFO: Job bwa-mem.cwl (qr1hi-8i9sb-fm2n3b1w0l6bskg) is Complete
 186 2016-06-30 14:57:12 arvados.cwl-runner[27002] INFO: Overall process status is success
 187 {
 188     "aligned_sam": {
 189         "path": "keep:54325254b226664960de07b3b9482349+154/HWI-ST1027_129_D0THKACXX.1_1.sam",
 190         "checksum": "sha1$0dc46a3126d0b5d4ce213b5f0e86e2d05a54755a",
 191         "class": "File",
 192         "size": 30738986
 193     }
 194 }
 195 </code></pre>
 196 </notextile>
 197
 198 You can even make an input file directly executable the same way with the following two lines at the top:
 199
 200 <notextile>
 201 <pre><code>#!/usr/bin/env cwl-runner
 202 cwl:tool: <span class="userinput">bwa-mem.cwl</span>
 203 </code></pre>
 204 </notextile>
 205
 206 <notextile>
 207 <pre><code>~/arvados/doc/user/cwl/bwa-mem$ <span class="userinput">./bwa-mem-input.yml</span>
 208 arvados-cwl-runner 1.0.20160628195002, arvados-python-client 0.1.20160616015107, cwltool 1.0.20160629140624
 209 2016-06-30 14:56:36 arvados.arv-run[27002] INFO: Upload local files: "bwa-mem.cwl"
 210 2016-06-30 14:56:36 arvados.arv-run[27002] INFO: Uploaded to qr1hi-4zz18-h7ljh5u76760ww2
 211 2016-06-30 14:56:40 arvados.cwl-runner[27002] INFO: Submitted job qr1hi-8i9sb-fm2n3b1w0l6bskg
 212 2016-06-30 14:56:41 arvados.cwl-runner[27002] INFO: Job bwa-mem.cwl (qr1hi-8i9sb-fm2n3b1w0l6bskg) is Running
 213 2016-06-30 14:57:12 arvados.cwl-runner[27002] INFO: Job bwa-mem.cwl (qr1hi-8i9sb-fm2n3b1w0l6bskg) is Complete
 214 2016-06-30 14:57:12 arvados.cwl-runner[27002] INFO: Overall process status is success
 215 {
 216     "aligned_sam": {
 217         "path": "keep:54325254b226664960de07b3b9482349+154/HWI-ST1027_129_D0THKACXX.1_1.sam",
 218         "checksum": "sha1$0dc46a3126d0b5d4ce213b5f0e86e2d05a54755a",
 219         "class": "File",
 220         "size": 30738986
 221     }
 222 }
 223 </code></pre>
 224 </notextile>
 225
 226 h2. Developing workflows
 227
 228 For an introduction and and detailed documentation about writing CWL, see the "User Guide":http://commonwl.org/v1.0/UserGuide.html and the "Specification":http://commonwl.org/v1.0 .
 229
 230 To run on Arvados, a workflow should provide a @DockerRequirement@ in the @hints@ section.
 231
 232 When developing a workflow, it is often helpful to run it on the local host to avoid the overhead of submitting to the cluster.  To execute a workflow only on the local host (without submitting jobs to an Arvados cluster) you can use the @cwltool@ command.  Note that you must also have the input data accessible on the local host.  You can use @arv-get@ to fetch the data from Keep.
 233
 234 <notextile>
 235 <pre><code>~/arvados/doc/user/cwl/bwa-mem$ <span class="userinput">arv-get 2463fa9efeb75e099685528b3b9071e0+438/ .</span>
 236 156 MiB / 156 MiB 100.0%
 237 ~/arvados/doc/user/cwl/bwa-mem$ <span class="userinput">arv-get ae480c5099b81e17267b7445e35b4bc7+180/ .</span>
 238 23 MiB / 23 MiB 100.0%
 239 ~/arvados/doc/user/cwl/bwa-mem$ <span class="userinput">cwltool bwa-mem-input.yml bwa-mem-input-local.yml</span>
 240 cwltool 1.0.20160629140624
 241 [job bwa-mem.cwl] /home/example/arvados/doc/user/cwl/bwa-mem$ docker \
 242     run \
 243     -i \
 244     --volume=/home/example/arvados/doc/user/cwl/bwa-mem/19.fasta.ann:/var/lib/cwl/job979368791_bwa-mem/19.fasta.ann:ro \
 245     --volume=/home/example/arvados/doc/user/cwl/bwa-mem/HWI-ST1027_129_D0THKACXX.1_1.fastq:/var/lib/cwl/job979368791_bwa-mem/HWI-ST1027_129_D0THKACXX.1_1.fastq:ro \
 246     --volume=/home/example/arvados/doc/user/cwl/bwa-mem/19.fasta.sa:/var/lib/cwl/job979368791_bwa-mem/19.fasta.sa:ro \
 247     --volume=/home/example/arvados/doc/user/cwl/bwa-mem/19.fasta.amb:/var/lib/cwl/job979368791_bwa-mem/19.fasta.amb:ro \
 248     --volume=/home/example/arvados/doc/user/cwl/bwa-mem/19.fasta.pac:/var/lib/cwl/job979368791_bwa-mem/19.fasta.pac:ro \
 249     --volume=/home/example/arvados/doc/user/cwl/bwa-mem/HWI-ST1027_129_D0THKACXX.1_2.fastq:/var/lib/cwl/job979368791_bwa-mem/HWI-ST1027_129_D0THKACXX.1_2.fastq:ro \
 250     --volume=/home/example/arvados/doc/user/cwl/bwa-mem/19.fasta.bwt:/var/lib/cwl/job979368791_bwa-mem/19.fasta.bwt:ro \
 251     --volume=/home/example/arvados/doc/user/cwl/bwa-mem:/var/spool/cwl:rw \
 252     --volume=/tmp/tmpgzyou9:/tmp:rw \
 253     --workdir=/var/spool/cwl \
 254     --read-only=true \
 255     --log-driver=none \
 256     --user=1001 \
 257     --rm \
 258     --env=TMPDIR=/tmp \
 259     --env=HOME=/var/spool/cwl \
 260     biodckr/bwa \
 261     bwa \
 262     mem \
 263     -t \
 264     1 \
 265     -R \
 266     '@RG        ID:arvados_tutorial     PL:illumina     SM:HWI-ST1027_129' \
 267     /var/lib/cwl/job979368791_bwa-mem/19.fasta \
 268     /var/lib/cwl/job979368791_bwa-mem/HWI-ST1027_129_D0THKACXX.1_1.fastq \
 269     /var/lib/cwl/job979368791_bwa-mem/HWI-ST1027_129_D0THKACXX.1_2.fastq > /home/example/arvados/doc/user/cwl/bwa-mem/HWI-ST1027_129_D0THKACXX.1_1.sam
 270 [M::bwa_idx_load_from_disk] read 0 ALT contigs
 271 [M::process] read 100000 sequences (10000000 bp)...
 272 [M::mem_pestat] # candidate unique pairs for (FF, FR, RF, RR): (0, 4745, 1, 0)
 273 [M::mem_pestat] skip orientation FF as there are not enough pairs
 274 [M::mem_pestat] analyzing insert size distribution for orientation FR...
 275 [M::mem_pestat] (25, 50, 75) percentile: (154, 181, 214)
 276 [M::mem_pestat] low and high boundaries for computing mean and std.dev: (34, 334)
 277 [M::mem_pestat] mean and std.dev: (185.63, 44.88)
 278 [M::mem_pestat] low and high boundaries for proper pairs: (1, 394)
 279 [M::mem_pestat] skip orientation RF as there are not enough pairs
 280 [M::mem_pestat] skip orientation RR as there are not enough pairs
 281 [M::mem_process_seqs] Processed 100000 reads in 9.848 CPU sec, 9.864 real sec
 282 [main] Version: 0.7.12-r1039
 283 [main] CMD: bwa mem -t 1 -R @RG ID:arvados_tutorial     PL:illumina     SM:HWI-ST1027_129 /var/lib/cwl/job979368791_bwa-mem/19.fasta /var/lib/cwl/job979368791_bwa-mem/HWI-ST1027_129_D0THKACXX.1_1.fastq /var/lib/cwl/job979368791_bwa-mem/HWI-ST1027_129_D0THKACXX.1_2.fastq
 284 [main] Real time: 10.061 sec; CPU: 10.032 sec
 285 Final process status is success
 286 {
 287     "aligned_sam": {
 288         "size": 30738959,
 289         "path": "/home/example/arvados/doc/user/cwl/bwa-mem/HWI-ST1027_129_D0THKACXX.1_1.sam",
 290         "checksum": "sha1$0c668cca45fef02397bb5302880526d300ee4dac",
 291         "class": "File"
 292     }
 293 }
 294 </code></pre>
 295 </notextile>
 296
 297 If you get the error @JavascriptException: Long-running script killed after 20 seconds.@ this may be due to the Dockerized Node.js engine taking too long to start.  You may address this by installing Node.js locally (run @apt-get install nodejs@ on Debian or Ubuntu) or by specifying a longer timeout with the @--eval-timeout@ option.  For example, run the workflow with @cwltool --eval-timeout=40@ for a 40-second timeout.