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 <img align="right" src="doc/images/dax.png" height="240px">
   8
   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.
  12
  13 Arvados consists of:
  14
  15 * *Keep*: A petabyte-scale content-addressed distributed storage
  16   system for storing, managing and versioning collections of files.
  17   Like git for big data.  Interoperable data access by a variety of
  18   methods including WebDAV, FUSE file system mount, and Arvados APIs.
  19
  20 * *Crunch*: A container-based cloud and HPC workflow engine providing
  21   strong versioning, reproducibilty, and provenance of large-scale
  22   computations.  Supports [Common Workflow
  23   Language](https://commonwl.org) for describing workflows.
  24
  25 * Related services and components including a web workbench for managing files
  26   and compute jobs, REST APIs, SDKs, and other tools.
  27
  28 # Quick start
  29
  30 To try out Arvados on your local workstation, you can use Arvbox, which
  31 provides Arvados components pre-installed in a Docker container (requires
  32 Docker 1.9+).  After cloning the Arvados git repository:
  33
  34 ```
  35 $ cd arvados/tools/arvbox/bin
  36 $ ./arvbox start localdemo
  37 ```
  38
  39 In this mode you will only be able to connect to Arvbox from the same host.  To
  40 configure Arvbox to be accessible over a network and for other options see
  41 http://doc.arvados.org/install/arvbox.html for details.
  42
  43 # Documentation
  44
  45 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
  46 [API documentation](https://doc.arvados.org/api/index.html) is available at http://doc.arvados.org/
  47
  48 If you wish to build the Arvados documentation from a local git clone, see
  49 [doc/README.textile](doc/README.textile) for instructions.
  50
  51 # Community
  52
  53 [![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)
  54
  55 The [Arvados community channel](https://gitter.im/arvados/community)
  56 channel at [gitter.im](https://gitter.im) is available for live
  57 discussion and support.
  58
  59 The [Arvados developement channel](https://gitter.im/arvados/development)
  60 channel at [gitter.im](https://gitter.im) is used to coordinate development.
  61
  62 The [Arvados user mailing list](http://lists.arvados.org/mailman/listinfo/arvados)
  63 is used to announce new versions and other news.
  64
  65 # Reporting bugs
  66
  67 [Report a bug](https://dev.arvados.org/projects/arvados/issues/new) on [dev.arvados.org](https://dev.arvados.org).
  68
  69 # Development and Contributing
  70
  71 See [CONTRIBUTING](CONTRIBUTING.md) for information about Arvados development and how to contribute to the Arvados project.
  72
  73 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
  75 # Licensing
  76
  77 Arvados is Free Software.  See [COPYING](COPYING) for information about the open source licenses used in Arvados.