1
1
# Windows Compatibility
2
- cwltool is compatible with Windows. This means that you can create and run CWL
3
- workflows on Windows . On Windows, all workflows and tools are executed in
4
- [ Docker Containers ] ( https://docs.docker.com/docker-for-windows/ ) . The default
5
- Docker Container is
2
+ The CWL reference runner, cwltool, is compatible with Microsoft Windows when
3
+ Docker is installed . On Windows, all CWL CommandLineTools are executed using
4
+ [ Docker software containers ] ( https://docs.docker.com/docker-for-windows/ ) . The
5
+ default Docker Container is
6
6
[ Alpine with Bash support] ( https://github.com/frol/docker-alpine-bash ) . You can
7
7
specify other Docker Containers for your tools and workflows using hints,
8
8
[ requirements] ( http://www.commonwl.org/v1.0/CommandLineTool.html#DockerRequirement ) ),
9
9
or the ` --default-container ` cwltool option.
10
10
11
11
## Supported Windows versions
12
12
* Windows 10 with native [ Docker for Windows] ( https://docs.docker.com/docker-for-windows/ ) .
13
- * Windows 8.1 with [ Docker ToolBox] ( https://docs.docker.com/toolbox/toolbox_install_windows/ ) .
14
- * Windows 7 & 8 with Docker ToolBox may work (Not tested, please let us know!).
13
+ * Windows 7, 8, and 8.1 with [ Docker ToolBox] ( https://docs.docker.com/toolbox/toolbox_install_windows/ ) .
14
+
15
+ If you are using Docker Toolbox, then you must run cwltool in the Docker
16
+ Quickstart Terminal.
15
17
16
18
## Installation
17
19
@@ -26,7 +28,7 @@ Before installing cwltool, please install:
26
28
* [ Node.js] ( https://nodejs.org/en/download/ ) (optional, please install if your
27
29
workflows or tools contain [ Javascript Expressions] ( http://www.commonwl.org/v1.0/CommandLineTool.html#InlineJavascriptRequirement ) )
28
30
29
- ### Install using pip
31
+ ### Install using pip (recommended)
30
32
31
33
```
32
34
pip install cwltool
@@ -58,18 +60,25 @@ There are two types of tests available for cwltool: unit tests and conformance t
58
60
59
61
### Unit tests
60
62
61
- To run cwltool's unit tests, go to the cwltool repository on your system and run:
63
+ To run cwltool's unit tests, run the following command:
64
+ ```
65
+ python -m pytest --pyarg cwltool
66
+ ```
67
+
68
+ Or go to the checkout of the cwltool Git repository on your system and run:
62
69
63
70
```
64
71
python setup.py test
65
72
```
66
73
74
+
75
+
67
76
### Conformance tests
68
77
69
- To run the conformance tests, follow these instructions:
78
+ To run the CWL conformance tests, follow these instructions:
70
79
71
80
```
72
- pip install cwltest
81
+ pip install cwltest mock
73
82
git clone https://github.com/common-workflow-language/common-workflow-language.git
74
83
cd common-workflow-language/v1.0
75
84
cwltest --test conformance_test_v1.0.yaml -j 4 --tool cwltool
@@ -130,3 +139,4 @@ can't then use the `--eval-timeout` argument and set a higher timeout value.
130
139
* If you still have problems with setting up and using Docker on Windows, please
131
140
consult the online Docker Community. If the problem is specific to cwltool,
132
141
create an [ issue on cwltool] ( https://github.com/common-workflow-language/cwltool/issues ) .*
142
+
0 commit comments