File tree Expand file tree Collapse file tree 5 files changed +15
-19
lines changed Expand file tree Collapse file tree 5 files changed +15
-19
lines changed Original file line number Diff line number Diff line change @@ -87,8 +87,8 @@ the file using the new name for subsequent steps or as a workflow-level output.
87
87
88
88
There are two ways to reference a local script :
89
89
90
- The first method involves adding the folder containing your scripts to the `PATH` environment variable.
91
- This allows you to run the shell script directly without using `sh` or `bash` commands.
90
+ The first method involves adding the path to a folder containing your scripts to the `PATH` environment variable. This
91
+ allows you to execute the shell script directly ( without explicitly using the `sh` or `bash` commands) .
92
92
93
93
Start with adding a _shebang_ at the top of your file :
94
94
@@ -135,10 +135,6 @@ baseCommand: sh
135
135
outputs: []
136
136
` ` `
137
137
138
- ` ` ` {note}
139
- In CWL, everything must be directly stated.
140
- ` ` `
141
-
142
138
# # How can I set `self`-based input bindings for optional inputs?
143
139
144
140
Currently, `cwltool` can't cope with missing optional inputs if their
Original file line number Diff line number Diff line change @@ -159,8 +159,8 @@ in detail in the [Requirements](../topics/requirements-and-hints.md) section.
159
159
> machine accessibility and that all digital assets should be Findable,
160
160
> Accessible, Interoperable, and Reusable. Workflows encode the methods
161
161
> by which the scientific process is conducted and via which data are
162
- > created. It is thus important that workflows support the creation
163
- > of FAIR data and adhere to the FAIR principles.
162
+ > created. It is thus important that workflows both support the creation
163
+ > of FAIR data and themselves adhere to the FAIR principles.
164
164
> — [ FAIR Computational Workflows] ( https://workflows.community/groups/fair/ ) ,
165
165
> Workflows Community Initiative.
166
166
Original file line number Diff line number Diff line change @@ -26,9 +26,8 @@ of the following options for your operating system:
26
26
- Windows
27
27
28
28
``` {note}
29
- 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://cwltool.readthedocs.io/en/latest/#ms-windows-users)
31
- for details on installing WSL2.
29
+ If you are using Windows, you will have to install the Windows Subsystem for Linux 2 as documented in the
30
+ [`cwltool` documentation for Microsoft Windows users](https://github.com/common-workflow-language/cwltool/blob/main/README.rst#ms-windows-users).
32
31
Your operating system also needs internet access and a recent version of Python (3.6+).
33
32
```
34
33
@@ -76,7 +75,7 @@ You can run the CWL tool description by omitting the `--validate` option:
76
75
:caption: Running `true.cwl` with `cwltool`.
77
76
```
78
77
79
- ### Cwl -runner Python Module
78
+ ### Generic `` cwl -runner`` alias
80
79
81
80
` cwl-runner ` is an implementation-agnostic alias for any CWL compliant runner. This simply means
82
81
that the ` cwl-runner ` alias command can be invoked independently, and is not reliant on a particular
Original file line number Diff line number Diff line change @@ -66,9 +66,10 @@ and in the [Outputs](../topics/outputs.md) sections.
66
66
67
67
68
68
## Network Access
69
- This indicates whether a process requires outgoing IPv4/IPv6 network access.
70
- If a command-line tool is written manually in CWL v1.1+, there is a need to
71
- specify when network access is required.
69
+ This indicates whether a process requires outgoing IPv4/IPv6 network
70
+ access. Starting with CWL v1.1, programs are not granted network
71
+ access by default, so you must include the requirement for network
72
+ access in the specification of your tool.
72
73
73
74
``` cwl
74
75
cwlVersion: v1.2
@@ -80,6 +81,6 @@ requirements:
80
81
```
81
82
82
83
``` {note}
83
- CWL v1.0 command-line tools that are upgraded to v1.1
84
- or v1.2 get Network Access automatically.
84
+ CWL v1.0 command-line tools that are upgraded to v1.1
85
+ or v1.2 or v1.2 will have `networkAccess: true` set automatically.
85
86
```
Original file line number Diff line number Diff line change @@ -53,8 +53,8 @@ style=dashed;
53
53
}
54
54
```
55
55
56
- If you try running it with ` cwltool ` , the command will fail since ` cwltool `
57
- does not have enough information to know how to execute it:
56
+ The operation file will fail to run with ` cwltool ` because ` cwltool `
57
+ lacks the necessary information to execute it:
58
58
59
59
``` {runcmd} cwltool operations.cwl --message Hello
60
60
:working-directory: src/_includes/cwl/operations/
You can’t perform that action at this time.
0 commit comments