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.0rc3.tar.gz (93.7 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: arvados-cwl-runner-3.0.0rc3.tar.gz
  • Upload date:
  • Size: 93.7 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.0rc3.tar.gz
Algorithm Hash digest
SHA256 0313dc6f351536eb708bcf1fb46b360045abc42b308ecf9e2214625fcfd10bcd
MD5 b3b3cdbfbec18bee82779eb324319b11
BLAKE2b-256 b21c16c385d30e72a8bc1e6085abb588faae6c3d5a55ddc771c80709d2dcc6eb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: arvados_cwl_runner-3.0.0rc3-py3-none-any.whl
  • Upload date:
  • Size: 122.2 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.0rc3-py3-none-any.whl
Algorithm Hash digest
SHA256 dd84f8e19390374bba335736943c239a5f61fcab7856ed97efc80d270f7425e3
MD5 a6d1c13978128b3a6d899101223f6d37
BLAKE2b-256 bc812d6be6d8f008ec2cfa59b18080682ee4ee2878a949536e6dfa3caee2cc29

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