Skip to main content

Arvados Common Workflow Language runner

Project description

Overview

This package provides the arvados-cwl-runner tool to register and run Common Workflow Language workflows in Arvados.

Installation

Installing under your user account

This method lets you install the package without root access. However, other users on the same system will need to reconfigure their shell in order to be able to use it. Run the following to install the package in an environment at ~/arvclients:

python3 -m venv ~/arvclients
~/arvclients/bin/pip install arvados-cwl-runner

Command line tools will be installed under ~/arvclients/bin. You can test one by running:

~/arvclients/bin/arvados-cwl-runner --version

You can run these tools by specifying the full path every time, or you can add the directory to your shell’s search path by running:

export PATH="$PATH:$HOME/arvclients/bin"

You can make this search path change permanent by adding this command to your shell’s configuration, for example ~/.bashrc if you’re using bash. You can test the change by running:

arvados-cwl-runner --version

Installing on Debian and Ubuntu systems

Arvados publishes packages for Debian 11 “bullseye,” Debian 12 “bookworm,” Ubuntu 20.04 “focal,” and Ubuntu 22.04 “jammy.” You can install the Python SDK package on any of these distributions by running the following commands:

sudo install -d /etc/apt/keyrings
sudo curl -fsSL -o /etc/apt/keyrings/arvados.asc https://apt.arvados.org/pubkey.gpg
sudo tee /etc/apt/sources.list.d/arvados.sources >/dev/null <<EOF
Types: deb
URIs: https://apt.arvados.org/$(lsb_release -cs)
Suites: $(lsb_release -cs)
Components: main
Signed-by: /etc/apt/keyrings/arvados.asc
EOF
sudo apt update
sudo apt install python3-arvados-cwl-runner

Installing on Red Hat, AlmaLinux, and Rocky Linux

Arvados publishes packages for RHEL 8 and distributions based on it. Note that these packages depend on, and will automatically enable, the Python 3.9 module. You can install the Python SDK package on any of these distributions by running the following commands:

sudo tee /etc/yum.repos.d/arvados.repo >/dev/null <<'EOF'
[arvados]
name=Arvados
baseurl=http://rpm.arvados.org/RHEL/$releasever/os/$basearch/
gpgcheck=1
gpgkey=http://rpm.arvados.org/RHEL/RPM-GPG-KEY-arvados
EOF
sudo dnf install python3-arvados-cwl-runner

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.

Testing and Development

This package is one part of the Arvados source package, and it has integration tests to check interoperability with other Arvados components. Our hacking guide describes how to set up a development environment and run tests.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arvados-cwl-runner-3.0.0.tar.gz (93.6 kB view details)

Uploaded Source

Built Distribution

arvados_cwl_runner-3.0.0-py3-none-any.whl (122.1 kB view details)

Uploaded Python 3

File details

Details for the file arvados-cwl-runner-3.0.0.tar.gz.

File metadata

  • Download URL: arvados-cwl-runner-3.0.0.tar.gz
  • Upload date:
  • Size: 93.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for arvados-cwl-runner-3.0.0.tar.gz
Algorithm Hash digest
SHA256 91287bc3e2165afeca53b7e3a28aeeb8bbbe621dc3640499488c065039ff45ed
MD5 98f8cb6fefc6854e9233ac090ef7aca1
BLAKE2b-256 85a8064ad5dbabbfc542023f62463a316aa5d5c2849f15e8e0d86c952ede8f1a

See more details on using hashes here.

File details

Details for the file arvados_cwl_runner-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: arvados_cwl_runner-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 122.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for arvados_cwl_runner-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c134fe798750e585351b72a2d6c41282e9cb886e85e4e96b9a2bc6fb125cbbcb
MD5 717ff12db4b5cbbca64d28a06f8b331e
BLAKE2b-256 2e1e62af7db0a5a5b1b5a94c2e05fa60fb37f2a8af2859d5b1d19f5207cd5ef4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page