Skip to main content

Common workflow language reference implementation

Project description

==================================================================
Common workflow language tool description reference implementation
==================================================================

CWL Conformance test: |Build Status|

This is the reference implementation of the Common Workflow Language. It is
intended to be feature complete and provide comprehensive validation of CWL
files as well as provide other tools related to working with CWL.

This is written and tested for Python 2.7.

The reference implementation consists of two packages. The "cwltool" package
is the primary Python module containing the reference implementation in the
"cwltool" module and console executable by the same name.

The "cwl-runner" package is optional and provides an additional entry point
under the alias "cwl-runner", which is the implementation-agnostic name for the
default CWL interpreter installed on a host.

Install
-------

Installing the official package from PyPi (will install "cwltool" package as well)::

pip install cwlref-runner

Or from source::

git clone https://github.com/common-workflow-language/cwltool.git
cd cwltool && python setup.py install
cd cwl-runner && python setup.py install

Run on the command line
-----------------------

Simple command::

cwl-runner [tool] [job]

Import as a module
----------------

Add::

import cwltool

to your script.

Use with boot2docker
--------------------
boot2docker is running docker inside a virtual machine and it only mounts ``Users``
on it. The default behavoir of CWL is to create temporary directories under e.g.
``/Var`` which is not accessible to Docker containers.

To run CWL successfully with boot2docker you need to set the ``--tmpdir-prefix``
and ``--tmp-outdir-prefix`` to somewhere under ``/Users``::

$ cwl-runner --tmp-outdir-prefix=/Users/username/project --tmpdir-prefix=/Users/username/project wc-tool.cwl wc-job.json

.. |Build Status| image:: https://ci.commonwl.org/buildStatus/icon?job=cwltool-conformance
:target: https://ci.commonwl.org/job/cwltool-conformance/

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

cwltool-1.0.20160708190014.tar.gz (164.4 kB view details)

Uploaded Source

Built Distribution

cwltool-1.0.20160708190014-py2-none-any.whl (200.1 kB view details)

Uploaded Python 2

File details

Details for the file cwltool-1.0.20160708190014.tar.gz.

File metadata

File hashes

Hashes for cwltool-1.0.20160708190014.tar.gz
Algorithm Hash digest
SHA256 a0180b323101bb1589660a5d420f2faf4021447d25ffe1bca9e510c1fb395e92
MD5 d7eaf4abb23e93a72a67ca486f0492e7
BLAKE2b-256 353d4faddcb1c642df14a60122a0afe614d99c82bb834c442c139ac4becdeb48

See more details on using hashes here.

Provenance

File details

Details for the file cwltool-1.0.20160708190014-py2-none-any.whl.

File metadata

File hashes

Hashes for cwltool-1.0.20160708190014-py2-none-any.whl
Algorithm Hash digest
SHA256 770c6cf0b0d07ed5c673a0eee0ce312ca2081478f9eab1f5dd36234d0595e049
MD5 7007d99af6e0c1714b1cd71f679b9ff5
BLAKE2b-256 15d21362f8dd0a755d65782dd74b2826445b58e036b2255d986a9ba9052d8606

See more details on using hashes here.

Provenance

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