doc/user/index.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Welcome to Arvados!
   5
   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 tutorials on using Arvados to do data processing.
  11
  12 This user guide introduces how to use the major components of Arvados.  These are:
  13
  14 * Keep: Content-addressable cluster file system designed for robust storage of very large files, such as whole genome sequences running in the hundreds of gigabytes
  15 * Crunch: Cluster compute engine designed for genomic analysis, e.g. alignment, variant calls
  16 * Metadata Database: Information about the genomic data stored in Keep, such as genomic traits, human subjects
  17 * Workbench: Web interface to Arvados components
  18
  19 h2. Prerequisites
  20
  21 To get the most value out of this guide, you should be comfortable with the following:
  22
  23 # Using a secure shell client such as @ssh@ or @putty@ to log on to a remote server
  24 # Using the unix command line shell @bash@
  25 # Viewing and editing files using a unix text editor such as @vi@, @emacs@, or @nano@
  26 # Programming in @python@
  27 # Revision control using @git@
  28
  29 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@curoverse.com":mailto:arvados@curoverse.com .
  30
  31 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.
  32
  33 h2. Typographic conventions
  34
  35 This manual uses the following typographic conventions:
  36
  37 <notextile>
  38 <ul>
  39 <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 by the directory where you should  enter the command ('~' indicates your home directory) followed by '$', followed by the highlighted <span class="userinput">command to enter</span> (do not enter the '$'), and possibly followed by example command output in black.  For example, the following block indicates that you should type "ls foo" while in your home directory and the expected output will be "foo".
  40
  41 <pre><code>~$ <span class="userinput">ls foo</span>
  42 foo
  43 </code></pre></li>
  44
  45 <li>Code blocks inline with text emphasize specific <code>programs</code>, <code>files</code>, or <code>options</code> that are being discussed.</li>
  46 <li>Bold text emphasizes <b>specific items</b> to look when discussing Arvados Workbench pages.</li>
  47 <li>A sequence of steps separated by right arrows (<span class="rarr">&rarr;</span>) 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.
  48 </li>
  49 </ul>
  50 </notextile>
  51
  52 Now begin by "accessing the Arvados workbench.":getting_started/workbench.html