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.20160707195347.tar.gz (164.0 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 2

File details

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

File metadata

File hashes

Hashes for cwltool-1.0.20160707195347.tar.gz
Algorithm Hash digest
SHA256 833ad8d819b60a018cd064a986193070ce5efb9110e10f0d98b0c6fb4d8a1ab1
MD5 79427d6f490a7ccac4bc450eea0f82b9
BLAKE2b-256 9f57488dcf9d081e563d26c4b3f45adc005fd406287a1f40b804c1564ac5eb44

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cwltool-1.0.20160707195347-py2-none-any.whl
Algorithm Hash digest
SHA256 8a67a8bc664c67b692c601acd737d16559473134d8f3c7517fa38b1bb1b7ab60
MD5 fb5beae6a1d07f365f955a4c6f17141f
BLAKE2b-256 8188e9ceb38d62474f3757d24946f92587af36655c31e3d619740aa34e6ec630

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