X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/cc414357e4eda3ed2060307f5b821385ae3d74bb..21822c130f0d19eb4082a3b6bc99e45ce1017a8a:/doc/user/index.html.textile.liquid?ds=sidebyside diff --git a/doc/user/index.html.textile.liquid b/doc/user/index.html.textile.liquid index 48d3f86ebb..09aa79868c 100644 --- a/doc/user/index.html.textile.liquid +++ b/doc/user/index.html.textile.liquid @@ -2,33 +2,32 @@ layout: default navsection: userguide title: Welcome to Arvados! - ... -h1. Welcome to Arvados! - -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. +This guide is intended to introduce new users to the Arvados system. It covers initial configuration required to access the system and then presents several tutorials on using Arvados to do data processing. This user guide introduces how to use the major components of Arvados. These are: * 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 -* Crunch: Cluster compute engine designed for genomic analysis, e.g. alignment, variant calls -* Metadata Database: Information about the genomic data stored in Keep, such as genomic traits, human subjects -* Workbench: Web interface to Arvados components +* Crunch: Cluster compute engine designed for genomic analysis, such as alignment and variant calls +* Metadata Database: Information about the genomic data stored in Keep, such as genomic traits and human subjects +* Workbench: Arvados' Web interface h2. Prerequisites To get the most value out of this guide, you should be comfortable with the following: -# Using a secure shell client such as @ssh@ or @putty@ to log on to a remote server -# Using the unix command line shell @bash@ -# Viewing and editing files using a unix text editor such as @vi@, @emacs@, or @nano@ -# Programming in @python@ -# Revision control using @git@ +# Using a secure shell client such as SSH or PuTTY to log on to a remote server +# Using the Unix command line shell, Bash +# Viewing and editing files using a unix text editor such as vi, Emacs, or nano +# Programming in Python +# Revision control using Git + +We also recommend you read the "Arvados Platform Overview":https://arvados.org/projects/arvados/wiki#Platform-Overview for an introduction and background information about Arvados. -The examples in this guide uses the Arvados instance located at "https://{{ site.arvados_workbench_host }}/":https://{{ site.arvados_workbench_host }}/ . If you are using a different Arvados instance replace @{{ site.arvados_workbench_host }}@ with your private instance in all of the examples in this guide. +The examples in this guide use the Arvados instance located at "https://{{ site.arvados_workbench_host }}/":https://{{ site.arvados_workbench_host }}/. If you are using a different Arvados instance replace @{{ site.arvados_workbench_host }}@ with your private instance in all of the examples in this guide. -The Arvados public beta instance is located at "https://workbench.qr1hi.arvadosapi.com/":https://workbench.qr1hi.arvadosapi.com/ . 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 . +The Arvados public beta instance is located at "https://workbench.qr1hi.arvadosapi.com/":https://workbench.qr1hi.arvadosapi.com/. 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. h2. Typographic conventions @@ -36,17 +35,16 @@ This manual uses the following typographic conventions: -Now begin by "accessing the Arvados workbench.":getting_started/workbench.html