doc/user/tutorials/tutorial-firstscript.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 navmenu: Tutorials
   5 title: "Writing a Crunch script"
   6 ...
   7
   8 This tutorial demonstrates how to create a new Arvados pipeline using the Arvados Python SDK.  The Arvados SDK supports access to advanced features not available using the @run-command@ wrapper, such as scheduling parallel tasks across nodes.
   9
  10 {% include 'tutorial_expectations' %}
  11
  12 This tutorial uses @$USER@ to denote your username.  Replace @$USER@ with your user name in all the following examples.
  13
  14 h2. Setting up Git
  15
  16 All Crunch scripts are managed through the Git revision control system.  Before you start using Git, you should do some basic configuration (you only need to do this the first time):
  17
  18 <notextile>
  19 <pre><code>~$ <span class="userinput">git config --global user.name "Your Name"</span>
  20 ~$ <span class="userinput">git config --global user.email $USER@example.com</span></code></pre>
  21 </notextile>
  22
  23 On the Arvados Workbench, navigate to "Code repositories":https://{{site.arvados_workbench_host}}/repositories.  You should see a repository with your user name listed in the *name* column.  Next to *name* is the column *push_url*.  Copy the *push_url* value associated with your repository.  This should look like <notextile><code>git@git.{{ site.arvados_api_host }}:$USER.git</code></notextile>.
  24
  25 Next, on the Arvados virtual machine, clone your Git repository:
  26
  27 <notextile>
  28 <pre><code>~$ <span class="userinput">cd $HOME</span> # (or wherever you want to install)
  29 ~$ <span class="userinput">git clone git@git.{{ site.arvados_api_host }}:$USER.git</span>
  30 Cloning into '$USER'...</code></pre>
  31 </notextile>
  32
  33 This will create a Git repository in the directory called @$USER@ in your home directory. Say yes when prompted to continue with connection.
  34 Ignore any warning that you are cloning an empty repository.
  35
  36 {% include 'notebox_begin' %}
  37 For more information about using Git, try
  38
  39 notextile. <pre><code>$ <span class="userinput">man gittutorial</span></code></pre>
  40
  41 or *"search Google for Git tutorials":http://google.com/#q=git+tutorial*.
  42 {% include 'notebox_end' %}
  43
  44 h2. Creating a Crunch script
  45
  46 Start by entering the @$USER@ directory created by @git clone@.  Next create a subdirectory called @crunch_scripts@ and change to that directory:
  47
  48 <notextile>
  49 <pre><code>~$ <span class="userinput">cd $USER</span>
  50 ~/$USER$ <span class="userinput">mkdir crunch_scripts</span>
  51 ~/$USER$ <span class="userinput">cd crunch_scripts</span></code></pre>
  52 </notextile>
  53
  54 Next, using @nano@ or your favorite Unix text editor, create a new file called @hash.py@ in the @crunch_scripts@ directory.
  55
  56 notextile. <pre>~/$USER/crunch_scripts$ <code class="userinput">nano hash.py</code></pre>
  57
  58 Add the following code to compute the MD5 hash of each file in a collection:
  59
  60 <notextile> {% code 'tutorial_hash_script_py' as python %} </notextile>
  61
  62 Make the file executable:
  63
  64 notextile. <pre><code>~/$USER/crunch_scripts$ <span class="userinput">chmod +x hash.py</span></code></pre>
  65
  66 {% include 'notebox_begin' %}
  67 The steps below describe how to execute the script after committing changes to Git. To run a single script locally for testing (bypassing the job queue) please see "debugging a crunch script":{{site.baseurl}}/user/topics/tutorial-job-debug.html.
  68
  69 {% include 'notebox_end' %}
  70
  71 Next, add the file to the staging area.  This tells @git@ that the file should be included on the next commit.
  72
  73 notextile. <pre><code>~/$USER/crunch_scripts$ <span class="userinput">git add hash.py</span></code></pre>
  74
  75 Next, commit your changes.  All staged changes are recorded into the local git repository:
  76
  77 <notextile>
  78 <pre><code>~/$USER/crunch_scripts$ <span class="userinput">git commit -m"my first script"</span>
  79 [master (root-commit) 27fd88b] my first script
  80  1 file changed, 45 insertions(+)
  81  create mode 100755 crunch_scripts/hash.py</code></pre>
  82 </notextile>
  83
  84 Finally, upload your changes to the Arvados server:
  85
  86 <notextile>
  87 <pre><code>~/$USER/crunch_scripts$ <span class="userinput">git push origin master</span>
  88 Counting objects: 4, done.
  89 Compressing objects: 100% (2/2), done.
  90 Writing objects: 100% (4/4), 682 bytes, done.
  91 Total 4 (delta 0), reused 0 (delta 0)
  92 To git@git.qr1hi.arvadosapi.com:$USER.git
  93  * [new branch]      master -> master</code></pre>
  94 </notextile>
  95
  96 h2. Create a pipeline template
  97
  98 Next, create a file that contains the pipeline definition:
  99
 100 <notextile>
 101 <pre><code>~/$USER/crunch_scripts$ <span class="userinput">cd ~</span>
 102 ~$ <span class="userinput">cat &gt;the_pipeline &lt;&lt;EOF
 103 {
 104   "name":"My md5 pipeline",
 105   "components":{
 106     "do_hash":{
 107       "script":"hash.py",
 108       "script_parameters":{
 109         "input":{
 110           "required": true,
 111           "dataclass": "Collection"
 112         }
 113       },
 114       "repository":"$USER",
 115       "script_version":"master",
 116       "output_is_persistent":true,
 117       "runtime_constraints":{
 118         "docker_image":"arvados/jobs-java-bwa-samtools"
 119       }
 120     }
 121   }
 122 }
 123 EOF
 124 </span></code></pre>
 125 </notextile>
 126
 127 * @"repository"@ is the name of a git repository to search for the script version.  You can access a list of available git repositories on the Arvados Workbench under "Code repositories":https://{{site.arvados_workbench_host}}/repositories.
 128 * @"script_version"@ specifies the version of the script that you wish to run.  This can be in the form of an explicit Git revision hash, a tag, or a branch (in which case it will use the HEAD of the specified branch).  Arvados logs the script version that was used in the run, enabling you to go back and re-run any past job with the guarantee that the exact same code will be used as was used in the previous run.
 129 * @"script"@ specifies the filename of the script to run.  Crunch expects to find this in the @crunch_scripts/@ subdirectory of the Git repository.
 130
 131 Now, use @arv pipeline_template create@ to register your pipeline template in Arvados:
 132
 133 <notextile>
 134 <pre><code>~$ <span class="userinput">arv pipeline_template create --pipeline-template "$(cat the_pipeline)"</span>
 135 </code></pre>
 136 </notextile>
 137
 138 h2. Running your pipeline
 139
 140 Your new pipeline template should appear at the top of the Workbench "pipeline&nbsp;templates":https://{{ site.arvados_workbench_host }}/pipeline_templates page.  You can run your pipeline "using Workbench":tutorial-pipeline-workbench.html or the "command line.":{{site.baseurl}}/user/topics/running-pipeline-command-line.html
 141
 142 For more information and examples for writing pipelines, see the "pipeline template reference":{{site.baseurl}}/api/schema/PipelineTemplate.html