--- layout: default navsection: userguide title: "Writing a Crunch script" navorder: 113 --- h1. Tutorial: Writing a Crunch script In this tutorial, we will write the "hash" script demonstrated in the first tutorial. *This tutorial assumes that you are "logged into an Arvados VM instance":{{site.basedoc}}/user/getting_started/ssh-access.html#login, and have a "working environment.":{{site.basedoc}}/user/getting_started/check-environment.html* This tutorial uses _you_ to denote your username. Replace _you_ with your user name in all the following examples. h2. Setting up Git As discussed in the previous tutorial, all Crunch scripts are managed through the @git@ revision control system. First, you should do some basic configuration for git (you only need to do this the first time):

$ git config --global user.name "Your Name"
$ git config --global user.email you@example.com

On the Arvados Workbench, navigate to _Access %(rarr)→% Repositories._ You should see two repositories, one named "arvados" (under the *name* column) and a second with your user name. Next to *name* is the column *push_url*. Copy the *push_url* cell associated with your repository. This should look like git@git.{{ site.arvados_api_host }}:you.git. Next, on the Arvados virtual machine, clone your git repository:

$ git clone git://git.{{ site.arvados_api_host }}:you.git
Cloning into 'you'...

This will create an git checkout in the directory called @you@. {% include notebox-begin.html %} For more information about using @git@, try notextile.

$ man gittutoral

or "click here search Google for git tutorials":http://google.com/#q=git+tutorial {% include notebox-end.html %} h2. Creating a Crunch script Start by entering the @you@ directory, creating a subdirectory called @crunch_scripts@ and changing to that directory:

$ cd you
$ mkdir crunch_scripts
$ cd crunch_scripts

Next, using your favorite text editor, create a new file called @hash.py@ in the @crunch_scripts@ directory. Add the following code to compute the md5 hash of each file in a collection:

{% include tutorial_hash_script.py %}

Make the file executable: notextile.

$ chmod +x hash.py

Next, add the file to @git@ staging. This tells @git@ that the file should be included on the next commit. notextile.

$ git add hash.py

Next, commit your changes to git. All staged changes are recorded into the local @git@ repository:

$ git commit -m"my first script"
[master (root-commit) 27fd88b] my first script
 1 file changed, 33 insertions(+)
 create mode 100755 crunch_scripts/hash.py

Finally, upload your changes to the Arvados server:

$ git push origin master
Counting objects: 4, done.
Compressing objects: 100% (2/2), done.
Writing objects: 100% (4/4), 682 bytes, done.
Total 4 (delta 0), reused 0 (delta 0)
To git@git.qr1hi.arvadosapi.com:you.git
 * [new branch]      master -> master

You should now be able to run your script using Crunch, similar to how we did it in the "first tutorial.":tutorial-job1.html The field @"script_version"@ should be @you:master@ to tell Crunch to run the script that you just uploaded.

$ cat >the_job <<EOF
{
 "script": "hash.py",
 "script_version": "you:master",
 "script_parameters":
 {
  "input": "33a9f3842b01ea3fdf27cc582f5ea2af"
 }
}
EOF
$ arv -h job create --job "$(cat the_job)"
{
 ...
 "uuid":"qr1hi-xxxxx-xxxxxxxxxxxxxxx"
 ...
}
$ arv -h job get --uuid qr1hi-xxxxx-xxxxxxxxxxxxxxx
{
 ...
 "output":"880b55fb4470b148a447ff38cacdd952+54+K@qr1hi",
 ...
}
$ arv keep get 880b55fb4470b148a447ff38cacdd952+54+K@qr1hi/md5sum.txt
44b8ae3fde7a8a88d2f7ebd237625b4f var-GS000016015-ASM.tsv.bz2

Next, "debugging a crunch script.":tutorial-job-debug.html