Skip to main content

GA4GH Workflow Execution Service reference implementation

Project description

# Workflow as a Service

This provides client and server implementations of the [GA4GH Workflow Execution Service](https://github.com/ga4gh/workflow-execution-schemas) API for the Common Workflow Language.

It provides an (Arvados)[https://github.com/curoverse/arvados] backend. It also works with any cwl-runner that supports the CWL standard command line interface: http://www.commonwl.org/v1.0/CommandLineTool.html#Executing_CWL_documents_as_scripts

Installation:

` pip install wes-service `

Run a standalone server with default cwl-runner backend:

` $ wes-server `

Submit a workflow to run:

` $ wes-client --host=localhost:8080 myworkflow.cwl myjob.json `

List workflows:

` $ wes-client --list `

Get workflow status:

` $ wes-client --get <workflow-id> `

Get stderr log from workflow:

` $ wes-client --log <workflow-id> `

# Server Options

## Run a standalone server with Arvados backend:

` $ wes-server --backend=wes_service.arvados_wes `

## Use a different executable with cwl_runner backend

` $ wes-server --backend=wes_service.cwl_runner --opt runner=cwltoil `

## Pass parameters to cwl-runner

` $ wes-server --backend=wes_service.cwl_runner --opt extra=--workDir=/ `

# Client environment options

Set service endpoint:

` $ export WES_API_HOST=localhost:8080 `

Set the value to pass in the Authorization header:

` $ export WES_API_AUTH=my_api_token `

Set the protocol (one of http, https)

` $ export WES_API_PROTO=http `

Project details


Download files

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

Source Distribution

wes-service-2.1.tar.gz (5.9 kB view details)

Uploaded Source

File details

Details for the file wes-service-2.1.tar.gz.

File metadata

  • Download URL: wes-service-2.1.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for wes-service-2.1.tar.gz
Algorithm Hash digest
SHA256 1cc9f06de505ecc09310d886c279532561c55c0286b198a2dccf53ad76b65645
MD5 7acd1664291b6d6d9f59a2949c33b3c6
BLAKE2b-256 99b4a4536835365d021f5fd16b7c4f68c1db21cef2316887e87c9d1cb3ee4283

See more details on using hashes here.

Supported by

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