You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: windowsdoc.md
+39-12Lines changed: 39 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,12 @@
1
1
# Windows Compatibility
2
-
cwltool is compatible with Windows. This means that you can create and run CWL workflows on Windows. On Windows, all workflows and tools are executed in [Docker Containers](https://docs.docker.com/docker-for-windows/). The default Docker Container is [Alpine with Bash support](https://github.com/frol/docker-alpine-bash). You can specify other Docker Containers for your tools and workflows using hints, [requirements](http://www.commonwl.org/v1.0/CommandLineTool.html#DockerRequirement)), or the `--default-container` cwltool option.
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
6
+
[Alpine with Bash support](https://github.com/frol/docker-alpine-bash). You can
7
+
specify other Docker Containers for your tools and workflows using hints,
*[Node.js](https://nodejs.org/en/download/) (optional, please install if your workflows or tools contain [Javascript Expressions](http://www.commonwl.org/v1.0/CommandLineTool.html#InlineJavascriptRequirement))
27
+
*[Node.js](https://nodejs.org/en/download/) (optional, please install if your
28
+
workflows or tools contain [Javascript Expressions](http://www.commonwl.org/v1.0/CommandLineTool.html#InlineJavascriptRequirement))
21
29
22
30
### Install using pip
23
31
@@ -32,7 +40,8 @@ pip install cwltool
32
40
cd cwltool
33
41
python setup.py develop
34
42
```
35
-
***Note:*** In order to test if cwltool has been successfully installed on your Windows system, run `cwltool` in `cmd`. If you see help instructions, cwltool was successfully installed.
43
+
***Note:*** In order to test if cwltool has been successfully installed on your
44
+
Windows system, run `cwltool` in `cmd`. If you see help instructions, cwltool was successfully installed.
There are two types of tests available for cwltool: unit tests and concformance tests.
56
+
There are two types of tests available for cwltool: unit tests and conformance tests.
48
57
49
58
### Unit tests
50
59
51
-
To run cwltool's unit tests, go to the cwltool repository on your system and run
60
+
To run cwltool's unit tests, go to the cwltool repository on your system and run:
52
61
53
62
```
54
63
python setup.py test
@@ -72,14 +81,17 @@ You may encounter some problems with Docker on Windows.
72
81
73
82
### Docker doesn't work on Windows, even outside cwltool
74
83
75
-
Make sure you followed all instructions carefully while installing Docker. Please check the Environment variables. If the problem persists, we recommend consulting the [online Docker Community](https://forums.docker.com/).
84
+
Make sure you followed all instructions carefully while installing Docker.
85
+
Please check the Environment variables. If the problem persists, we recommend
86
+
consulting the [online Docker Community](https://forums.docker.com/).
76
87
77
88
### Your local drives are not being shared with Docker Containers
78
89
79
90
****On native Docker for Windows (supported by Windows 10):***
80
91
On your tray, next to your clock, right-click on Docker, then click on Settings,
81
92
there you'll find the shared rdives: Here you can share your drives with Docker.
82
-
If you encounter a problem with your firewall, please [refer this post](https://blog.olandese.nl/2017/05/03/solve-docker-for-windows-error-a-firewall-is-blocking-file-sharing-between-windows-and-the-containers/).
93
+
If you encounter a problem with your firewall, please
94
+
[refer this to post](https://blog.olandese.nl/2017/05/03/solve-docker-for-windows-error-a-firewall-is-blocking-file-sharing-between-windows-and-the-containers/).
83
95
84
96
****On Docker Toolbox:***
85
97
Docker Toolbox uses Virtualbox to create a linux base on which Docker machine runs.
@@ -92,13 +104,28 @@ virtualbox closes.
92
104
93
105
### In a Docker Container with shared drives, not all files are shown on `ls`
94
106
95
-
This means your drives/folders are not shared properly. Docker uses caching, which may result in not all files and folders being listed on ls. In order to solve this problem, make your drive mapping settings permanent (see previous question).
107
+
This means your drives/folders are not shared properly. Docker uses caching,
108
+
which may result in not all files and folders being listed on ls. In order to
109
+
solve this problem, make your drive mapping settings permanent (see previous
110
+
question).
96
111
97
112
### Can't create/modify a file in Docker when using cwltool
98
113
99
-
When folders are shared with Docker Container, they inherit their current file access permissions. If you can write to a folder (with your current privileges) on your local machine, you should be able to write to that folder inside Docker Container also (provided same user initiated Docker). In all it is a file permission issue.
114
+
When folders are shared with Docker Container, they inherit their current file
115
+
access permissions. If you can write to a folder (with your current privileges)
116
+
on your local machine, you should be able to write to that folder inside Docker
117
+
Container also (provided same user initiated Docker). In all it is a file
118
+
permission issue.
100
119
101
120
### Workflows with Javascript Expressions occasionally give Timeout errors
102
-
To evaluate Javascript Expressions, cwltool looks for Nodejs on your system. In case Nodejs isn't installed, JS expressions are executed in a Docker Container. In order to avoid waiting forever in case error occurs, cwltool times out js expression evaluation after a timeout period (by default 20 seconds). You can provide a custom timeout period using `--eval-timeout` argument. So if you face this error, the best option is to install Nodejs on your local system. If you can't then use the `--eval-timeout` argument and set a higher timeout value.
103
-
104
-
*If you still have problems with setting up and using Docker on Windows, please consult the online Docker Community. If the problem is specific to cwltool, create an [issue on cwltool](https://github.com/common-workflow-language/cwltool/issues).*
121
+
To evaluate Javascript Expressions, cwltool looks for Nodejs on your system.
122
+
In case Nodejs isn't installed, JS expressions are executed in a Docker Container.
123
+
In order to avoid waiting forever in case error occurs, cwltool times out js
124
+
expression evaluation after a timeout period (by default 20 seconds). You can
125
+
provide a custom timeout period using `--eval-timeout` argument. So if you face
126
+
this error, the best option is to install Nodejs on your local system. If you
127
+
can't then use the `--eval-timeout` argument and set a higher timeout value.
128
+
129
+
*If you still have problems with setting up and using Docker on Windows, please
130
+
consult the online Docker Community. If the problem is specific to cwltool,
131
+
create an [issue on cwltool](https://github.com/common-workflow-language/cwltool/issues).*
0 commit comments