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

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: "Running an Arvados workflow"
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 {% include 'what_is_cwl' %}
  13
  14 {% include 'tutorial_expectations' %}
  15
  16 {% include 'notebox_begin' %}
  17
  18 By default, the @arvados-cwl-runner@ is installed on Arvados shell nodes.  If you want to submit jobs from somewhere else, such as your workstation, you may install "arvados-cwl-runner.":#setup
  19
  20 {% include 'notebox_end' %}
  21
  22 This tutorial will demonstrate how to submit a workflow at the command line using @arvados-cwl-runner@.
  23
  24 h2. Running arvados-cwl-runner
  25
  26 h3. Get the example files
  27
  28 The tutorial files are located in the "documentation section of the Arvados source repository:":https://github.com/curoverse/arvados/tree/master/doc/user/cwl/bwa-mem
  29
  30 <notextile>
  31 <pre><code>~$ <span class="userinput">git clone https://github.com/curoverse/arvados</span>
  32 ~$ <span class="userinput">cd arvados/doc/user/cwl/bwa-mem</span>
  33 </code></pre>
  34 </notextile>
  35
  36 The tutorial data is hosted on "https://playground.arvados.org":https://playground.arvados.org (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 playground.arvados.org account).
  37
  38 <notextile>
  39 <pre><code>~$ <span class="userinput">arv-copy --src qr1hi --dst settings 2463fa9efeb75e099685528b3b9071e0+438</span>
  40 ~$ <span class="userinput">arv-copy --src qr1hi --dst settings ae480c5099b81e17267b7445e35b4bc7+180</span>
  41 ~$ <span class="userinput">arv-copy --src qr1hi --dst settings 655c6cd07550151b210961ed1d3852cf+57</span>
  42 </code></pre>
  43 </notextile>
  44
  45 If you do not wish to create an account on "https://playground.arvados.org":https://playground.arvados.org, you may download the files anonymously and upload them to your local Arvados instance:
  46
  47 "https://playground.arvados.org/collections/2463fa9efeb75e099685528b3b9071e0+438":https://playground.arvados.org/collections/2463fa9efeb75e099685528b3b9071e0+438
  48
  49 "https://playground.arvados.org/collections/ae480c5099b81e17267b7445e35b4bc7+180":https://playground.arvados.org/collections/ae480c5099b81e17267b7445e35b4bc7+180
  50
  51 "https://playground.arvados.org/collections/655c6cd07550151b210961ed1d3852cf+57":https://playground.arvados.org/collections/655c6cd07550151b210961ed1d3852cf+57
  52
  53 h2. Submitting a workflow to an Arvados cluster
  54
  55 h3. Submit a workflow and wait for results
  56
  57 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.
  58
  59 *Note:* Once submitted, the workflow runs entirely on Arvados, so even if you log out, the workflow will continue to run.  However, if you interrupt @arvados-cwl-runner@ with control-C it will cancel the workflow.
  60
  61 <notextile>
  62 <pre><code>~/arvados/doc/user/cwl/bwa-mem$ <span class="userinput">arvados-cwl-runner bwa-mem.cwl bwa-mem-input.yml</span>
  63 arvados-cwl-runner 1.0.20160628195002, arvados-python-client 0.1.20160616015107, cwltool 1.0.20160629140624
  64 2016-06-30 14:56:36 arvados.arv-run[27002] INFO: Upload local files: "bwa-mem.cwl"
  65 2016-06-30 14:56:36 arvados.arv-run[27002] INFO: Uploaded to qr1hi-4zz18-h7ljh5u76760ww2
  66 2016-06-30 14:56:40 arvados.cwl-runner[27002] INFO: Submitted job qr1hi-8i9sb-fm2n3b1w0l6bskg
  67 2016-06-30 14:56:41 arvados.cwl-runner[27002] INFO: Job bwa-mem.cwl (qr1hi-8i9sb-fm2n3b1w0l6bskg) is Running
  68 2016-06-30 14:57:12 arvados.cwl-runner[27002] INFO: Job bwa-mem.cwl (qr1hi-8i9sb-fm2n3b1w0l6bskg) is Complete
  69 2016-06-30 14:57:12 arvados.cwl-runner[27002] INFO: Overall process status is success
  70 {
  71     "aligned_sam": {
  72         "path": "keep:54325254b226664960de07b3b9482349+154/HWI-ST1027_129_D0THKACXX.1_1.sam",
  73         "checksum": "sha1$0dc46a3126d0b5d4ce213b5f0e86e2d05a54755a",
  74         "class": "File",
  75         "size": 30738986
  76     }
  77 }
  78 </code></pre>
  79 </notextile>
  80
  81 h3. Referencing files
  82
  83 When running a workflow on an Arvados cluster, the input files must be stored in Keep.  There are several ways this can happen.
  84
  85 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@.
  86
  87 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.
  88
  89 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.
  90
  91 You can also execute CWL files directly from Keep:
  92
  93 <notextile>
  94 <pre><code>~/arvados/doc/user/cwl/bwa-mem$ <span class="userinput">arvados-cwl-runner keep:655c6cd07550151b210961ed1d3852cf+57/bwa-mem.cwl bwa-mem-input.yml</span>
  95 arvados-cwl-runner 1.0.20160628195002, arvados-python-client 0.1.20160616015107, cwltool 1.0.20160629140624
  96 2016-06-30 14:56:36 arvados.arv-run[27002] INFO: Uploaded to qr1hi-4zz18-h7ljh5u76760ww2
  97 2016-06-30 14:56:40 arvados.cwl-runner[27002] INFO: Submitted job qr1hi-8i9sb-fm2n3b1w0l6bskg
  98 2016-06-30 14:56:41 arvados.cwl-runner[27002] INFO: Job bwa-mem.cwl (qr1hi-8i9sb-fm2n3b1w0l6bskg) is Running
  99 2016-06-30 14:57:12 arvados.cwl-runner[27002] INFO: Job bwa-mem.cwl (qr1hi-8i9sb-fm2n3b1w0l6bskg) is Complete
 100 2016-06-30 14:57:12 arvados.cwl-runner[27002] INFO: Overall process status is success
 101 {
 102     "aligned_sam": {
 103         "path": "keep:54325254b226664960de07b3b9482349+154/HWI-ST1027_129_D0THKACXX.1_1.sam",
 104         "checksum": "sha1$0dc46a3126d0b5d4ce213b5f0e86e2d05a54755a",
 105         "class": "File",
 106         "size": 30738986
 107     }
 108 }
 109 </code></pre>
 110 </notextile>
 111
 112 h3. Work reuse
 113
 114 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@.
 115
 116 h3. Command line options
 117
 118 See "Using arvados-cwl-runner":{{site.baseurl}}/user/cwl/cwl-run-options.html
 119
 120 h2(#setup). Setting up arvados-cwl-runner
 121
 122 By default, the @arvados-cwl-runner@ is installed on Arvados shell nodes.  If you want to submit jobs from somewhere else, such as your workstation, you may install @arvados-cwl-runner@ using @pip@:
 123
 124 <notextile>
 125 <pre><code>~$ <span class="userinput">virtualenv ~/venv</span>
 126 ~$ <span class="userinput">. ~/venv/bin/activate</span>
 127 ~$ <span class="userinput">pip install -U setuptools</span>
 128 ~$ <span class="userinput">pip install arvados-cwl-runner</span>
 129 </code></pre>
 130 </notextile>
 131
 132 h3. Check Docker access
 133
 134 In order to pull and upload Docker images, @arvados-cwl-runner@ requires access to Docker.  You do not need Docker if the Docker images you intend to use are already available in Arvados.
 135
 136 You can determine if you have access to Docker by running @docker version@:
 137
 138 <notextile>
 139 <pre><code>~$ <span class="userinput">docker version</span>
 140 Client:
 141  Version:      1.9.1
 142  API version:  1.21
 143  Go version:   go1.4.2
 144  Git commit:   a34a1d5
 145  Built:        Fri Nov 20 12:59:02 UTC 2015
 146  OS/Arch:      linux/amd64
 147
 148 Server:
 149  Version:      1.9.1
 150  API version:  1.21
 151  Go version:   go1.4.2
 152  Git commit:   a34a1d5
 153  Built:        Fri Nov 20 12:59:02 UTC 2015
 154  OS/Arch:      linux/amd64
 155 </code></pre>
 156 </notextile>
 157
 158 If this returns an error, contact the sysadmin of your cluster for assistance.