master
branchmaster
branchHere are some common terms used in this documentation.
A target (function Ketrew.EDSL.target
) is the basic building block of a
workflow, a target has many components:
Ketrew.EDSL.pbs
returns a
datastructure representing the action of running a program on a host with the
PBS batch scheduler. It is the parameter ?make
of Ketrew.EDSL.target
.Ketrew.EDSL.Host.t
) is a place where one can run things.
Usually a host is an SSH host with a “playground”, and a few other
options.Ketrew.EDSL.Program.t
) is a datastructure representing
shell scripts on steroids, Ketrew provides high-level combinators to build
programs.Ketrew.EDSL.Condition.t
) defines how to tell if a target
should be run or not (the argument ?done_when
of Ketrew.EDSL.target
).?metadata
is,
for now, just a raw string; the ?tags
are a list of strings which are
“searchable” (see “filters” sub-menu in the test-user-interface).`None
(cf. Ketrew_pure.Target.Equivalence.t
).In the EDSL, a target may have a product, which is, for now, just a facility
for the EDSL itself (the engine does not keep track of products).
The ?product
argument can be used to track file-paths within your EDSL
program (see for example the function Ketrew.EDSL.file_target
which
just sets the product and the condition of a target for a given file-path; the
path can be retrieved with my_target#product#path
).
Ketrew's engine is the process in charge of orchestrating and monitoring the run of the workflows.
The engine runs long-running processes through plugins (see documentation).