Arvados

h1. Arvados Contributor Wiki

This wiki has information related to the open source project.  You may also be interested "main Arvados site":https://arvados.org and the "Arvados documentation site":https://doc.arvados.org .

_Note: some of the information on this wiki, especially discussion of the Arvados architecture, is somewhat out of date.  Visit the main site and documentation site links above for the most current information._

!>{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

* [[Forum, Chat and Mailing Lists]]

* [[Mission and Principles]]

* [[Governance]]

* [[Code of Conduct]]

* [[Design Process]]

* [[History]]

* [[Arvados Summit - Fall 2013]]

* [[Arvados_Summit_Fall_2022]]

h2. Contributing and hacking

* [[How to Contribute]]

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

* [[Development process]]

* [[Release Checklist]]

* [[Arvados Licenses FAQ]]

* [[Documentation|Documentation Project]]

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

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]]

* [[CWL Conformance]]