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 Veritas Genetics maintains a public installation of Arvados for evaluation and trial use, the [Arvados Playground](https://playground.arvados.org). A Google account is required to log in.
  23
  24 To try out Arvados on your local workstation, you can use Arvbox, which
  25 provides Arvados components pre-installed in a Docker container (requires
  26 Docker 1.9+).  After cloning the Arvados git repository:
  27
  28 ```
  29 $ cd arvados/tools/arvbox/bin
  30 $ ./arvbox start localdemo
  31 ```
  32
  33 In this mode you will only be able to connect to Arvbox from the same host.  To
  34 configure Arvbox to be accessible over a network and for other options see
  35 http://doc.arvados.org/install/arvbox.html for details.
  36
  37 ## Documentation
  38
  39 Complete documentation, including a User Guide, Installation documentation and
  40 API documentation is available at http://doc.arvados.org/
  41
  42 If you wish to build the Arvados documentation from a local git clone, see
  43 doc/README.textile for instructions.
  44
  45 ## Community
  46
  47 The [#arvados](irc://irc.oftc.net:6667/#arvados) IRC (Internet Relay Chat)
  48 channel at the
  49 [Open and Free Technology Community (irc.oftc.net)](http://www.oftc.net/oftc/)
  50 is available for live discussion and support.  You can use a traditional IRC
  51 client or [join OFTC over the web.](https://webchat.oftc.net/?channels=arvados)
  52
  53 The
  54 [Arvados user mailing list](http://lists.arvados.org/mailman/listinfo/arvados)
  55 is a forum for general discussion, questions, and news about Arvados
  56 development.  The
  57 [Arvados developer mailing list](http://lists.arvados.org/mailman/listinfo/arvados-dev)
  58 is a forum for more technical discussion, intended for developers and
  59 contributors to Arvados.
  60
  61 ## Development
  62
  63 [![Build Status](https://ci.curoverse.com/buildStatus/icon?job=run-tests)](https://ci.curoverse.com/job/run-tests/)
  64 [![Go Report Card](https://goreportcard.com/badge/github.com/curoverse/arvados)](https://goreportcard.com/report/github.com/curoverse/arvados)
  65
  66 The Arvados public bug tracker is located at https://dev.arvados.org/projects/arvados/issues
  67
  68 Continuous integration is hosted at https://ci.curoverse.com/
  69
  70 Instructions for setting up a development environment and working on specific
  71 components can be found on the
  72 ["Hacking Arvados" page of the Arvados wiki](https://dev.arvados.org/projects/arvados/wiki/Hacking).
  73
  74 ## Contributing
  75
  76 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`.
  77
  78 ## Licensing
  79
  80 Arvados is Free Software.  See COPYING for information about Arvados Free
  81 Software licenses.