Merge branch '8231-publish-arvbox' closes #8231
[arvados.git] / README
1 Welcome to the Arvados Project!
2
3 Arvados is an open source distributed computing platform for bioinformatics,
4 data science, and high throughput analysis of massive data sets.  Arvados
5 supports a variety of cloud, cluster and HPC environments.  Arvados consists of
6 a content-addressable storage system "Keep" for managing and storing large
7 collections of files; a containerized workflow engine "Crunch" designed for
8 versioning, reproducibilty, and provenance of computations; and a variety
9 related services and components including APIs, SDKs, and visual tools.
10
11 The main Arvados web site is
12   https://arvados.org
13
14 The Arvados public wiki is located at
15   https://dev.arvados.org/projects/arvados/wiki
16
17 The Arvados public bug tracker is located at
18   https://dev.arvados.org/projects/arvados/issues
19
20 For support see
21   http://doc.arvados.org/user/getting_started/community.html
22
23 Installation documentation is located at
24   http://doc.arvados.org/install
25
26 To try out Arvados quickly, you can use Arvbox, which provides Arvados
27 components pre-installed in a Docker container (requires Docker 1.9+).  After
28 cloning Arvados:
29
30   $ cd arvados/tools/arvbox/bin
31   $ ./arvbox start localdemo
32
33 See http://doc.arvados.org/install/arvbox.html for details and documentation.
34
35 If you wish to build the Arvados documentation yourself, follow the
36 instructions in doc/README to build the documentation, then consult the
37 "Install Guide".
38
39 See COPYING for information about Arvados Free Software licenses.