Described with how to use "arv edit" in "Writing a pipeline". Switched order of...
[arvados.git] / doc / user / tutorials / tutorial-pipeline-workbench.html.textile.liquid
index 5f98c8cbeec27bd312ab19fb2d59343d04f01800..13b53483901e4635ebe4f65ef72dd80da1f93356 100644 (file)
@@ -4,25 +4,28 @@ navsection: userguide
 title: "Running a pipeline using Workbench"
 ...
 
+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:
+
+<div class="inside-list">
+* How to create a project.
+* How to browse available pipeline templates and create a new pipeline from an existing template.
+* How to browse and select input data for the pipeline and submit the pipeline to run on the Arvados cluster.
+* How to access your pipeline results.
+</div>
+
 notextile. <div class="spaced-out">
 
-# If you have not yet created any projects, first create a new project to save your work. Please see "Accessing Arvados Workbench":{{site.baseurl}}/user/getting_started/workbench.html page for details. If you already have created a project for your work, go to the project by clicking on the project in *My projects* panel.
-# Click on the <span class="btn btn-primary glyphicon-plus"> Add data...</span> button.
-# In the *Add data to project* popup window, enter *tutorial* in the search box.
-# The results should include a *tutorial* collection. 
-# Click on this collection and verify that it is the collection *var-GS000016015-ASM.tsv.bz2*.
-# Click on the <span class="btn btn-primary"> Add </span> button in the popup.  This adds the *var-GS000016015-ASM.tsv.bz2* collection to your project.
-# Click on the <span class="btn btn-primary glyphicon-gear"> Run a pipeline... </span> button
-# In the *Choose a pipeline to run* popup window, enter *tutorial* in the search box.
-# The result should include *Tutorial pipeline* template.
-# Click on this template and the click on <span class="btn btn-primary"> Next: choose inputs </span> button. This will take you to a new page to configure the pipeline instance.
-# In the *Inputs* tab, click on <span class="btn btn-primary"> Choose </span> button
-# In the *Choose a dataset* popup, click on the *tutorial* collection and click on <span class="btn btn-primary"> OK </span> button.
-# You can now run this pipeline by clicking on the <span class="btn btn-primary"> Run </span> button.
-# The page refreshes automatically every 15 seconds.  You should see the pipeline running, and then finish successfully.
-# Once the pipeline is finished, click on the *Show output files* button. This will take you to the collection page for the output of this pipeline.
-# Click on *md5sum.txt* to see the actual file that is the output of this pipeline.
-# Go back to the collection page for the result.  Click on the *Provenance graph* tab to see a graph illustrating the collections and scripts that were used to generate this file.
+# Starting from the Arvados Dashboard, click on <span class="btn btn-sm btn-primary" > <i class="fa fa-fw fa-plus"></i> Add new project</span>. This will direct you to the page for the new project.
+# 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.
+# 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*.
+# 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*.
+# 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.
+# 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*.
+# 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>.
+# Repeat the previous step to supply the *sample* parameter, this time choosing *<i class="fa fa-fw fa-archive"></i> Tutorial sample exome*.
+# Click on <span class="btn btn-sm btn-primary" >Run <i class="fa fa-fw fa-play"></i></span>.
+# 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.
+# 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
+# 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.
 
 notextile. </div>
-