Skip to content

Commit 5ffb52f

Browse files
link to cwltool.readthedocs (#369)
Co-authored-by: Peter Amstutz <[email protected]>
1 parent 36a4e83 commit 5ffb52f

File tree

1 file changed

+6
-18
lines changed

1 file changed

+6
-18
lines changed

src/introduction/prerequisites.md

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -27,41 +27,29 @@ of the following options for your operating system:
2727

2828
```{note}
2929
If you are using Windows, you will have to install the [Windows Subsystem for Linux 2](https://learn.microsoft.com/en-us/windows/wsl/install) (WSL2).
30-
Visit the `cwltool` [documentation](https://github.com/common-workflow-language/cwltool/blob/main/README.rst#ms-windows-users)
30+
Visit the `cwltool` [documentation](https://cwltool.readthedocs.io/en/latest/#ms-windows-users)
3131
for details on installing WSL2.
3232
Your operating system also needs internet access and a recent version of Python (3.6+).
3333
```
3434

3535
## CWL Runner
3636

3737
% https://github.com/common-workflow-language/user_guide/issues/166
38-
% https://github.com/common-workflow-language/user_guide/issues/64
3938
% https://www.synapse.org/#!Synapse:syn2813589/wiki/401462
4039

4140
The first thing you will need for running CWL workflows is a CWL runner.
4241
`cwltool` is a Python Open Source project maintained by the CWL community. It
4342
is also the CWL reference runner, which means it must support everything in the
4443
current CWL specification, {{ cwl_version }}.
4544

46-
`cwltool` can be installed with `pip`. We recommend using a virtual environment
47-
like `venv` or `conda`. The following commands will create and activate a Python
48-
virtual environment using the `venv` module, and install `cwltool` in that
49-
environment:
50-
51-
```{code-block} console
52-
:name: installing-cwltool-with-pip-and-venv
53-
:caption: Installing `cwltool` with `pip` and `venv`.
54-
55-
$ python3 -m venv venv
56-
$ source venv/bin/activate
57-
$ (venv) pip install -U pip setuptools wheel
58-
$ (venv) pip install cwltool
59-
```
45+
`cwltool` can be installed with `pip`, `apt`, or `conda`. We recommend using a virtual environment
46+
like `venv` or `conda`.
6047

6148
```{note}
62-
Visit the `cwltool` [documentation](https://github.com/common-workflow-language/cwltool#install)
63-
for other ways to install `cwltool` with `apt` and `conda`.
49+
Visit the `cwltool` [documentation](https://cwltool.readthedocs.io/en/latest/#install)
50+
for details on installing `cwltool`.
6451
```
52+
6553
Let's use a simple CWL tool description `true.cwl` with `cwltool`.
6654

6755
```{literalinclude} /_includes/cwl/true.cwl

0 commit comments

Comments
 (0)