1 [comment]: # (Copyright © The Arvados Authors. All rights reserved.)
3 [comment]: # (SPDX-License-Identifier: CC-BY-SA-3.0)
5 [![Join the chat at https://gitter.im/arvados/community](https://badges.gitter.im/arvados/community.svg)](https://gitter.im/arvados/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | [Installing Arvados](https://doc.arvados.org/install/index.html) | [Installing Client SDKs](https://doc.arvados.org/sdk/index.html) | [Report a bug](https://dev.arvados.org/projects/arvados/issues/new) | [Development and Contributing](CONTRIBUTING.md)
7 <img align="right" src="doc/images/dax.png" height="240px">
9 [Arvados](https://arvados.org) is an open source platform for
10 managing, processing, and sharing genomic and other large scientific
11 and biomedical data. With Arvados, bioinformaticians run and scale
12 compute-intensive workflows, developers create biomedical
13 applications, and IT administrators manage large compute and storage
16 The key components of Arvados are:
20 Keep is the Arvados storage system for managing and storing large
21 collections of files. Keep combines content addressing and a
22 distributed storage architecture resulting in both high reliability
23 and high throughput. Every file stored in Keep can be accurately
24 verified every time it is retrieved. Keep supports the creation of
25 collections as a flexible way to define data sets without having to
26 re-organize or needlessly copy data. Keep works on a wide range of
27 underlying filesystems and object stores.
31 Crunch is the orchestration system for running [Common Workflow Language](https://www.commonwl.org) workflows. It is
32 designed to maintain data provenance and workflow
33 reproducibility. Crunch automatically tracks data inputs and outputs
34 through Keep and executes workflow processes in Docker containers. In
35 a cloud environment, Crunch optimizes costs by scaling compute on demand.
39 The Workbench web application allows users to interactively access
40 Arvados functionality. It is especially helpful for querying and
41 browsing data, visualizing provenance, and tracking the progress of
46 The command line interface (CLI) provides convenient access to Arvados
47 functionality in the Arvados platform from the command line.
51 Arvados is designed to be integrated with existing infrastructure. All
52 the services in Arvados are accessed through a RESTful API. SDKs are
53 available for Python, Go, R, Perl, Ruby, and Java.
57 To try out Arvados on your local workstation, you can use Arvbox, which
58 provides Arvados components pre-installed in a Docker container (requires
59 Docker 1.9+). After cloning the Arvados git repository:
62 $ cd arvados/tools/arvbox/bin
63 $ ./arvbox start localdemo
66 In this mode you will only be able to connect to Arvbox from the same host. To
67 configure Arvbox to be accessible over a network and for other options see
68 http://doc.arvados.org/install/arvbox.html for details.
72 Complete documentation, including the [User Guide](https://doc.arvados.org/user/index.html), [Installation documentation](https://doc.arvados.org/install/index.html), [Administrator documentation](https://doc.arvados.org/admin/index.html) and
73 [API documentation](https://doc.arvados.org/api/index.html) is available at http://doc.arvados.org/
75 If you wish to build the Arvados documentation from a local git clone, see
76 [doc/README.textile](doc/README.textile) for instructions.
80 [![Join the chat at https://gitter.im/arvados/community](https://badges.gitter.im/arvados/community.svg)](https://gitter.im/arvados/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
82 The [Arvados community channel](https://gitter.im/arvados/community)
83 channel at [gitter.im](https://gitter.im) is available for live
84 discussion and support.
86 The [Arvados developement channel](https://gitter.im/arvados/development)
87 channel at [gitter.im](https://gitter.im) is used to coordinate development.
89 The [Arvados user mailing list](http://lists.arvados.org/mailman/listinfo/arvados)
90 is used to announce new versions and other news.
92 All participants are expected to abide by the [Arvados Code of Conduct](CODE_OF_CONDUCT.md).
96 [Report a bug](https://dev.arvados.org/projects/arvados/issues/new) on [dev.arvados.org](https://dev.arvados.org).
98 # Development and Contributing
100 See [CONTRIBUTING](CONTRIBUTING.md) for information about Arvados development and how to contribute to the Arvados project.
102 The [development road map](https://dev.arvados.org/issues/gantt?utf8=%E2%9C%93&set_filter=1&gantt=1&f%5B%5D=project_id&op%5Bproject_id%5D=%3D&v%5Bproject_id%5D%5B%5D=49&f%5B%5D=&zoom=1) outlines some of the project priorities over the next twelve months.
106 Arvados is Free Software. See [COPYING](COPYING) for information about the open source licenses used in Arvados.