Arvados

h1. Arvados Contributor Wiki

This wiki has information related to the open source project. It's a work in progress, so come back often for updates and feel free to become a contributor.  

!>{width: 50%}/images/dax.png!

{{toc}}

h2. Platform Overview

* [[Introduction to Arvados]]

* [[Technical Architecture]]

* [[Cloud Operating Systems and Virtualization]]

* [[Provenance and Reproducibility]]

* [[Federation and Data Sharing]]

* [[Glossary of Arvados Terms]]

* [[External Resources]]

h2. Using Arvados

* "User Guide":http://doc.arvados.org/user/ — How to manage data and do analysis with Arvados.

* "Running Common Workflow Language (CWL) workflows on Arvados":http://doc.arvados.org/user/cwl/cwl-runner.html

* "Install Guide":http://doc.arvados.org/install/ — Instructions for installing Arvados.

* "SDK Reference":http://doc.arvados.org/sdk/ — Details about the Arvados SDKs.

* "API Reference":http://doc.arvados.org/api/ — Details about the Arvados APIs.

* *[[How to Report Issues in Arvados]]* -- including some notes about safely reporting bugs in a public forum.

* Using [[Arvados Composer]]

h2. Community

* [[Mission and Principles]]

* [[Governance]]

* [[Forum, Chat and Mailing Lists]]

* [[Design Process]]

* [[History]]

* [[Arvados Summit - Fall 2013]]

h2. Contributing and hacking

* [[How to Contribute]]

* [[Arvbox|Installing a Development Arvados Instance]]

* [[Hacking|Hacking HQ]]: introductory material for new developers, and index of resources for all of us

* [[Source Tree Overview]] and implementation status

* [[Arvados Licenses FAQ]]

* [[Documentation|Documentation Project]]

* [[Design Principles]]

* [[Proposals]] and work-in-progress design documents

* "Planning":https://dev.arvados.org/issues/gantt?set_filter=1&gantt=1&f[]=project_id&op[project_id]=%3D&v[project_id][]=36

h2. Key Components

* [[Keep]], the content addressable distributed storage service

** [[Keep-balance]]

** [[Keep Proxy]]

* [[Crunch]], container orchestration

* [[System and Metadata Database]] 

** [[REST API Server]]

* [[SDKs]], including the Python library and the CLI "arv" tool

* [[Workbench]], the web-based application for doing day-to-day work in Arvados

* [[Node Manager]] dynamically starts and stops cloud compute nodes based on demand in the job queue

** [[Lifecycle of an Arvados compute node]]

* [[Common Workflow Language integration with Arvados]]