an open source platform for managing and analyzing biomedical big data
Ruby Python Go JavaScript HTML Shell Other
Latest commit d069de0 Feb 17, 2017 @tomclegg tomclegg Merge branch '11127-delete-trash-with-links'
refs #11127

README.md

Arvados is a free software distributed computing platform for bioinformatics, data science, and high throughput analysis of massive data sets. Arvados supports a variety of cloud, cluster and HPC environments.

Arvados consists of:

  • Keep: a petabyte-scale content-addressed distributed storage system for managing and storing collections of files, accessible via HTTP and FUSE mount.

  • Crunch: a Docker-based cluster and HPC workflow engine designed providing strong versioning, reproducibilty, and provenance of computations.

  • Related services and components including a web workbench for managing files and compute jobs, REST APIs, SDKs, and other tools.

Quick start

Curoverse maintains an Arvados public cloud demo at https://cloud.curoverse.com. A Google account is required to log in.

To try out Arvados on your local workstation, you can use Arvbox, which provides Arvados components pre-installed in a Docker container (requires Docker 1.9+). After cloning the Arvados git repository:

$ cd arvados/tools/arvbox/bin
$ ./arvbox start localdemo

In this mode you will only be able to connect to Arvbox from the same host. To configure Arvbox to be accessible over a network and for other options see http://doc.arvados.org/install/arvbox.html for details.

Documentation

Complete documentation, including a User Guide, Installation documentation and API documentation is available at http://doc.arvados.org/

If you wish to build the Arvados documentation from a local git clone, see doc/README.textile for instructions.

Community

The #arvados (Internet Relay Chat) channel at the Open and Free Technology Community (irc.oftc.net) is available for live discussion and support. You can use a traditional IRC client or join OFTC over the web.

The Arvados user mailing list is a forum for general discussion, questions, and news about Arvados development. The Arvados developer mailing list is a forum for more technical discussion, intended for developers and contributers to Arvados.

Development

Build Status Go Report Card

The Arvados public bug tracker is located at https://dev.arvados.org/projects/arvados/issues

Continuous integration is hosted at https://ci.curoverse.com/

Instructions for setting up a development environment and working on specific components can be found on the "Hacking Arvados" page of the Arvados wiki.

Licensing

Arvados is Free Software. See COPYING for information about Arvados Free Software licenses.