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