README.md

   1 [comment]: # (Copyright © The Arvados Authors. All rights reserved.)
   2 [comment]: # ()
   3 [comment]: # (SPDX-License-Identifier: CC-BY-SA-3.0)
   4
   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)
   6
   7 [Arvados](https://arvados.org) is a free software distributed computing platform
   8 for bioinformatics, data science, and high throughput analysis of massive data
   9 sets.  Arvados supports a variety of cloud, cluster and HPC environments.
  10
  11 Arvados consists of:
  12
  13 * *Keep*: a petabyte-scale content-addressed distributed storage system for managing and
  14   storing collections of files, accessible via a variety of methods including
  15   Arvados APIs, WebDAV, and FUSE file system mount.
  16
  17 * *Crunch*: a Docker-based cloud and HPC workflow engine designed providing
  18   strong versioning, reproducibilty, and provenance of large-scale computations.
  19
  20 * Related services and components including a web workbench for managing files
  21   and compute jobs, REST APIs, SDKs, and other tools.
  22
  23 ## Quick start
  24
  25 To try out Arvados on your local workstation, you can use Arvbox, which
  26 provides Arvados components pre-installed in a Docker container (requires
  27 Docker 1.9+).  After cloning the Arvados git repository:
  28
  29 ```
  30 $ cd arvados/tools/arvbox/bin
  31 $ ./arvbox start localdemo
  32 ```
  33
  34 In this mode you will only be able to connect to Arvbox from the same host.  To
  35 configure Arvbox to be accessible over a network and for other options see
  36 http://doc.arvados.org/install/arvbox.html for details.
  37
  38 ## Documentation
  39
  40 Complete documentation, including the [User Guide](https://doc.arvados.org/user/index.html), [Installation documentation](https://doc.arvados.org/install/index.html) and
  41 [API documentation](https://doc.arvados.org/api/index.html) is available at http://doc.arvados.org/
  42
  43 If you wish to build the Arvados documentation from a local git clone, see
  44 doc/README.textile for instructions.
  45
  46 ## Community
  47
  48 [![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)
  49
  50 The [Arvados community channel](https://gitter.im/arvados/community)
  51 channel at [gitter.im](https://gitter.im) is available for live
  52 discussion and support.
  53
  54 The [Arvados developement channel](https://gitter.im/arvados/development)
  55 channel at [gitter.im](https://gitter.im) is used to coordinate development.
  56
  57 The [Arvados user mailing list](http://lists.arvados.org/mailman/listinfo/arvados)
  58 is used to announce new versions and other news.
  59
  60 ## Reporting bugs
  61
  62 [Report a bug](https://dev.arvados.org/projects/arvados/issues/new) on the [dev.arvados.org Redmine site](https://dev.arvados.org).
  63
  64 ## Development and Contributing
  65
  66 See [CONTRIBUTING.md](CONTRIBUTING.md) for information about Arvados development and how to contribute to the Arvados project.
  67
  68 ## Licensing
  69
  70 Arvados is Free Software.  See COPYING for information about Arvados Free
  71 Software licenses.