doc/user/index.textile

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Welcome to Arvados!
   5 navorder: 0
   6 ---
   7
   8 h1. Welcome to Arvados!
   9
  10 This guide is intended to introduce new users to the Arvados system.  It covers initial configuration required to use the system and then presents several tutorial on using Arvados to do data processing.
  11
  12 h2. Prerequisites
  13
  14 To get the most value out of this guide, you should be comfortable with the following:
  15
  16 # Using a secure shell client such as @ssh@ or @putty@ to log on to a remote server
  17 # Using the unix command line shell @bash@
  18 # Viewing and editing files using a unix text editor such as @vi@, @emacs@, or @nano@
  19 # Programming in @python@
  20
  21 It will also be helpful (but not essential) if you are familiar with revision control using @git@.
  22
  23 The examples in this guide uses the public Arvados instance located at "https://workbench.{{ site.arvados_api_host }}/":https://workbench.{{ site.arvados_api_host }}/ .  You must have an account in order to use this service.  If you would like to request an account, please send an email to "arvados@clinicalfuture.com":mailto:arvados@clinicalfuture.com .
  24
  25 If you are using a different Arvados instance replace @{{ site.arvados_api_host }}@ with your private instance in all of the examples in this guide.
  26
  27 This manual uses the following typographic conventions:
  28
  29 <notextile>
  30 <ul>
  31 <li>Code blocks which are set aside from the text indicate user input to the system.  Commands that should be entered into a Unix shell are indicated with a '$' at the beginning of the line, and the entire user input <span class="userinput">will be highlighted</span>, possibly followed by example command output in black:
  32 <pre><code>$ <span class="userinput">ls foo</span>
  33 foo
  34 </code></pre></li>
  35 <li>Code blocks inline with text emphasize specific <code>programs</code>, <code>files</code>, or <code>options</code> that are being discussed.</li>
  36 <li>Bold text emphasizes <b>specific items</b> to look when discussing Arvados Workbench pages.</li>
  37 <li>A sequence of steps separated by right arrows (%(rarr)&rarr;%) indicate a path the user should follow through the Arvados Workbench to access some piece of information under discussion.  The steps indicate a menu, hyperlink, column name, field name, or other label on the page that guide the user where to look or click.
  38 </li>
  39 </ul>
  40 </notextile>
  41
  42 Now begin by "accessing the Arvados workbench.":workbench.html