Arvados Client Tools

Overview

This is a metapackage that lets you install all of the Python client tools for Arvados in one simple command. It's intended for users setting up an interactive environment. It provides:

• the Arvados Python SDK
• command line tools to work with collections and projects: arv-ls, arv-get, arv-put, arv-copy, and arv-mount
• workflow runners arvados-cwl-runner and cwltool
• reporting tools for workflow performance, cluster activity, and user activity

If you are building your own Arvados client software, it is better to require the specific package(s) you need like arvados-python-client.

Installation

We recommend you install with pipx. First install pipx (it's available as the pipx package in most Linux distributions). Then run:

  pipx install --include-deps arvados-tools

Alternatively, if you're comfortable setting up your own virtual environments, you can install the package in one too. For example:

  python3 -m venv MYVENV
  MYVENV/bin/pip install arvados-tools

Now all the Arvados tools will be available after you activate MYVENV with source MYVENV/bin/activate.

Configuration

This client software needs two pieces of information to connect to Arvados: the DNS name of the API server, and an API authorization token. The Arvados user documentation describes how to find this information in the Arvados Workbench, and install it on your system.

Licenses

The SDK and most command line tools installed are published under the Apache License 2.0. arv-mount and the reporting tools are published under the GNU Affero General Public License 3.0. Refer to the individual component packages for details.