Skip to content

Commit 1908732

Browse files
committed
refactoring
1 parent bfdba7c commit 1908732

File tree

3 files changed

+16
-6
lines changed

3 files changed

+16
-6
lines changed

docs/cwl/cwl-eoap.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
In the scope of this Best Practice, the Application Package uses:
2+
3+
- the CWL _Workflow_ Description specification as encoding to describe the Application, its parameters and data flows
4+
- the CWL _CommandLineTool_ for describing the command-line tools used, their arguments and their invocation within containers.
5+
6+
With the use of CWL Workflow Description Standard as encoding, the Application can also possibly yield several Application Packages that expose parameters and inputs in different flavors and execution patterns.

docs/cwl.md docs/cwl/nutshell.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,12 @@ The CWL targets data-intensive processing scenarios and makes these portable and
1010
* Parameter of the process
1111
* Inputs/outputs
1212

13-
The CWL contains two main specifications. The Command Line Tool Description Specification that specifies the document schema and execution semantics for wrapping and executing command line tools and the Workflow Description Specification that specifies the document schema and execution semantics for composing workflows from components such as command line tools and other workflows. The CWL file is able to reference the application container images and also allow the definitions of the Application parameters, input/output interface and the overall process offering parameters.
13+
The CWL contains two main specifications:
14+
15+
- The `CommandLineTool` Description Specification that specifies the document schema and execution semantics for wrapping and executing command line tools
16+
- The `Workflow` Description Specification that specifies the document schema and execution semantics for composing workflows from components such as command line tools and other workflows.
17+
18+
The CWL file is able to reference the application container images and also allow the definitions of the Application parameters, input/output interface and the overall process offering parameters.
1419

1520
Each input to a command line tool has a name and a type (e.g., File, string) and developers are encouraged to include documentation and labels for all components. Metadata about the command line tool descriptions can contain well-defined hints or mandatory requirements such as which software container to use or how much compute resources are required (memory, number of CPU cores, disk space, and/or the maximum time or deadline to complete the step or entire workflow.)
1621

@@ -24,8 +29,5 @@ A container image is an immutable, static file containing the dependencies for t
2429

2530
In overall, a container image describes a container environment whereas a container is an instance of that environment, ran by a container engine (e.g. Docker Engine). It is possible to run multiple containers from the same image, and all of them will contain the same software and configuration, as specified in the image.
2631

27-
In the scope of this Best Practice, the Application Package uses the Common Workflow Language (CWL) Workflow Description specification as encoding to describe the Application, its parameters, the command-line tools used, their arguments and their invocation within containers.
28-
29-
With the use of CWL Workflow Description Standard as encoding, the Application can also possibly yield several Application Packages that expose parameters and inputs in different flavors and execution patterns.
3032

3133
There are multiple community or commercially supported systems that support the CWL standards for executing workflows and a list of free and open-source implementations of the CWL standards

mkdocs.yml

+4-2
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,10 @@ nav:
5757
- Introduction: 'background/background.md'
5858
- Previous OGC Testbeds: 'background/previous-ogc-testbeds.md'
5959
- OGC EO Applications Pilot: 'background/applications-pilot.md'
60-
- EO Application Package Best Practice: 'background/eoap-best-practice.md'
61-
- Common Workflow Language: 'cwl.md'
60+
- Best Practice for EO Application Package: 'background/eoap-best-practice.md'
61+
- Common Workflow Language:
62+
- CWL in a nutshell: 'cwl/nutshell.md'
63+
- CWL in the Best Practice for EO Application Package: 'cwl/cwl-eoap.md'
6264
- Understanding YAML syntax: 'yaml.md'
6365
- Usage Scenarios: 'usage-scenarios.md'
6466
- Best Practices:

0 commit comments

Comments
 (0)