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 workflow engine designed providing strong
  14   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 To try out Arvados quickly, you can use Arvbox, which provides Arvados
  22 components pre-installed in a Docker container (requires Docker 1.9+).  After
  23 cloning the Arvados git repository:
  24
  25 ```
  26 $ cd arvados/tools/arvbox/bin
  27 $ ./arvbox start localdemo
  28 ```
  29
  30 See http://doc.arvados.org/install/arvbox.html for details and documentation.
  31
  32 ## Documentation
  33
  34 Complete documentation, including a User Guide, Installation documentation and
  35 API documentation is available at http://doc.arvados.org/
  36
  37 If you wish to build the Arvados documentation from a local git clone, see
  38 doc/README.textile for instructions.
  39
  40 ## Community
  41
  42 The [#arvados](irc://irc.oftc.net:6667/#arvados IRC) (Internet Relay Chat)
  43 channel at the
  44 [Open and Free Technology Community (irc.oftc.net)](http://www.oftc.net/oftc/)
  45 is available for live discussion and support.  You can use a traditional IRC
  46 client or [join OFTC over the web.](https://webchat.oftc.net/?channels=arvados)
  47
  48 The
  49 [Arvados user mailing list](http://lists.arvados.org/mailman/listinfo/arvados)
  50 is a forum for general discussion, questions, and news about Arvados
  51 development.  The
  52 [Arvados developer mailing list](http://lists.arvados.org/mailman/listinfo/arvados-dev)
  53 is a forum for more technical discussion, intended for developers and
  54 contributers to Arvados.
  55
  56 ## Development
  57
  58 [![Build Status](https://ci.curoverse.com/buildStatus/icon?job=arvados-api-server)](https://ci.curoverse.com/job/arvados-api-server/)
  59
  60 The Arvados public bug tracker is located at https://dev.arvados.org/projects/arvados/issues
  61
  62 Continuous integration is hosted at https://ci.curoverse.com/
  63
  64 ## Licensing
  65
  66 Arvados is Free Software.  See COPYING for information about Arvados Free
  67 Software licenses.