Commit 1e85a305 authored by Maude Le Jeune's avatar Maude Le Jeune
Browse files

doc updated with multiplex and orphan

parent 09704ad0
......@@ -116,7 +116,7 @@ executed first is not defined.
Practically, the creation of a Pipeline object by needs 3 arguments:
Pipeline(pipedot, codedir=, prefix=)
P = Pipeline(pipedot, codedir=, prefix=)
- pipedot is the string description of the pipeline
- codedir is the path of the code of the segments
......@@ -148,20 +148,20 @@ segment "d" will be: [('Lancelot the Brave'), ('Lancelot the Pure'),
*** Multiplex directive
This default behavior can be altered by specifying an @multiplex
This default behavior can be altered by specifying an #multiplex
directive in the commentary of the segment code. If several multiplex
directive can be found the last one is retained.
- @multiplex cross_prod : activate the default behaviour
- #multiplex('cross_prod') : activate the default behaviour
- @multiplex zip : similar to the zip python command. The input set is
- #multiplex('zip') : similar to the zip python command. The input set is
a list of tuples, where each tuple contains the i-th element from
each of the parent sorted output list. If the list have different
size, the shortest is used.
- @multiplex union : The input set contains all the output.
- #multiplex('union') : The input set contains all the output.
- @multiplex gather : The input set contains one tuple of all the ouputs.
- #multiplex('gather') : The input set contains one tuple of all the ouputs.
*** Depend directive
......@@ -170,7 +170,14 @@ directive can be found the last one is retained.
*** Orphan segments
TODO TBD
By default, orphan segments have no input argument (an empty list),
and therefore are executed once.
The possibility is offer to push an input list to an orphan segment.
If P is an instance of the pipeline object:
P.push (segname=seg_input)
*** Hierarchical data storage
......@@ -210,7 +217,7 @@ The segment code is executed in a specific environment that provides:
1. access to the segment input and output
- seg_input: this variable is a dictionnary containing the input of the segment
- seg_output: this variable has to be set to a list containing the
- seg_output: this variable has to be a list.
2. Functionnalities to use the automated hierarchical data storage system.
- get_data_fn(basename): complete the filename with the path to the working directory.
......@@ -236,12 +243,6 @@ The segment code is executed in a specific environment that provides:
hook (hookname, globals()): execute Python script ‘seg_segname_hookname.py’ and update the namespace.
** Running Pipes
*** The interactive mode
......@@ -444,3 +445,4 @@ apache webserver which brings essentially two advantages:
** The Scheduler object
** The Tracker object
** The Worker object
** The Environment object
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment