You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Unfortunately, this documentation is in the context of Galaxy tool ``requirement`` s instead of CWL ``SoftwareRequirement``s, but the concepts map fairly directly.
207
+
Unfortunately, this documentation is in the context of Galaxy tool ``requirement`` s instead of CWL ``SoftwareRequirement``s, but the concepts map fairly directly.
206
208
207
209
cwltool is distributed with an example of such seqtk tool and sample corresponding
208
210
job. It could executed from the cwltool root using a dependency resolvers
Technical outline of how cwltool works internally, for maintainers.
367
369
368
-
#. Use CWL `load_tool()` to load document.
370
+
#. Use CWL ``load_tool()`` to load document.
369
371
370
372
#. Fetches the document from file or URL
371
373
#. Applies preprocessing (syntax/identifier expansion and normalization)
372
374
#. Validates the document based on cwlVersion
373
375
#. If necessary, updates the document to latest spec
374
-
#. Constructs a Process object using `make_tool()` callback. This yields a
376
+
#. Constructs a Process object using ``make_tool()``` callback. This yields a
375
377
CommandLineTool, Workflow, or ExpressionTool. For workflows, this
376
378
recursively constructs each workflow step.
377
379
#. To construct custom types for CommandLineTool, Workflow, or
378
-
ExpressionTool, provide a custom `make_tool()`
380
+
ExpressionTool, provide a custom ``make_tool()``
379
381
380
-
#. Iterate on the `job()` method of the Process object to get back runnable jobs.
382
+
#. Iterate on the ``job()`` method of the Process object to get back runnable jobs.
381
383
382
-
#. `job()` is a generator method (uses the Python iterator protocol)
383
-
#. Each time the `job()` method is invoked in an iteration, it returns one
384
-
of: a runnable item (an object with a `run()` method), `None` (indicating
384
+
#. ``job()`` is a generator method (uses the Python iterator protocol)
385
+
#. Each time the ``job()`` method is invoked in an iteration, it returns one
386
+
of: a runnable item (an object with a ``run()`` method), ``None`` (indicating
385
387
there is currently no work ready to run) or end of iteration (indicating
386
388
the process is complete.)
387
-
#. Invoke the runnable item by calling `run()`. This runs the tool and gets output.
389
+
#. Invoke the runnable item by calling ``run()``. This runs the tool and gets output.
388
390
#. Output of a process is reported by an output callback.
389
-
#. `job()` may be iterated over multiple times. It will yield all the work
391
+
#. ``job()`` may be iterated over multiple times. It will yield all the work
390
392
that is currently ready to run and then yield None.
391
393
392
-
#. "Workflow" objects create a corresponding "WorkflowJob" and "WorkflowJobStep" objects to hold the workflow state for the duration of the job invocation.
394
+
#. ``Workflow`` objects create a corresponding ``WorkflowJob`` and ``WorkflowJobStep`` objects to hold the workflow state for the duration of the job invocation.
393
395
394
396
#. The WorkflowJob iterates over each WorkflowJobStep and determines if the
395
397
inputs the step are ready.
396
398
#. When a step is ready, it constructs an input object for that step and
397
-
iterates on the `job()` method of the workflow job step.
399
+
iterates on the ``job()`` method of the workflow job step.
398
400
#. Each runnable item is yielded back up to top level run loop
399
401
#. When a step job completes and receives an output callback, the
400
402
job outputs are assigned to the output of the workflow step.
401
403
#. When all steps are complete, the intermediate files are moved to a final
402
404
workflow output, intermediate directories are deleted, and the output
403
405
callback for the workflow is called.
404
406
405
-
#. "CommandLineTool" job() objects yield a single runnable object.
407
+
#. ``CommandLineTool`` job() objects yield a single runnable object.
406
408
407
-
#. The CommandLineTool `job()` method calls `makeJobRunner()` to create a
408
-
`CommandLineJob` object
409
+
#. The CommandLineTool ``job()`` method calls ``makeJobRunner()`` to create a
410
+
``CommandLineJob`` object
409
411
#. The job method configures the CommandLineJob object by setting public
410
412
attributes
411
413
#. The job method iterates over file and directories inputs to the
@@ -416,7 +418,7 @@ Technical outline of how cwltool works internally, for maintainers.
416
418
#. Files are staged to targets paths using either Docker volume binds (when
417
419
using containers) or symlinks (if not). This staging step enables files
418
420
to be logically rearranged or renamed independent of their source layout.
419
-
#. The run() method of CommandLineJob executes the command line tool or
421
+
#. The ``run()`` method of CommandLineJob executes the command line tool or
420
422
Docker container, waits for it to complete, collects output, and makes
0 commit comments