eoap_cwlwrap

API reference for the top-level package.

wrap(workflow, directory_stage_in=None, directory_stage_out=None, file_stage_in=None, file_stage_out=None)

Composes a CWL Workflow from a series of Workflow/CommandLineTool steps, defined according to Application package patterns based on data stage-in and stage-out behaviors commonly used in EO workflows, and packs it into a single self-contained CWL document.

Parameters:

Name	Type	Description	Default
workflow	Process	The application workflow process to wrap.	required
directory_stage_in	Optional[Process]	The CWL stage-in process for Directory derived types.	None
directory_stage_out	Optional[Process]	The CWL stage-out process for Directory derived types.	None
file_stage_in	Optional[Process]	The CWL stage-in process for File derived types.	None
file_stage_out	Optional[Process]	The CWL stage-out process for File derived types.	None

Returns:

Type	Description
Process	The orchestrating CWL Workflow.

wrap_raw(workflow, directory_stage_out=None, directory_stage_in=None, file_stage_in=None, file_stage_out=None)

Composes a CWL Workflow from a series of Workflow/CommandLineTool steps, defined according to Application package patterns based on data stage-in and stage-out behaviors commonly used in EO workflows, and packs it into a single self-contained CWL document.

Parameters:

Name	Type	Description	Default
workflow	Mapping[str, Any]	The application workflow document as a raw mapping.	required
directory_stage_out	Optional[Mapping[str, Any]]	The CWL stage-out document mapping for Directory derived types.	None
directory_stage_in	Optional[Mapping[str, Any]]	The CWL stage-in document mapping for Directory derived types.	None
file_stage_in	Optional[Mapping[str, Any]]	The CWL stage-in document mapping for File derived types.	None
file_stage_out	Optional[Mapping[str, Any]]	The CWL stage-out document mapping for File derived types.	None

Returns:

Type	Description
Process	The orchestrating CWL Workflow.

wrap_locations(workflows, session=Session(), directory_stage_in=None, directory_stage_out=None, file_stage_in=None, file_stage_out=None)

Composes a CWL Workflow from a series of Workflow/CommandLineTool steps, defined according to Application package patterns based on data stage-in and stage-out behaviors commonly used in EO workflows, and packs it into a single self-contained CWL document.

Parameters:

Name	Type	Description	Default
workflows	str	The application workflow location. Use <location>#<process-id> to select a process from a $graph.	required
directory_stage_in	Optional[str]	The CWL stage-in location for Directory derived types.	None
directory_stage_out	Optional[str]	The CWL stage-out location for Directory derived types.	None
file_stage_in	Optional[str]	The CWL stage-in location for File derived types.	None
file_stage_out	Optional[str]	The CWL stage-out location for File derived types.	None

Returns:

Type	Description
List[Process]	The composed CWL $graph.