X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/c58b35021249095b2a09063af856b0823365e177..a53bf7d89e01e98dcdc62b5357a0404d5489c9a1:/README.md diff --git a/README.md b/README.md index c35e11f911..fced2eb5b7 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,96 @@ -# APIClient +[comment]: # (Copyright © The Arvados Authors. All rights reserved.) +[comment]: # () +[comment]: # (SPDX-License-Identifier: CC-BY-SA-3.0) -
-
Homepage
http://code.google.com/p/google-api-ruby-client
-
Author
Bob Aman
-
Copyright
Copyright © 2011 Google, Inc.
-
License
Apache 2.0
-
+[![Join the chat at https://gitter.im/arvados/community](https://badges.gitter.im/arvados/community.svg)](https://gitter.im/arvados/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | [Installing Arvados](https://doc.arvados.org/install/index.html) | [Installing Client SDKs](https://doc.arvados.org/sdk/index.html) | [Report a bug](https://dev.arvados.org/projects/arvados/issues/new) | [Development and Contributing](CONTRIBUTING.md) -[![Build Status](https://secure.travis-ci.org/google/google-api-ruby-client.png)](http://travis-ci.org/google/google-api-ruby-client) -[![Dependency Status](https://gemnasium.com/google/google-api-ruby-client.png)](https://gemnasium.com/google/google-api-ruby-client) + -# Description +[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 Google API Ruby Client makes it trivial to discover and access supported -APIs. +The key components of Arvados are: -# Example Usage +* *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. - # Initialize the client & Google+ API - require 'google/api_client' - client = Google::APIClient.new - plus = client.discovered_api('plus') +* *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. - # Initialize OAuth 2.0 client - client.authorization.client_id = '' - client.authorization.client_secret = '' - client.authorization.scope = 'https://www.googleapis.com/auth/plus.me' - - # Request authorization - redirect_uri = client.authorization.authorization_uri +* *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. - # Wait for authorization code then exchange for token - client.authorization.code = '....' - client.authorization.fetch_access_token! - - # Make an API call - result = client.execute( - :api_method => plus.activities.list' - :parameters => {'collection' => 'public', 'userId' => 'me'} - ) +* *Command Line tools*: The command line interface (CLI) provides convenient access to Arvados +functionality in the Arvados platform from the command line. - puts result.data - -# Install +* *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. -Be sure `http://rubygems.org/` is in your gem sources. +# Quick start -For normal client usage, this is sufficient: +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: - $ sudo gem install google-api-client +``` +$ cd arvados/tools/arvbox/bin +$ ./arvbox start localdemo +``` -The command line interface, the example applications, and the test suite -require additional dependencies. These may be obtained with: +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. - $ sudo gem install google-api-client --development --force --no-rdoc --no-ri +# Documentation + +Complete documentation, including the [User Guide](https://doc.arvados.org/user/index.html), [Installation documentation](https://doc.arvados.org/install/index.html), [Administrator documentation](https://doc.arvados.org/admin/index.html) and +[API documentation](https://doc.arvados.org/api/index.html) is available at http://doc.arvados.org/ + +If you wish to build the Arvados documentation from a local git clone, see +[doc/README.textile](doc/README.textile) for instructions. + +# Community + +[![Join the chat at https://gitter.im/arvados/community](https://badges.gitter.im/arvados/community.svg)](https://gitter.im/arvados/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + +The [Arvados community channel](https://gitter.im/arvados/community) +channel at [gitter.im](https://gitter.im) is available for live +discussion and support. + +The [Arvados developement channel](https://gitter.im/arvados/development) +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). + +# Development and Contributing + +See [CONTRIBUTING](CONTRIBUTING.md) for information about Arvados development and how to contribute to the Arvados project. + +The [development road map](https://dev.arvados.org/issues/gantt?utf8=%E2%9C%93&set_filter=1&gantt=1&f%5B%5D=project_id&op%5Bproject_id%5D=%3D&v%5Bproject_id%5D%5B%5D=49&f%5B%5D=&zoom=1) outlines some of the project priorities over the next twelve months. + +# Licensing + +Arvados is Free Software. See [COPYING](COPYING) for information about the open source licenses used in Arvados.