X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/720d44bbcf5299dd243a3b29e8b18c207290660b..0eb72b526bf8bbb011551ecf019f604e17a534f1:/doc/user/index.html.textile.liquid diff --git a/doc/user/index.html.textile.liquid b/doc/user/index.html.textile.liquid index c8aee3cd05..b894e3d5e9 100644 --- a/doc/user/index.html.textile.liquid +++ b/doc/user/index.html.textile.liquid @@ -1,34 +1,24 @@ --- layout: default navsection: userguide -title: Welcome to Arvados! - +title: Welcome to Arvados™! ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. -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 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 +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} -h2. Prerequisites +_If you are new to Arvados, please try the Quickstart on the documentation homepage instead of this detailed User Guide._ -To get the most value out of this guide, you should be comfortable with the following: +This guide provides a reference for using Arvados to solve big data bioinformatics problems, including: -# 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@ +* Robust storage of very large files, such as whole genome sequences, using the "Arvados Keep":{{site.baseurl}}/user/tutorials/tutorial-keep.html content-addressable cluster file system. +* Running compute-intensive genomic analysis pipelines, such as alignment and variant calls using the "Arvados Crunch":{{site.baseurl}}/user/tutorials/intro-crunch.html cluster compute engine. +* Storing and querying metadata about genome sequence files, such as human subjects and their phenotypic traits using the "Arvados Metadata Database.":{{site.baseurl}}/user/topics/tutorial-trait-search.html +* Accessing, organizing, and sharing data, pipelines and results using the "Arvados Workbench":{{site.baseurl}}/user/getting_started/workbench.html web application. -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 . - -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. +The examples in this guide use the public Arvados instance located at {{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. h2. Typographic conventions @@ -36,15 +26,15 @@ This manual uses the following typographic conventions: - -Now begin by "accessing the Arvados workbench.":getting_started/workbench.html