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 cwl-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.20160614212644.tar.gz (156.9 kB view details)

Uploaded Source

Built Distribution

cwltool-1.0.20160614212644-py2-none-any.whl (192.7 kB view details)

Uploaded Python 2

File details

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

File metadata

File hashes

Hashes for cwltool-1.0.20160614212644.tar.gz
Algorithm Hash digest
SHA256 32a7f96ade336114b2866b683d8007302a6fa3823b074fc1554698619eb27012
MD5 6336d756b4ef9522a655cc6ba1cfeeca
BLAKE2b-256 63ea76d488afb54ca9da2dbe070468894d7b0968656fad7f659da20427c278a9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cwltool-1.0.20160614212644-py2-none-any.whl
Algorithm Hash digest
SHA256 a41b31be098075896ccf8a8ac1edfc13e61967939403b407007f803b879c7c7f
MD5 7669e23f8bbee07f54e7a4c69b85ff28
BLAKE2b-256 9b321d6e7be50c0b0204aecfb44df0e4f83f55402d7ed1f0f7ec3c8add8ae8c1

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