doc/user/cwl/cwl-run-options.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: "Using arvados-cwl-runner"
   5 ...
   6
   7 The following command line options are available for @arvados-cwl-runner@:
   8
   9 table(table table-bordered table-condensed).
  10 |_. Option |_. Description |
  11 |==--basedir== BASEDIR|     Base directory used to resolve relative references in the input, default to directory of input object file or current directory (if inputs piped/provided on command line).|
  12 |==--version==|             Print version and exit|
  13 |==--verbose==|             Default logging|
  14 |==--quiet==|               Only print warnings and errors.|
  15 |==--debug==|               Print even more logging|
  16 |==--tool-help==|           Print command line help for tool|
  17 |==--enable-reuse==|Enable job reuse (default)|
  18 |==--disable-reuse==|Disable job reuse (always run new jobs).|
  19 |==--project-uuid UUID==|   Project that will own the workflow jobs, if not provided, will go to home project.|
  20 |==--output-name OUTPUT_NAME==|Name to use for collection that stores the final output.|
  21 |==--output-tags OUTPUT_TAGS==|Tags for the final output collection separated by commas, e.g., =='--output-tags tag0,tag1,tag2'==.|
  22 |==--ignore-docker-for-reuse==|Ignore Docker image version when deciding whether to reuse past jobs.|
  23 |==--submit==|              Submit workflow to run on Arvados.|
  24 |==--local==|               Control workflow from local host (submits jobs to Arvados).|
  25 |==--create-template==|     (Deprecated) synonym for ==--create-workflow.==|
  26 |==--create-workflow==|     Create an Arvados workflow (if using the 'containers' API) or pipeline template (if using the 'jobs' API). See ==--api==.|
  27 |==--update-workflow== UUID|Update an existing Arvados workflow or pipeline template with the given UUID.|
  28 |==--wait==|                After submitting workflow runner job, wait for completion.|
  29 |==--no-wait==|             Submit workflow runner job and exit.|
  30 |==--api== WORK_API|        Select work submission API, one of 'jobs' or 'containers'. Default is 'jobs' if that API is available, otherwise 'containers'.|
  31 |==--compute-checksum==|    Compute checksum of contents while collecting outputs|
  32 |==--submit-runner-ram== SUBMIT_RUNNER_RAM|RAM (in MiB) required for the workflow runner job (default 1024)|
  33 |==--name== NAME|           Name to use for workflow execution instance.|
  34
  35 h3. Specify workflow and output names
  36
  37 Use the @--name@ and @--output-name@ options to specify the name of the workflow and name of the output collection.
  38
  39 <notextile>
  40 <pre><code>~/arvados/doc/user/cwl/bwa-mem$ <span class="userinput">arvados-cwl-runner --name "Example bwa run" --output-name "Example bwa output" bwa-mem.cwl bwa-mem-input.yml</span>
  41 arvados-cwl-runner 1.0.20160628195002, arvados-python-client 0.1.20160616015107, cwltool 1.0.20160629140624
  42 2016-06-30 14:56:36 arvados.arv-run[27002] INFO: Upload local files: "bwa-mem.cwl"
  43 2016-06-30 14:56:36 arvados.arv-run[27002] INFO: Uploaded to qr1hi-4zz18-h7ljh5u76760ww2
  44 2016-06-30 14:56:40 arvados.cwl-runner[27002] INFO: Submitted job qr1hi-8i9sb-fm2n3b1w0l6bskg
  45 2016-06-30 14:56:41 arvados.cwl-runner[27002] INFO: Job bwa-mem.cwl (qr1hi-8i9sb-fm2n3b1w0l6bskg) is Running
  46 2016-06-30 14:57:12 arvados.cwl-runner[27002] INFO: Job bwa-mem.cwl (qr1hi-8i9sb-fm2n3b1w0l6bskg) is Complete
  47 2016-06-30 14:57:12 arvados.cwl-runner[27002] INFO: Overall process status is success
  48 {
  49     "aligned_sam": {
  50         "path": "keep:54325254b226664960de07b3b9482349+154/HWI-ST1027_129_D0THKACXX.1_1.sam",
  51         "checksum": "sha1$0dc46a3126d0b5d4ce213b5f0e86e2d05a54755a",
  52         "class": "File",
  53         "size": 30738986
  54     }
  55 }
  56 </code></pre>
  57 </notextile>
  58
  59 h3. Submit a workflow with no waiting
  60
  61 To submit a workflow and exit immediately, use the @--no-wait@ option.  This will submit the workflow to Arvados, print out the UUID of the job that was submitted to standard output, and exit.
  62
  63 <notextile>
  64 <pre><code>~/arvados/doc/user/cwl/bwa-mem$ <span class="userinput">arvados-cwl-runner --no-wait bwa-mem.cwl bwa-mem-input.yml</span>
  65 arvados-cwl-runner 1.0.20160628195002, arvados-python-client 0.1.20160616015107, cwltool 1.0.20160629140624
  66 2016-06-30 15:07:52 arvados.arv-run[12480] INFO: Upload local files: "bwa-mem.cwl"
  67 2016-06-30 15:07:52 arvados.arv-run[12480] INFO: Uploaded to qr1hi-4zz18-eqnfwrow8aysa9q
  68 2016-06-30 15:07:52 arvados.cwl-runner[12480] INFO: Submitted job qr1hi-8i9sb-fm2n3b1w0l6bskg
  69 qr1hi-8i9sb-fm2n3b1w0l6bskg
  70 </code></pre>
  71 </notextile>
  72
  73 h3. Control a workflow locally
  74
  75 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, however, the jobs themselves will still run on the Arvados cluster.  With @--local@, if you interrupt @arvados-cwl-runner@ or log out, the workflow will be terminated.
  76
  77 <notextile>
  78 <pre><code>~/arvados/doc/user/cwl/bwa-mem$ <span class="userinput">arvados-cwl-runner --local bwa-mem.cwl bwa-mem-input.yml</span>
  79 arvados-cwl-runner 1.0.20160628195002, arvados-python-client 0.1.20160616015107, cwltool 1.0.20160629140624
  80 2016-07-01 10:05:19 arvados.cwl-runner[16290] INFO: Pipeline instance qr1hi-d1hrv-92wcu6ldtio74r4
  81 2016-07-01 10:05:28 arvados.cwl-runner[16290] INFO: Job bwa-mem.cwl (qr1hi-8i9sb-2nzzfbuf9zjrj4g) is Queued
  82 2016-07-01 10:05:29 arvados.cwl-runner[16290] INFO: Job bwa-mem.cwl (qr1hi-8i9sb-2nzzfbuf9zjrj4g) is Running
  83 2016-07-01 10:05:45 arvados.cwl-runner[16290] INFO: Job bwa-mem.cwl (qr1hi-8i9sb-2nzzfbuf9zjrj4g) is Complete
  84 2016-07-01 10:05:46 arvados.cwl-runner[16290] INFO: Overall process status is success
  85 {
  86     "aligned_sam": {
  87         "size": 30738986,
  88         "path": "keep:15f56bad0aaa7364819bf14ca2a27c63+88/HWI-ST1027_129_D0THKACXX.1_1.sam",
  89         "checksum": "sha1$0dc46a3126d0b5d4ce213b5f0e86e2d05a54755a",
  90         "class": "File"
  91     }
  92 }
  93 </code></pre>
  94 </notextile>