doc/user/composer/composer.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Create a Workflow with Composer
   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 The Arvados Workflow Composer is a graphical interface for building Common Workflow Language (CWL) workflows to run on Arvados.
  13
  14 This tutorial will demonstrate:
  15
  16 # Creating a new git repository through Arvados to store the workflow
  17 # Creating CommandLineTools for "sort" and "uniq"
  18 # Creating a Workflow which uses "sort" and "uniq" to remove duplicate lines from a text file
  19 # Submitting the Workflow to run on Arvados
  20
  21 h3. 1. Access from workbench
  22
  23 !(screenshot)c1.png!
  24
  25 h3. 2. Composer starting page
  26
  27 !(screenshot)c2.png!
  28
  29 h3. 3. Manage git repositories (opens Workbench in new tab)
  30
  31 !(screenshot)c2b.png!
  32
  33 h3. 4. Add a new repository
  34
  35 !(screenshot)c4.png!
  36
  37 !(screenshot)c3.png!
  38
  39 h3. 5. Return to Composer.  Use refresh button to discover new repository (may take a few moments to show up).
  40
  41 !(screenshot)c2c.png!
  42
  43 h3. 6. Create a new Command Line Tool
  44
  45 !(screenshot)c5.png!
  46
  47 !(screenshot)c20.png!
  48
  49 h3. 7. Set Docker image, base command, and input port for "sort" tool
  50
  51 The "Docker Repository" is the name:tag of a "Docker image uploaded Arvados.":{{site.baseurl}}/user/topics/arv-docker.html (Use @arv-keepdocker --pull debian:10@)  You can also find prepackaged bioinformatics tools on various sites, such as http://dockstore.org and http://biocontainers.pro/ .
  52
  53 !(screenshot)c6.png!
  54
  55 h3. 8. Redirect stdout to a file
  56
  57 !(screenshot)c7.png!
  58
  59 h3. 9. Capture output file
  60
  61 !(screenshot)c8.png!
  62
  63 h3. 10. Save Command Line Tool
  64
  65 !(screenshot)c22.png!
  66
  67 h3. 11. Repeat steps 6-10 for "uniq" tool
  68
  69 Create a new tool with a "base command" of "uniq".
  70
  71 h3. 12. Switch back to "Home" tab and create workflow
  72
  73 !(screenshot)c24.png!
  74
  75 !(screenshot)c9.png!
  76
  77 !(screenshot)c10.png!
  78
  79 h3. 13. Drag and drop tools into Workflow
  80
  81 !(screenshot)c11.png!
  82
  83 h3. 14. Drag from input port of "sort" to empty space to create workflow input
  84
  85 !(screenshot)c21.png!
  86
  87 h3. 15. Drag from output port of "sort" to input port of "uniq"
  88
  89 !(screenshot)c13.png!
  90
  91 h3. 16. Drag from output port of "uniq" to empty space to create workflow output
  92
  93 !(screenshot)c14.png!
  94
  95 h3. 17. Save Workflow
  96
  97 !(screenshot)c23.png!
  98
  99 h3. 18. Click on "Test" tab then click "Run"
 100
 101 !(screenshot)c15.png!
 102
 103 h3. 19. Choose input file
 104
 105 You may need to "upload an input file":{{site.baseurl}}/user/tutorials/tutorial-keep.html
 106
 107 !(screenshot)c16.png!
 108
 109 h3. 20. Run the workflow
 110
 111 !(screenshot)c17.png!
 112
 113 h3. 21. Monitor progress (may take several minutes)
 114
 115 !(screenshot)c18.png!
 116
 117 h3. 22. Get workflow output
 118
 119 !(screenshot)c19.png!