doc/user/tutorials/tutorial-pipeline-workbench.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: "Running a pipeline using Workbench"
   5 ...
   6
   7 A "pipeline" (sometimes called a "workflow" in other systems) is sequence of steps that apply various programs or tools to transform input data to output data.  Pipelines are the principal means of performing computation with Arvados.  This tutorial demonstrates how to run a single-stage pipeline to take a small data set of paired-end reads from an sample "exome":https://en.wikipedia.org/wiki/Exome in "FASTQ":https://en.wikipedia.org/wiki/FASTQ_format format and align them to "Chromosome 19":https://en.wikipedia.org/wiki/Chromosome_19_%28human%29 using the "bwa mem":http://bio-bwa.sourceforge.net/ tool, producing a "Sequence Alignment/Map (SAM)":https://samtools.github.io/ file.  This will introduce the following Arvados features:
   8
   9 <div class="inside-list">
  10 * How to create a project.
  11 * How to browse available pipeline templates and create a new pipeline from an existing template.
  12 * How to browse and select input data for the pipeline and submit the pipeline to run on the Arvados cluster.
  13 * How to access your pipeline results.
  14 </div>
  15
  16 notextile. <div class="spaced-out">
  17
  18 # Start from the *Workbench Dashboard*.  You can return to the dashboard by clicking on *<i class="fa fa-lg fa-fw fa-home"></i> Home* in the upper left corner of any Workbench page.
  19 # Click on <span class="btn btn-sm btn-primary" > <i class="fa fa-fw fa-plus"></i> Add new project</span> on the "My projects" panel. This will direct you to the page for the new project.
  20 # On the new project page, click on the pencil icon <i class="fa fa-fw fa-pencil"></i> next to *New project* to pop up a text box and change the project title to *Tutorial output*.  Click on <span class="btn btn-xs btn-primary" ><i class="glyphicon glyphicon-ok"></i></span> to save the new name.
  21 # Click on <span class="btn btn-sm btn-primary"><i class="fa fa-fw fa-gear"></i> Run a pipeline...</span> This will open a modal dialog box titled *Choose a pipeline to run*.
  22 # Click on *<i class="fa fa-lg fa-fw fa-home"></i> Projects <span class="caret"></span>*.  Under *Projects shared with me* select *<i class="fa fa-fw fa-share-alt"></i> Arvados Tutorial*.
  23 # Select *<i class="fa fa-fw fa-gear"></i> Tutorial align using bwa mem* and click on <span class="btn btn-sm btn-primary" >Next: choose inputs <i class="fa fa-fw fa-arrow-circle-right"></i></span>.  This will load a new page where you will supply the inputs for the pipeline.
  24 # Click on <span class="btn btn-sm btn-primary" >Choose</span> under the first input parameter to the pipeline *reference_collection*.  This will open a modal dialog box titled *Choose a dataset*.
  25 # Once again click on *<i class="fa fa-lg fa-fw fa-home"></i> Projects <span class="caret"></span>* and under *Projects shared with me* select *<i class="fa fa-fw fa-share-alt"></i> Arvados Tutorial*.  Select *<i class="fa fa-fw fa-archive"></i> Tutorial chromosome 19 reference* and click on <span class="btn btn-sm btn-primary" >OK</span>.
  26 # Repeat the previous step to supply the *sample* parameter, this time choosing *<i class="fa fa-fw fa-archive"></i> Tutorial sample exome*.
  27 # Click on <span class="btn btn-sm btn-primary" >Run <i class="fa fa-fw fa-play"></i></span>.
  28 # This will refresh the page.  The pipeline will be queued and shortly start running.  You can track the progress by watching log messages from jobs.  This page refreshes automatically.  You will see <span class="label label-success">success</span> under the *job* the column when the pipeline completes successfully.
  29 # Click on *<i class="fa fa-fw fa-archive"></i> Show output files* to see the results of the job.  This will load a new page listing the output files from this pipeline.  Under the *Files* tab will be the output SAM file from the alignment tool
  30 # Click on the download icon <span class="btn btn-sm btn-info"><i class="fa fa-download"></i></span> to the right of the SAM file download your results.
  31
  32 notextile. </div>