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 a free software distributed computing platform
10 for bioinformatics, data science, and high throughput analysis of massive data
11 sets. Arvados supports a variety of cloud, cluster and HPC environments.
15 * *Keep*: a petabyte-scale content-addressed distributed storage system for managing and
16 storing collections of files, accessible via a variety of methods including
17 Arvados APIs, WebDAV, and FUSE file system mount.
19 * *Crunch*: a Docker-based cloud and HPC workflow engine designed providing
20 strong versioning, reproducibilty, and provenance of large-scale computations.
22 * Related services and components including a web workbench for managing files
23 and compute jobs, REST APIs, SDKs, and other tools.
27 To try out Arvados on your local workstation, you can use Arvbox, which
28 provides Arvados components pre-installed in a Docker container (requires
29 Docker 1.9+). After cloning the Arvados git repository:
32 $ cd arvados/tools/arvbox/bin
33 $ ./arvbox start localdemo
36 In this mode you will only be able to connect to Arvbox from the same host. To
37 configure Arvbox to be accessible over a network and for other options see
38 http://doc.arvados.org/install/arvbox.html for details.
42 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
43 [API documentation](https://doc.arvados.org/api/index.html) is available at http://doc.arvados.org/
45 If you wish to build the Arvados documentation from a local git clone, see
46 [doc/README.textile](doc/README.textile) for instructions.
50 [![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)
52 The [Arvados community channel](https://gitter.im/arvados/community)
53 channel at [gitter.im](https://gitter.im) is available for live
54 discussion and support.
56 The [Arvados developement channel](https://gitter.im/arvados/development)
57 channel at [gitter.im](https://gitter.im) is used to coordinate development.
59 The [Arvados user mailing list](http://lists.arvados.org/mailman/listinfo/arvados)
60 is used to announce new versions and other news.
64 [Report a bug](https://dev.arvados.org/projects/arvados/issues/new) on [dev.arvados.org](https://dev.arvados.org).
66 # Development and Contributing
68 See [CONTRIBUTING](CONTRIBUTING.md) for information about Arvados development and how to contribute to the Arvados project.
70 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.
74 Arvados is Free Software. See [COPYING](COPYING) for information about the open source licenses used in Arvados.