Skip to content

Commit d7e8810

Browse files
committed
minor fixes including spacing, grammatical correction and adding links
1 parent 446fbce commit d7e8810

File tree

1 file changed

+56
-20
lines changed

1 file changed

+56
-20
lines changed

windowsdoc.md

Lines changed: 56 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
11
## **Windows Compatible Cwltool**
2-
Windows Compatible cwltool means that now you can create and run your workflows using cwltool on Windows under a [Docker Container](https://docs.docker.com/docker-for-windows/).
3-
On Windows, all tools and workflows will be executed inside a linux based Docker Container. If a Docker Container is not provided explicitly (using [Docker Requirement](http://www.commonwl.org/v1.0/CommandLineTool.html#DockerRequirement)) by user, we use a minimal, posix compliant Alpine Docker image which has Bash pre installed as fallback (Default) [Docker Container](https://github.com/frol/docker-alpine-bash).
4-
You can also provide your own default Docker Container using `--default-container` argument.
2+
Windows Compatible cwltool means that now you can create and run your workflows
3+
using cwltool on Windows under a [Docker Container](https://docs.docker.com/docker-for-windows/).
4+
On Windows, all tools and workflows will be executed inside a linux based Docker
5+
Container. If a Docker Container is not explicitly provided (using [Docker Requirement](http://www.commonwl.org/v1.0/CommandLineTool.html#DockerRequirement))
6+
by user, then a minimal, posix compliant Alpine Docker image which has Bash pre
7+
installed as fallback (Default) [Docker Container](https://github.com/frol/docker-alpine-bash).
8+
You can also provide your own default Docker Container using the `--default-container` argument.
59

610
### ***Windows Version Supported***:
711
* Windows 10 with native [Docker for Windows](https://docs.docker.com/docker-for-windows/).
812
* Windows 8.1 with [Docker ToolBox](https://docs.docker.com/toolbox/toolbox_install_windows/).
9-
* Windows 7 & 8 with Docker ToolBox may work (Not tested).
13+
* Windows 7 & 8 with Docker ToolBox may work (Not tested, please let us know!).
1014

1115
### ***Requirements***:
12-
* Python 2 or 3.
13-
* Docker
16+
* [Python 2 or 3](https://www.python.org/downloads/windows/).
17+
* [Docker](https://docs.docker.com/docker-for-windows/install/)
1418

1519
### ***Best Practises***:
16-
You should install [Node.js](https://nodejs.org/) on your system if your workflow contains [Javascript Expressions](http://www.commonwl.org/v1.0/CommandLineTool.html#InlineJavascriptRequirement).
20+
You should install [Node.js](https://nodejs.org/en/download/) on your system if
21+
your workflow contains [Javascript Expressions](http://www.commonwl.org/v1.0/CommandLineTool.html#InlineJavascriptRequirement).
1722

1823
### ***Installation***:
24+
You can install cwltool either using pip or directly from source code.
1925
**Using Pip**:
2026
You can install cwltool on Windows using pip
2127
`pip install cwltool`
@@ -26,13 +32,24 @@ You can install cwltool on Windows using pip
2632
cd cwltool
2733
python setup.py develop
2834
```
29-
***Note:*** In order to test if cwltool has been successfully installed on your Windows system, run `cwltool` on your `cmd`. A screen showing help instructions should be there.
35+
***Note:*** In order to test if cwltool has been successfully installed on your
36+
Windows system, run `cwltool` on your `cmd`. A screen showing help instructions
37+
like shown below should be there.
38+
```
39+
CWL document required, no input file was provided
40+
usage: cwltool [-h] [--basedir BASEDIR] [--outdir OUTDIR] [--no-container]
41+
[--preserve-environment ENVVAR] [--preserve-entire-environment]
42+
[--rm-container | --leave-container]
43+
[--tmpdir-prefix TMPDIR_PREFIX]
44+
.......................
45+
```
46+
3047

3148
### ***Running Cwltool's Unit Tests***
3249
If you want to run cwltool's unit test, go to cwltool's repository on your system and run
3350
`python setup.py test`
3451

35-
### ***Running Conformance tests using cwltool***
52+
### ***Running Conformance tests using cwltool***
3653
```pip install cwltest
3754
git clone https://github.com/common-workflow-language/common-workflow-language.git
3855
cd common-workflow-language/v1.0
@@ -43,33 +60,52 @@ Here `-j` arg is used to run multiple tests in parallel.
4360
 
4461
 
4562

46-
> #### Installing cwltool on Windows is smooth but you may face some problems in setting up Docker. Some of the common issues and their solution are mentioned below.
63+
> #### Installing cwltool on Windows is smooth but you may face some problems
64+
in setting up Docker. Some of the common issues and their solution are mentioned below.
65+
66+
 
4767

4868
**Docker doesn't work on Windows, even outside cwltool.**
49-
Make into proper sentences: 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/).
69+
Make sure you followed all instructions carefully while installing Docker. Please
70+
check the Environment variables. If the problem persists, we recommend consulting
71+
the [online Docker Community](https://forums.docker.com/).
5072

5173
**Your local drives are not being shared with Docker Container.**
5274
* ***On native Docker for Windows (supported by Windows 10):***
53-
On your tray, next to your clock, right-click on Docker, then click on Settings, there you'll find the shared rives: Here you can share your drives with Docker.
75+
On your tray, next to your clock, right-click on Docker, then click on Settings,
76+
there you'll find the shared rives: Here you can share your drives with Docker.
5477
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/).
5578

5679
* ***On Docker Toolbox:***
57-
Docker Toolbox uses Virtualbox to create a linux base on which Docker machine runs. Your Docker Container will be created inside Virtualbox. To share drives
80+
Docker Toolbox uses Virtualbox to create a linux base on which Docker machine runs.
81+
Your Docker Container will be created inside Virtualbox. To share drives
5882
in virtualbox, go to ****Virtualbox->settings->shared folders->Machine Folders****
5983
Here Map the drives you want to share with your Docker Container.
60-
If you want to keep these settings permanent (Recommended!), You should mark the `make permanent` checkbox or else these settings will be erased every time your virtualbox closes.
84+
If you want to keep these settings permanent (Recommended!), You should mark the
85+
`make permanent` checkbox or else these settings will be erased every time your
86+
virtualbox closes.
6187

6288
**In a Docker Container with shared drives, not all files are shown on `ls`.**
63-
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.
89+
This means your drives/folders are not shared properly. Docker uses caching,
90+
which may result in not all files and folders being listed on ls.
6491
In order to solve this problem, make your drive mapping settings permanent (see previous question).
6592

6693
**Can't create/modify a file in Docker when using cwltool.**
67-
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.
94+
When folders are shared with Docker Container, they inherit their current file
95+
access permissions. If you can write to a folder (with your current privileges)
96+
on your local machine, you should be able to write to that folder inside Docker
97+
Container also (provided same user initiated Docker). In all it is a file permission issue.
6898

6999
**Workflows with Javascript Expressions occasionally give Timeout errors.**
70-
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.
71-
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.
72-
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.
100+
To evaluate Javascript Expressions, cwltool looks for Nodejs on your system.
101+
In case Nodejs isn't installed, JS expressions are executed in a Docker Container.
102+
In order to avoid waiting forever in case error occurs, cwltool times out js
103+
expression evaluation after a timeout period (by default 20 seconds). You can
104+
provide a custom timeout period using `--eval-timeout` argument.
105+
So if you face this error, the best option is to install Nodejs on your local
106+
system. If you can't then use the `--eval-timeout` argument and set a higher timeout value.
73107

74-
> #### If you still face some issues 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).
108+
> #### If you still face some issues setting up and using Docker on Windows,
109+
please consult the online Docker Community. If the problem is specific to cwltool,
110+
create an [issue on cwltool](https://github.com/common-workflow-language/cwltool/issues).
75111

0 commit comments

Comments
 (0)