X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/f0018dabe36d841c64efb9bdf79ce72ec6977350..f42ee7c19b794e25db30051b1dfc4bee83929bcd:/README.md diff --git a/README.md b/README.md index cb87862fb9..fced2eb5b7 100644 --- a/README.md +++ b/README.md @@ -6,21 +6,41 @@ -[Arvados](https://arvados.org) 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 a variety of methods including - Arvados APIs, WebDAV, and FUSE file system mount. - -* *Crunch*: a Docker-based cloud and HPC workflow engine designed providing - strong versioning, reproducibilty, and provenance of large-scale computations. - -* Related services and components including a web workbench for managing files - and compute jobs, REST APIs, SDKs, and other tools. +[Arvados](https://arvados.org) is an open source platform for +managing, processing, and sharing genomic and other large scientific +and biomedical data. With Arvados, bioinformaticians run and scale +compute-intensive workflows, developers create biomedical +applications, and IT administrators manage large compute and storage +resources. + +The key components of Arvados are: + +* *Keep*: Keep is the Arvados storage system for managing and storing large +collections of files. Keep combines content addressing and a +distributed storage architecture resulting in both high reliability +and high throughput. Every file stored in Keep can be accurately +verified every time it is retrieved. Keep supports the creation of +collections as a flexible way to define data sets without having to +re-organize or needlessly copy data. Keep works on a wide range of +underlying filesystems and object stores. + +* *Crunch*: Crunch is the orchestration system for running [Common Workflow Language](https://www.commonwl.org) workflows. It is +designed to maintain data provenance and workflow +reproducibility. Crunch automatically tracks data inputs and outputs +through Keep and executes workflow processes in Docker containers. In +a cloud environment, Crunch optimizes costs by scaling compute on demand. + +* *Workbench*: The Workbench web application allows users to interactively access +Arvados functionality. It is especially helpful for querying and +browsing data, visualizing provenance, and tracking the progress of +workflows. + +* *Command Line tools*: The command line interface (CLI) provides convenient access to Arvados +functionality in the Arvados platform from the command line. + +* *API and SDKs*: Arvados is designed to be integrated with existing infrastructure. All +the services in Arvados are accessed through a RESTful API. SDKs are +available for Python, Go, R, Perl, Ruby, and Java. # Quick start @@ -59,6 +79,8 @@ channel at [gitter.im](https://gitter.im) is used to coordinate development. The [Arvados user mailing list](http://lists.arvados.org/mailman/listinfo/arvados) is used to announce new versions and other news. +All participants are expected to abide by the [Arvados Code of Conduct](CODE_OF_CONDUCT.md). + # Reporting bugs [Report a bug](https://dev.arvados.org/projects/arvados/issues/new) on [dev.arvados.org](https://dev.arvados.org).