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 [Arvados](https://arvados.org) is a free software distributed computing platform
   6 for bioinformatics, data science, and high throughput analysis of massive data
   7 sets.  Arvados supports a variety of cloud, cluster and HPC environments.
   8
   9 Arvados consists of:
  10
  11 * *Keep*: a petabyte-scale content-addressed distributed storage system for managing and
  12   storing collections of files, accessible via HTTP and FUSE mount.
  13
  14 * *Crunch*: a Docker-based cluster and HPC workflow engine designed providing
  15   strong versioning, reproducibilty, and provenance of computations.
  16
  17 * Related services and components including a web workbench for managing files
  18   and compute jobs, REST APIs, SDKs, and other tools.
  19
  20 ## Quick start
  21
  22 To try out Arvados on your local workstation, you can use Arvbox, which
  23 provides Arvados components pre-installed in a Docker container (requires
  24 Docker 1.9+).  After cloning the Arvados git repository:
  25
  26 ```
  27 $ cd arvados/tools/arvbox/bin
  28 $ ./arvbox start localdemo
  29 ```
  30
  31 In this mode you will only be able to connect to Arvbox from the same host.  To
  32 configure Arvbox to be accessible over a network and for other options see
  33 http://doc.arvados.org/install/arvbox.html for details.
  34
  35 ## Documentation
  36
  37 Complete documentation, including a User Guide, Installation documentation and
  38 API documentation is available at http://doc.arvados.org/
  39
  40 If you wish to build the Arvados documentation from a local git clone, see
  41 doc/README.textile for instructions.
  42
  43 ## Community
  44
  45 [![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)
  46
  47 The [arvados community channel](https://gitter.im/arvados/community)
  48 channel at [gitter.im](https://gitter.im) is available for live
  49 discussion and support.
  50
  51 The
  52 [Arvados user mailing list](http://lists.arvados.org/mailman/listinfo/arvados)
  53 is a forum for general discussion, questions, and news about Arvados
  54 development.  The
  55 [Arvados developer mailing list](http://lists.arvados.org/mailman/listinfo/arvados-dev)
  56 is a forum for more technical discussion, intended for developers and
  57 contributors to Arvados.
  58
  59 ## Development
  60
  61 [![Build Status](https://ci.arvados.org/buildStatus/icon?job=run-tests)](https://ci.arvados.org/job/run-tests/)
  62 [![Go Report Card](https://goreportcard.com/badge/github.com/arvados/arvados)](https://goreportcard.com/report/github.com/arvados/arvados)
  63
  64 The Arvados public bug tracker is located at https://dev.arvados.org/projects/arvados/issues
  65
  66 Continuous integration is hosted at https://ci.arvados.org/
  67
  68 Instructions for setting up a development environment and working on specific
  69 components can be found on the
  70 ["Hacking Arvados" page of the Arvados wiki](https://dev.arvados.org/projects/arvados/wiki/Hacking).
  71
  72 ## Contributing
  73
  74 When making a pull request, please ensure *every git commit message* includes a one-line [Developer Certificate of Origin](https://dev.arvados.org/projects/arvados/wiki/Developer_Certificate_Of_Origin). If you have already made commits without it, fix them with `git commit --amend` or `git rebase`.
  75
  76 ## Licensing
  77
  78 Arvados is Free Software.  See COPYING for information about Arvados Free
  79 Software licenses.