doc/user/tutorials/running-external-program.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: "Writing a pipeline template"
   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 'pipeline_deprecation_notice' %}
  13
  14 This tutorial demonstrates how to construct a two stage pipeline template that uses the "bwa mem":http://bio-bwa.sourceforge.net/ tool to produce a "Sequence Alignment/Map (SAM)":https://samtools.github.io/ file, then uses the "Picard SortSam tool":http://picard.sourceforge.net/command-line-overview.shtml#SortSam to produce a BAM (Binary Alignment/Map) file.
  15
  16 {% include 'tutorial_expectations' %}
  17
  18 Use the following command to create an empty template using @arv create pipeline_template@:
  19
  20 <notextile>
  21 <pre><code>~$ <span class="userinput">arv create pipeline_template</span></code></pre>
  22 </notextile>
  23
  24 This will open the template record in an interactive text editor (as specified by $EDITOR or $VISUAL, otherwise defaults to @nano@).  Now, update the contents of the editor with the following content:
  25
  26 <notextile>{% code 'tutorial_bwa_sortsam_pipeline' as javascript %}</notextile>
  27
  28 * @"name"@ is a human-readable name for the pipeline.
  29 * @"components"@ is a set of scripts or commands that make up the pipeline.  Each component is given an identifier (@"bwa-mem"@ and @"SortSam"@) in this example).
  30 ** Each entry in components @"components"@ is an Arvados job submission.  For more information about individual jobs, see the "job resource reference.":{{site.baseurl}}/api/methods/jobs.html
  31 * @"repository"@, @"script_version"@, and @"script"@ indicate that we intend to use the external @"run-command"@ tool wrapper that is part of the Arvados.  These parameters are described in more detail in "Writing a script":tutorial-firstscript.html.
  32 * @"runtime_constraints"@ describes runtime resource requirements for the component.
  33 ** @"docker_image"@ specifies the "Docker":https://www.docker.com/ runtime environment in which to run the job.  The Docker image @"bcosc/arv-base-java"@ supplied here has the Java runtime environment, bwa, and samtools installed.
  34 ** @"arvados_sdk_version"@ specifies a version of the Arvados SDK to load alongside the job's script. The example uses 'master'. If you would like to use a specific version of the sdk, you can find it in the "Arvados Python sdk repository":https://dev.arvados.org/projects/arvados/repository/revisions/master/show/sdk/python under *Latest revisions*.
  35 * @"script_parameters"@ describes the component parameters.
  36 ** @"command"@ is the actual command line to invoke the @bwa@ and then @SortSam@.  The notation @$()@ denotes macro substitution commands evaluated by the run-command tool wrapper.
  37 ** @"task.stdout"@ indicates that the output of this command should be captured to a file.
  38 ** @$(node.cores)@ evaluates to the number of cores available on the compute node at time the command is run.
  39 ** @$(tmpdir)@ evaluates to the local path for temporary directory the command should use for scratch data.
  40 ** @$(reference_collection)@ evaluates to the script_parameter @"reference_collection"@
  41 ** @$(dir $(...))@ constructs a local path to a directory representing the supplied Arvados collection.
  42 ** @$(file $(...))@ constructs a local path to a given file within the supplied Arvados collection.
  43 ** @$(glob $(...))@ searches the specified path based on a file glob pattern and evalutes to the first result.
  44 ** @$(basename $(...))@ evaluates to the supplied path with leading path portion and trailing filename extensions stripped
  45 * @"output_of"@ indicates that the @output@ of the @bwa-mem@ component should be used as the @"input"@ script parameter of @SortSam@.  Arvados uses these dependencies between components to automatically determine the correct order to run them.
  46
  47 When using @run-command@, the tool should write its output to the current working directory.  The output will be automatically uploaded to Keep when the job completes.
  48
  49 See the "run-command reference":{{site.baseurl}}/user/topics/run-command.html for more information about using @run-command@.
  50
  51 *Note:* When trying to get job reproducibility without re-computation, you need to set these parameters to their specific hashes. Using a version such as master in @"arvados_sdk_version"@ will grab the latest version hash, which will allow Arvados to re-compute your job if the sdk gets updated.
  52 * @"arvados_sdk_version"@ : The latest version can be found on the "Arvados Python sdk repository":https://dev.arvados.org/projects/arvados/repository/revisions/master/show/sdk/python under *Latest revisions*.
  53 * @"script_version"@ : The current version of your script in your git repository can be found by using the following command:
  54
  55 <notextile>
  56 <pre><code>~$ <span class="userinput">git rev-parse HEAD</span></code></pre>
  57 </notextile>
  58
  59 * @"docker_image"@ : The docker image hash used is found on the "Collection page":https://playground.arvados.org/collections/qr1hi-4zz18-dov6im679g3jr1n as the *Content address*.
  60
  61 h2. Running your pipeline
  62
  63 Your new pipeline template should appear at the top of the Workbench "pipeline&nbsp;templates":{{site.arvados_workbench_host}}/pipeline_templates page.  You can run your pipeline "using Workbench":tutorial-workflow-workbench.html or the "command line.":{{site.baseurl}}/user/topics/running-pipeline-command-line.html
  64
  65 Test data is available in the "Arvados Tutorial":{{site.arvados_workbench_host}}/projects/qr1hi-j7d0g-u7zg1qdaowykd8d project:
  66
  67 * Choose <i class="fa fa-fw fa-archive"></i> "Tutorial chromosome 19 reference (2463fa9efeb75e099685528b3b9071e0+438)":{{site.arvados_workbench_host}}/collections/2463fa9efeb75e099685528b3b9071e0+438 for the "reference_collection" parameter
  68 * Choose <i class="fa fa-fw fa-archive"></i> "Tutorial sample exome (3229739b505d2b878b62aed09895a55a+142)":{{site.arvados_workbench_host}}/collections/3229739b505d2b878b62aed09895a55a+142 for the "sample" parameter
  69
  70 For more information and examples for writing pipelines, see the "pipeline template reference":{{site.baseurl}}/api/methods/pipeline_templates.html
  71
  72 h2. Re-using your pipeline run
  73
  74 Arvados allows users to re-use jobs that have the same inputs in order to save computing time and resources. Users are able to change a job downstream without re-computing earlier jobs. This section shows which version control parameters should be tuned to make sure Arvados will not re-compute your jobs.
  75
  76 Note: Job reuse can only happen if all input collections do not change.
  77
  78 * @"arvados_sdk_version"@ : The arvados_sdk_version parameter is used to download the specific version of the Arvados sdk into the docker image. The latest version can be found in the "Arvados Python sdk repository":https://dev.arvados.org/projects/arvados/repository/revisions/master/show/sdk/python under *Latest revisions*. Make sure you set this to the same version as the previous run that you are trying to reuse.
  79 * @"script_version"@ : The script_version is the commit hash of the git branch that the crunch script resides in. This information can be found in your git repository by using the following command:
  80
  81 <notextile>
  82 <pre><code>~$ <span class="userinput">git rev-parse HEAD</span></code></pre>
  83 </notextile>
  84
  85 * @"docker_image"@ : This specifies the "Docker":https://www.docker.com/ runtime environment where jobs run their scripts. Docker version control is similar to git, and you can commit and push changes to your images. You must re-use the docker image hash from the previous run to use the same image. It can be found on the "Collection page":https://playground.arvados.org/collections/qr1hi-4zz18-dov6im679g3jr1n as the *Content address* or the *docker_image_locator* in a job's metadata.