Skip to content

Commit 3142fcd

Browse files
author
Janneke van der Zwaan
committed
Wrap text at about 80 characters
1 parent f2e05d0 commit 3142fcd

File tree

1 file changed

+39
-12
lines changed

1 file changed

+39
-12
lines changed

windowsdoc.md

Lines changed: 39 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# 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,
8+
[requirements](http://www.commonwl.org/v1.0/CommandLineTool.html#DockerRequirement)),
9+
or the `--default-container` cwltool option.
310

411
## Supported Windows versions
512

@@ -17,7 +24,8 @@ Before installing cwltool, please install:
1724

1825
* [Python 2 or 3](https://www.python.org/downloads/windows/)
1926
* [Docker](https://docs.docker.com/docker-for-windows/install/)
20-
* [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))
2129

2230
### Install using pip
2331

@@ -32,7 +40,8 @@ pip install cwltool
3240
cd cwltool
3341
python setup.py develop
3442
```
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.
3645
```
3746
CWL document required, no input file was provided
3847
usage: cwltool [-h] [--basedir BASEDIR] [--outdir OUTDIR] [--no-container]
@@ -44,11 +53,11 @@ pip install cwltool
4453

4554
## Running tests
4655

47-
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.
4857

4958
### Unit tests
5059

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:
5261

5362
```
5463
python setup.py test
@@ -72,14 +81,17 @@ You may encounter some problems with Docker on Windows.
7281

7382
### Docker doesn't work on Windows, even outside cwltool
7483

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/).
7687

7788
### Your local drives are not being shared with Docker Containers
7889

7990
* ***On native Docker for Windows (supported by Windows 10):***
8091
On your tray, next to your clock, right-click on Docker, then click on Settings,
8192
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/).
8395

8496
* ***On Docker Toolbox:***
8597
Docker Toolbox uses Virtualbox to create a linux base on which Docker machine runs.
@@ -92,13 +104,28 @@ virtualbox closes.
92104

93105
### In a Docker Container with shared drives, not all files are shown on `ls`
94106

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).
96111

97112
### Can't create/modify a file in Docker when using cwltool
98113

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.
100119

101120
### 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

Comments
 (0)