@@ -63,11 +63,13 @@ class LaunchParameters:
63
63
dict [str , list [tuple [str , str ]]] | None
64
64
) = None
65
65
# Workflow inputs (for this step Instance). These Workflow Inputs (files) are
66
- # expected to be present in the Project directory. They are typically a subset of
67
- # the Workflows variables - not necessarily all the workflow inputs, just the
68
- # ones that are required for this step. If provided the structure is expected to
69
- # match that found in a Job definition's variables->inputs.
70
- running_workflow_step_inputs : dict [str , Any ] | None = None
66
+ # expected to be present in the Project directory. It is simply a list of files
67
+ # with the ability to rename them. For example, if the step requires "a.sdf"
68
+ # from the Project directory (and renamed as 'input.sdf" in the step's
69
+ # instance directory) the engine would provide the following list: -
70
+ #
71
+ # [("a.sdf", "input.sdf")]
72
+ running_workflow_step_inputs : list [tuple [str , str ]] | None = None
71
73
# The application ID (a custom resource name)
72
74
# used to identify the 'type' of Instance to create.
73
75
# For DM Jobs this will be 'datamanagerjobs.squonk.it'
@@ -323,10 +325,12 @@ def get_job(
323
325
324
326
@abstractmethod
325
327
def realise_outputs (
326
- self , * , running_workflow_step_id : str , outputs : list [str ]
328
+ self , * , running_workflow_step_id : str , outputs : list [tuple [ str , str ] ]
327
329
) -> tuple [dict [str , Any ], int ]:
328
- """Copy (link) the step's files as outputs into the Project directory.
329
- A step ID is provided, along with a list of outputs (files)."""
330
+ """Copy (link) the step's files as outputs into the Project directory,
331
+ while also renaming the file. A step ID is provided, along with a list of
332
+ outputs (files in the instance directory) and the required counterpart file
333
+ in the Project directory."""
330
334
# Should return an empty map or:
331
335
# {
332
336
# "error": "<error message>",
0 commit comments