README.md

   1 Welcome to Arvados
   2 ==================
   3
   4 [Arvados](https://arvados.org) is a free software distributed computing platform
   5 for bioinformatics, data science, and high throughput analysis of massive data
   6 sets.  Arvados supports a variety of cloud, cluster and HPC environments.
   7
   8 Arvados consists of:
   9
  10 * *Keep*: a petabyte-scale content-addressed distributed storage system for managing and
  11   storing collections of files, accessible via HTTP and FUSE mount.
  12
  13 * *Crunch*: a Docker-based cluster and HPC workflow engine designed providing
  14   strong versioning, reproducibilty, and provenance of computations.
  15
  16 * Related services and components including a web workbench for managing files
  17   and compute jobs, REST APIs, SDKs, and other tools.
  18
  19 ## Quick start
  20
  21 Curoverse maintains an Arvados public cloud demo at
  22 [https://cloud.curoverse.com](https://cloud.curoverse.com).  A Google account
  23 is required to log in.
  24
  25 To try out Arvados on your local workstation, you can use Arvbox, which
  26 provides Arvados components pre-installed in a Docker container (requires
  27 Docker 1.9+).  After cloning the Arvados git repository:
  28
  29 ```
  30 $ cd arvados/tools/arvbox/bin
  31 $ ./arvbox start localdemo
  32 ```
  33
  34 In this mode you will only be able to connect to Arvbox from the same host.  To
  35 configure Arvbox to be accessible over a network and for other options see
  36 http://doc.arvados.org/install/arvbox.html for details.
  37
  38 ## Documentation
  39
  40 Complete documentation, including a User Guide, Installation documentation and
  41 API documentation is available at http://doc.arvados.org/
  42
  43 If you wish to build the Arvados documentation from a local git clone, see
  44 doc/README.textile for instructions.
  45
  46 ## Community
  47
  48 The [#arvados](irc://irc.oftc.net:6667/#arvados IRC) (Internet Relay Chat)
  49 channel at the
  50 [Open and Free Technology Community (irc.oftc.net)](http://www.oftc.net/oftc/)
  51 is available for live discussion and support.  You can use a traditional IRC
  52 client or [join OFTC over the web.](https://webchat.oftc.net/?channels=arvados)
  53
  54 The
  55 [Arvados user mailing list](http://lists.arvados.org/mailman/listinfo/arvados)
  56 is a forum for general discussion, questions, and news about Arvados
  57 development.  The
  58 [Arvados developer mailing list](http://lists.arvados.org/mailman/listinfo/arvados-dev)
  59 is a forum for more technical discussion, intended for developers and
  60 contributers to Arvados.
  61
  62 ## Development
  63
  64 [![Build Status](https://ci.curoverse.com/buildStatus/icon?job=arvados-api-server)](https://ci.curoverse.com/job/arvados-api-server/)
  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 ## Licensing
  75
  76 Arvados is Free Software.  See COPYING for information about Arvados Free
  77 Software licenses.