README.md

   1 [Arvados](https://arvados.org) is a free software distributed computing platform
   2 for bioinformatics, data science, and high throughput analysis of massive data
   3 sets.  Arvados supports a variety of cloud, cluster and HPC environments.
   4
   5 Arvados consists of:
   6
   7 * *Keep*: a petabyte-scale content-addressed distributed storage system for managing and
   8   storing collections of files, accessible via HTTP and FUSE mount.
   9
  10 * *Crunch*: a Docker-based cluster and HPC workflow engine designed providing
  11   strong versioning, reproducibilty, and provenance of computations.
  12
  13 * Related services and components including a web workbench for managing files
  14   and compute jobs, REST APIs, SDKs, and other tools.
  15
  16 ## Quick start
  17
  18 Curoverse maintains an Arvados public cloud demo at
  19 [https://cloud.curoverse.com](https://cloud.curoverse.com).  A Google account
  20 is required to log in.
  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 The [#arvados](irc://irc.oftc.net:6667/#arvados IRC) (Internet Relay Chat)
  46 channel at the
  47 [Open and Free Technology Community (irc.oftc.net)](http://www.oftc.net/oftc/)
  48 is available for live discussion and support.  You can use a traditional IRC
  49 client or [join OFTC over the web.](https://webchat.oftc.net/?channels=arvados)
  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 contributers to Arvados.
  58
  59 ## Development
  60
  61 [![Build Status](https://ci.curoverse.com/buildStatus/icon?job=run-tests)](https://ci.curoverse.com/job/run-tests/)
  62 [![Go Report Card](https://goreportcard.com/badge/github.com/curoverse/arvados)](https://goreportcard.com/report/github.com/curoverse/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.curoverse.com/
  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 ## Licensing
  73
  74 Arvados is Free Software.  See COPYING for information about Arvados Free
  75 Software licenses.