@@ -14,29 +14,43 @@ The reference implementation consists of two packages. The "cwltool" package
14
14
is the primary Python module containing the reference implementation in the
15
15
"cwltool" module and console executable by the same name.
16
16
17
- The "cwl -runner" package is optional and provides an additional entry point
17
+ The "cwlref -runner" package is optional and provides an additional entry point
18
18
under the alias "cwl-runner", which is the implementation-agnostic name for the
19
19
default CWL interpreter installed on a host.
20
20
21
21
Install
22
22
-------
23
23
24
- Installing the official package from PyPi (will install "cwltool" package as well)::
24
+ Installing the official package from PyPi (will install "cwltool" package as
25
+ well)::
25
26
26
27
pip install cwlref-runner
27
28
28
- Or from source::
29
+ If installling alongside another CWL implementation then::
30
+
31
+ pip instal cwltool
32
+
33
+ To install from source::
29
34
30
35
git clone https://github.com/common-workflow-language/cwltool.git
31
36
cd cwltool && python setup.py install
32
- cd cwlref-runner && python setup.py install
37
+ cd cwlref-runner && python setup.py install # co-installing? skip this
38
+
39
+ Remember, if co-installing multiple CWL implementations then you need to
40
+ maintain which implementation ``cwl-runner `` points to via a symbolic file
41
+ system link or [another facility](https://wiki.debian.org/DebianAlternatives).
33
42
34
43
Run on the command line
35
44
-----------------------
36
45
37
46
Simple command::
38
47
39
- cwl-runner [tool] [job]
48
+ cwl-runner [tool-or-workflow-description] [input-job-settings]
49
+
50
+ Or if you have multiple CWL implementations installed and you want to override
51
+ the default cwl-runner use::
52
+
53
+ cwltool [tool-or-workflow-description] [input-job-settings]
40
54
41
55
Import as a module
42
56
----------------
@@ -60,3 +74,15 @@ and ``--tmp-outdir-prefix`` to somewhere under ``/Users``::
60
74
61
75
.. |Build Status | image :: https://ci.commonwl.org/buildStatus/icon?job=cwltool-conformance
62
76
:target: https://ci.commonwl.org/job/cwltool-conformance/
77
+
78
+ Tool or workflow loading from remote or local locations
79
+ -------------------------------------------------------
80
+
81
+ ``cwltool `` can run tool and workflow descriptions on both local and remote
82
+ systems via its support for HTTP[S] URLs.
83
+
84
+ Input job files and Workflow steps (via the `run ` directive) can reference CWL
85
+ documents using absolute or relative local filesytem paths. If a relative path
86
+ is referenced and that document isn't found in the current directory then the
87
+ following locations will be searched:
88
+ http://www.commonwl.org/v1.0/CommandLineTool.html#Discovering_CWL_documents_on_a_local_filesystem
0 commit comments