Add input parameter tables and source code link for each crunch example.
[arvados.git] / doc / user / tutorial-firstscript.textile
1 ---
2 layout: default
3 navsection: userguide
4 title: "Tutorial: Writing a Crunch script"
5 navorder: 102
6 ---
7
8 {% include alert-stub.html %}
9
10 h1. Tutorial 2: Writing a Crunch script
11
12 In this tutorial, we will write the "hash" script demonstrated in the first tutorial.
13
14 *This tutorial assumes that you are logged into an Arvados VM instance, as described in "accessing arvados over ssh.":ssh-access.html#login*
15
16 h2. Setting up Git
17
18
19
20 h3. Inspect the code
21
22 The @script@ and @script_version@ attributes of a Job allow you to confirm the code that was used to run the job. Specifically, @script@ refers to a file in the @/crunch_scripts@ directory in the tree indicated by the commit hash @script_version@.
23
24 Example:
25
26 <pre>
27 cd
28 git clone git://github.com/clinicalfuture/arvados.git
29 cd arvados
30 git checkout $the_version
31 less crunch_scripts/hash
32 </pre>
33
34 <!--
35 _If we're going to direct the user to open up the code, some
36 discussion of the python API is probably in order.  If the hash
37 job is going to be the canonical first crunch map reduce program
38 for everybody, than we should break down the program line-by-line and
39 explain every step in detail._
40 -->
41
42