| Installing Arvados | Installing Client SDKs | Report a bug | Development and Contributing

Arvados is an open source platform formanaging, processing, and sharing genomic and other large scientificand biomedical data. With Arvados, bioinformaticians run and scalecompute-intensive workflows, developers create biomedicalapplications, and IT administrators manage large compute and storageresources.

The key components of Arvados are:

• Keep: Keep is the Arvados storage system for managing and storing largecollections of files. Keep combines content addressing and adistributed storage architecture resulting in both high reliabilityand high throughput. Every file stored in Keep can be accuratelyverified every time it is retrieved. Keep supports the creation ofcollections as a flexible way to define data sets without having tore-organize or needlessly copy data. Keep works on a wide range ofunderlying filesystems and object stores.

• Crunch: Crunch is the orchestration system for running Common Workflow Language workflows. It isdesigned to maintain data provenance and workflowreproducibility. Crunch automatically tracks data inputs and outputsthrough Keep and executes workflow processes in Docker containers. Ina cloud environment, Crunch optimizes costs by scaling compute on demand.

• Workbench: The Workbench web application allows users to interactively accessArvados functionality. It is especially helpful for querying andbrowsing data, visualizing provenance, and tracking the progress ofworkflows.

• Command Line tools: The command line interface (CLI) provides convenient access to Arvadosfunctionality in the Arvados platform from the command line.

• API and SDKs: Arvados is designed to be integrated with existing infrastructure. Allthe services in Arvados are accessed through a RESTful API. SDKs areavailable for Python, Go, R, Perl, Ruby, and Java.

Quick start

To try out Arvados on your local workstation, you can use Arvbox, whichprovides Arvados components pre-installed in a Docker container (requiresDocker 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. Toconfigure Arvbox to be accessible over a network and for other options seehttp://doc.arvados.org/install/arvbox.html for details.

Documentation

Complete documentation, including the User Guide, Installation documentation, Administrator documentation andAPI documentation is available at http://doc.arvados.org/

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

Community

The Arvados community channelchannel at gitter.im is available for livediscussion and support.

The Arvados developement channelchannel at gitter.im is used to coordinate development.

The Arvados user mailing listis used to announce new versions and other news.

All participants are expected to abide by the Arvados Code of Conduct.

Reporting bugs

Report a bug on dev.arvados.org.

Development and Contributing

See CONTRIBUTING for information about Arvados development and how to contribute to the Arvados project.

The development road map outlines some of the project priorities over the next twelve months.

Licensing

Arvados is Free Software. See COPYING for information about the open source licenses used in Arvados.