README.org 29.8 KB
Newer Older
Marc Betoule's avatar
Marc Betoule committed
1 2
The Pipelet Readme

Maude Le Jeune's avatar
Maude Le Jeune committed
3 4
Pipelet is a free framework allowing for the creation, execution and
browsing of scientific data processing pipelines. It provides:
5

Marc Betoule's avatar
Marc Betoule committed
6 7 8 9 10 11 12 13 14 15 16
+ easy chaining of interdependent elementary tasks,
+ web access to data products,
+ branch handling,
+ automated distribution of computational tasks.

Both engine and web interface are written in Python.

* Tutorial
** Introduction
*** Why using pipelines

Maude Le Jeune's avatar
Maude Le Jeune committed
17
The pipeline mechanism allows you to apply a sequence of processing
Marc Betoule's avatar
Marc Betoule committed
18 19 20 21 22 23 24 25
steps to your data, in a way that the input of each process is the
output of the previous one. Making visible these different processing
steps, in the right order, is essential in data analysis to keep track
of what you did, and make sure that the whole processing remains
consistent.

*** How it works

Maude Le Jeune's avatar
Maude Le Jeune committed
26 27 28 29
Pipelet is based on the possibility to save on disk every intermediate
input or output of your pipeline, which is usually not a strong
constraint but offers a lot of benefits. It means that you can stop
the processing whenever you want, and begin it again without
Marc Betoule's avatar
Marc Betoule committed
30 31 32 33 34 35 36
recomputing the whole thing: you just take the last products you have
on disk, and continue the processing where it stopped. This logic is
interesting when the computation cost is higher than the cost of disk
space required by intermediate products.

*** The Pipelet functionalities

Maude Le Jeune's avatar
Maude Le Jeune committed
37 38
Pipelet is a free framework which helps you : 
+ to write and manipulate pipelines with any dependency scheme, 
Marc Betoule's avatar
Marc Betoule committed
39 40 41
+ to dispatch the computational tasks on parallel architectures, 
+ to keep track of what processing has been applied to your data and perform comparisons.

Maude Le Jeune's avatar
Maude Le Jeune committed
42

Marc Betoule's avatar
Marc Betoule committed
43
** Getting started
Maude Le Jeune's avatar
Maude Le Jeune committed
44 45 46 47 48 49
*** Pipelet installation 
**** Dependencies 

+ Running the Pipelet engine requires Python >= 2.6.

+ The web interface of Pipelet requires the installation of the
50
  cherrypy3 Python module (on Debian: aptitude install python-cherrypy3).
Maude Le Jeune's avatar
Maude Le Jeune committed
51

52
You may find useful to install some generic scientific tools that nicely interact with Pipelet: 
Maude Le Jeune's avatar
Maude Le Jeune committed
53 54 55
+ numpy
+ matplotlib
+ latex 
Marc Betoule's avatar
Marc Betoule committed
56

Maude Le Jeune's avatar
Maude Le Jeune committed
57
**** Getting Pipelet
Marc Betoule's avatar
Marc Betoule committed
58

59
There is not any published stable release of Pipelet right now.
Marc Betoule's avatar
Marc Betoule committed
60

Marc Betoule's avatar
Marc Betoule committed
61
=git clone git://gitorious.org/pipelet/pipelet.git=
Marc Betoule's avatar
Marc Betoule committed
62

Maude Le Jeune's avatar
Maude Le Jeune committed
63
**** Installing Pipelet
Marc Betoule's avatar
Marc Betoule committed
64

Marc Betoule's avatar
Marc Betoule committed
65
=sudo python setup.py install=
Marc Betoule's avatar
Marc Betoule committed
66

67
*** Running a simple test pipeline
Marc Betoule's avatar
Marc Betoule committed
68 69 70

1. Run the test pipeline

Marc Betoule's avatar
Marc Betoule committed
71 72 73
=cd test/first_test=

=python main.py=
Marc Betoule's avatar
Marc Betoule committed
74 75 76

2. Add this pipeline to the web interface

Marc Betoule's avatar
Marc Betoule committed
77
=pipeweb track test ./.sqlstatus=
Marc Betoule's avatar
Marc Betoule committed
78 79 80

3. Set the access control and launch the web server

Marc Betoule's avatar
Marc Betoule committed
81 82 83
=pipeutils -a username -l 2 .sqlstatus=

=pipeweb start=
Marc Betoule's avatar
Marc Betoule committed
84 85 86 87

4. You should be able to browse the result on the web page
   http://localhost:8080

88 89
*** Getting a new pipe framework

Maude Le Jeune's avatar
Maude Le Jeune committed
90
To get a new pipeline framework, with example main and segment scripts : 
91

Marc Betoule's avatar
Marc Betoule committed
92
=pipeutils -c pipename=
93

Maude Le Jeune's avatar
Maude Le Jeune committed
94 95 96 97 98
This command ends up with the creation of directory named pipename wich contains: 
+ a main script (named main.py) providing functionnalities to execute
  your pipeline in various modes (debug, parallel, batch mode, ...)
+ an example of segment script (seg_default_code.py) which illustrates
  the pipelet utilities with comments. 
99

Maude Le Jeune's avatar
Maude Le Jeune committed
100
The next section describes those two files in more details. 
101

Marc Betoule's avatar
Marc Betoule committed
102

Maude Le Jeune's avatar
Maude Le Jeune committed
103
** Writing Pipes
Marc Betoule's avatar
Marc Betoule committed
104 105 106 107 108 109 110 111 112 113
*** Pipeline architecture

The definition of a data processing pipeline consists in :
+ a succession of python scripts, called segments, coding each step
  of the actual processing.
+ a main script that defines the dependency scheme between segments,
  and launch the processing.

The dependencies between segments must form a directed acyclic
graph. This graph is described by a char string using a subset of the
114
graphviz dot language (http://www.graphviz.org). For example the string:
Marc Betoule's avatar
Marc Betoule committed
115

Marc Betoule's avatar
Marc Betoule committed
116
#+begin_src python
Marc Betoule's avatar
Marc Betoule committed
117
"""
Marc Betoule's avatar
Marc Betoule committed
118 119 120
a -> b -> d;
c -> d;
c -> e;
Marc Betoule's avatar
Marc Betoule committed
121
"""
Marc Betoule's avatar
Marc Betoule committed
122 123 124 125 126 127 128 129
#+end_src

defines a pipeline with 5 segments ={"a", "b", "c", "d", "e"}=. The
relation =a->b= ensures that the processing of the segment "a" will be
done before the processing of its child segment =b=. Also the output
of =a= will be fed as input for =b=. In the given example, the node
=d= has two parents =b= and =c=. Both will be executed before =d=. As
their is no relation between =b= and =c= which of the two will be
Marc Betoule's avatar
Marc Betoule committed
130 131
executed first is not defined.

Marc Betoule's avatar
Marc Betoule committed
132 133 134
When executing the segment =seg=, the engine looks for a python script
named =seg.py=. If not found, it looks iteratively for script files
named =se.py= and =s.py=. This way, different segments of the pipeline
Maude Le Jeune's avatar
Maude Le Jeune committed
135
can share the same code, if they are given a name with a common root
136
(this mechanism is useful to write generic segment and is completed by
Maude Le Jeune's avatar
Maude Le Jeune committed
137
the hooking system, described in the advanced usage section). The code
Marc Betoule's avatar
Marc Betoule committed
138 139
is then executed in a specific namespace (see below [[*The%20segment%20environment][The execution
environment]]).
Maude Le Jeune's avatar
Maude Le Jeune committed
140

Marc Betoule's avatar
Marc Betoule committed
141 142
*** The Pipeline object

Maude Le Jeune's avatar
Maude Le Jeune committed
143
Practically, the creation of a Pipeline object needs 3 arguments:
Marc Betoule's avatar
Marc Betoule committed
144

Marc Betoule's avatar
Marc Betoule committed
145 146 147
#+begin_src python
P = Pipeline(pipedot, codedir="./", prefix="./")
#+end_src
Marc Betoule's avatar
Marc Betoule committed
148

Marc Betoule's avatar
Marc Betoule committed
149 150 151 152

- =pipedot= is the string description of the pipeline
- =codedir= is the path where the segment scripts can be found
- =prefix=  is the path to the data repository (see below [[*Hierarchical%20data%20storage][Hierarchical data storage]])
Marc Betoule's avatar
Marc Betoule committed
153

154 155 156
It is possible to output the graphviz representation of the pipeline
(needs graphviz installed). First, save the graph string into a .dot
file with the pipelet function:
Maude Le Jeune's avatar
Maude Le Jeune committed
157

Marc Betoule's avatar
Marc Betoule committed
158 159

#+begin_src python
Maude Le Jeune's avatar
Maude Le Jeune committed
160
P.to_dot('pipeline.dot')
Marc Betoule's avatar
Marc Betoule committed
161
#+end_src
Maude Le Jeune's avatar
Maude Le Jeune committed
162 163 164

Then, convert it to an image file with the dot command: 

Marc Betoule's avatar
Marc Betoule committed
165
=dot -Tpng -o pipeline.png pipeline.dot=
Maude Le Jeune's avatar
Maude Le Jeune committed
166

Marc Betoule's avatar
Marc Betoule committed
167 168
*** Dependencies between segments

Marc Betoule's avatar
Marc Betoule committed
169 170 171 172 173
The modification of the code of one segment will trigger its
recalculation and the recalculation of all the segments which
depend on it.

The output of a segment is a list of python objects. If a segment as
Maude Le Jeune's avatar
Maude Le Jeune committed
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
no particular output this list can be empty and do not need to be
specified. Elements of the list are allowed to be any kind of
pickleable python objects. However, a good practice is to fill the
list with the minimal set of characteristics relevant to describe the
output of the segment and to defer the storage of the data to
appropriate structures and file formats. For example, a segment which
performs computation on large images could virtually pass the results
of its computation to the following segment using the output list. It
is a better practice to store the resulting image in a dedicated file
and to pass in the list only the information allowing a non ambiguous
identification of this file (like its name or part of it) for the
following segments.

The input of a child segment is taken in a set build from the output
lists of its parents. The content of the input set is actually tunable
using the multiplex directive (see below). However the simplest and
190
default behavior of the engine is to form the Cartesian product of
Maude Le Jeune's avatar
Maude Le Jeune committed
191 192
the output list of its parent.

193
To illustrate this behavior let us consider the following pipeline,
Maude Le Jeune's avatar
Maude Le Jeune committed
194 195
build from three segments:

Marc Betoule's avatar
Marc Betoule committed
196 197 198 199 200 201
#+begin_src python
"""
knights -> melt;
quality -> melt;
"""
#+end_src
Maude Le Jeune's avatar
Maude Le Jeune committed
202 203 204 205

and assume that the respective output lists of segments knights and
quality are:

Marc Betoule's avatar
Marc Betoule committed
206 207 208
#+begin_src python
["Lancelot", "Galahad"]
#+end_src
Maude Le Jeune's avatar
Maude Le Jeune committed
209
and:
Marc Betoule's avatar
Marc Betoule committed
210 211 212
#+begin_src python
['the Brave', 'the Pure']
#+end_src
Maude Le Jeune's avatar
Maude Le Jeune committed
213

214
The Cartesian product of the previous set is:
Marc Betoule's avatar
Marc Betoule committed
215
#+begin_src python
Maude Le Jeune's avatar
Maude Le Jeune committed
216 217
 [('Lancelot','the Brave'), ('Lancelot,'the Pure'), ('Galahad','the Brave'), ('Galahad','the
Pure')]
Marc Betoule's avatar
Marc Betoule committed
218
#+end_src
Maude Le Jeune's avatar
Maude Le Jeune committed
219

Marc Betoule's avatar
Marc Betoule committed
220
Four instances of segment =melt= will thus be run, each one receiving
Maude Le Jeune's avatar
Maude Le Jeune committed
221 222 223
as input one of the four 2-tuples.

At the end of the execution of all the instances of a segment, their
Marc Betoule's avatar
Marc Betoule committed
224
output lists are concatenated. If the action of segment =melt= is to
Maude Le Jeune's avatar
Maude Le Jeune committed
225
concatenate the two strings he receives separated by a space, the
Marc Betoule's avatar
Marc Betoule committed
226
final output set of segment =melt= will be: 
Maude Le Jeune's avatar
Maude Le Jeune committed
227

Marc Betoule's avatar
Marc Betoule committed
228 229 230
#+begin_src python
[('Lancelot the Brave'), ('Lancelot the Pure'), ('Galahad the Brave'), ('Galahad the Pure')].
#+end_src
Marc Betoule's avatar
Marc Betoule committed
231

Marc Betoule's avatar
Marc Betoule committed
232
This default behavior can be altered by specifying a =#multiplex=
Marc Betoule's avatar
Marc Betoule committed
233 234
directive in the commentary of the segment code. See section [[*Multiplex%20directive][Multiplex
directive]] for more details.
235

236 237 238 239
As the segment execution order is not uniquely determined by the pipe
scheme (several path may exists), it is not possible to retrieve an
ordered input tuple. To overcome this issue, segment inputs are
dictionaries, with keywords matching parent segment names.  In the
Marc Betoule's avatar
Marc Betoule committed
240
above example, one can read =melt= inputs using:
241

Marc Betoule's avatar
Marc Betoule committed
242
#+begin_src python
243 244
k = seg_input["knights"]
q = seg_input["quality"]
Marc Betoule's avatar
Marc Betoule committed
245
#+end_src
246

Marc Betoule's avatar
Marc Betoule committed
247
See section [[*The%20segment%20environment]['The segment environment']] for more details.
248

Marc Betoule's avatar
Marc Betoule committed
249
*** Orphan segments
Marc Betoule's avatar
Marc Betoule committed
250

251 252 253 254 255
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:

Marc Betoule's avatar
Marc Betoule committed
256
#+begin_src python
257
P.push (segname=[1,2,3])
Marc Betoule's avatar
Marc Betoule committed
258
#+end_src
259 260

From the segment environment, inputs can be retrieve from the
Marc Betoule's avatar
Marc Betoule committed
261
usual dictionary, using the keyword =segnamephantom=. 
262

Marc Betoule's avatar
Marc Betoule committed
263
#+begin_src python
264
id = seg_input['segnamephantom']
Marc Betoule's avatar
Marc Betoule committed
265
#+end_src
266
or
Marc Betoule's avatar
Marc Betoule committed
267
#+begin_src python
268
id = seg_input.values()[0]
Marc Betoule's avatar
Marc Betoule committed
269
#+end_src
270

Marc Betoule's avatar
Marc Betoule committed
271
See section [[*The%20segment%20environment][The segment environment]] for more details.
272

Marc Betoule's avatar
Marc Betoule committed
273 274
*** Hierarchical data storage

275 276 277 278 279 280
The framework provides versioning of your data and easy access
through the web interface. It is also used to keep track of the code,
of the execution logs, and various meta-data of the processing. Of
course, you remain able to bypass the hierarchical storage and store
your actual data elsewhere, but you will loose the benefit of
automated versioning which proves to be quite convenient.
Marc Betoule's avatar
Marc Betoule committed
281 282

The storage is organized as follows:
283 284 285

- all pipeline instances are stored below a root which corresponds to
  the prefix parameter of the Pipeline object. 
Marc Betoule's avatar
Marc Betoule committed
286
      =/prefix/=
287
- all segment meta data are stored below a root which name corresponds
288
  to a unique hash of the segment code.
Marc Betoule's avatar
Marc Betoule committed
289
      =/prefix/segname_YFLJ65/=
290 291 292 293 294 295 296
- Segment's meta data are: 
  - a copy of the segment python script
  - a copy of all segment hook scripts
  - a parameter file (.args) which contains segment parameters value
  - a meta data file (.meta) which contains some extra meta data
- all segment instances data and meta data are stored in a specific subdirectory
  which name corresponds to a string representation of its input
Marc Betoule's avatar
Marc Betoule committed
297
  	=/prefix/segname_YFLJ65/data/1/=
298
- if there is a single segment instance, then data are stored in
Marc Betoule's avatar
Marc Betoule committed
299
       =/prefix/segname_YFLJ65/data/=
300 301
- If a segment has at least one parent, its root will be located below
  one of its parent's one : 
Marc Betoule's avatar
Marc Betoule committed
302
       =/prefix/segname_YFLJ65/segname2_PLMBH9/=
303
- etc...
Maude Le Jeune's avatar
Maude Le Jeune committed
304
  
Marc Betoule's avatar
Marc Betoule committed
305 306 307 308 309
*** The segment environment

The segment code is executed in a specific environment that provides:

1. access to the segment input and output
Marc Betoule's avatar
Marc Betoule committed
310
   - =seg_input=:  this variable is a dictionary containing the input of the segment.
311

Marc Betoule's avatar
Marc Betoule committed
312
     In the general case, =seg_input= is a python dictionary which
313
     contains as many keywords as parent segments. In the case of orphan
Marc Betoule's avatar
Marc Betoule committed
314 315
     segment, the keyword used is suffixed by the =phantom= word. 
     One exception to this is coming from the use of the =group_by=
316 317 318
     directive, which alters the origin of the inputs. In this case,
     seg_input contains the resulting class elements. 

Marc Betoule's avatar
Marc Betoule committed
319
   - =seg_output=: this variable has to be a list. 
Marc Betoule's avatar
Marc Betoule committed
320

321
2. Functionalities to use the automated hierarchical data storage system.
Marc Betoule's avatar
Marc Betoule committed
322 323
   - =get_data_fn(basename)=: complete the filename with the path to the working directory. 
   - =glob_seg(seg, regexp)=: return the list of filename in segment seg
324
     working directory matching regexp.
Marc Betoule's avatar
Marc Betoule committed
325
   - =get_tmp_fn()=: return a temporary filename.
Marc Betoule's avatar
Marc Betoule committed
326

327
3. Functionalities to use the automated parameters handling
Marc Betoule's avatar
Marc Betoule committed
328 329 330
   - =lst_par=: list of parameter names of the segment to save in the meta data.
   - =lst_tag=: list of parameter names which will be made visible from the web interface
   - =load_param(seg, globals(), lst_par)=: retrieve parameters from the meta data.
331 332

4. Various convenient functionalities
Marc Betoule's avatar
Marc Betoule committed
333
   - =save_products(filename, lst_par)=: use pickle to save a
334
     part of the current namespace.
Marc Betoule's avatar
Marc Betoule committed
335
   - =load_products(filename, lst_par)=: update the namespace by
Marc Betoule's avatar
Marc Betoule committed
336
     unpickling requested object from the file.
Marc Betoule's avatar
Marc Betoule committed
337 338 339
   - =logged_subprocess(lst_args)=: execute a subprocess and log its
     output in =processname.log= and =processname.err=.
   - =logger= is a standard =logging.Logger= object that can be used to
Betoule Marc's avatar
Betoule Marc committed
340
     log the processing
Marc Betoule's avatar
Marc Betoule committed
341

342
5. Hooking support 
Marc Betoule's avatar
Marc Betoule committed
343 344
   Pipelet enables you to write reusable generic
   segments by providing a hooking system via the hook function.
Marc Betoule's avatar
Marc Betoule committed
345 346 347
   =hook(hookname, globals())=: execute Python script =segname_hookname.py= and update the namespace.
   See the section [[*The%20hooking%20system][Hooking system]] for more details.

Marc Betoule's avatar
Marc Betoule committed
348 349


350
*** The example pipelines
351
**** fft
Maude Le Jeune's avatar
Maude Le Jeune committed
352 353 354 355 356 357 358 359 360

***** Highlights

This example illustrates a very simple image processing use.
The problematic is the following : one wants to apply a Gaussian
filter in Fourier domain on several 2D images. 

The pipe scheme is: 

Marc Betoule's avatar
Marc Betoule committed
361
#+begin_src python
Maude Le Jeune's avatar
Maude Le Jeune committed
362 363 364 365
pipedot = """
mkgauss->convol;
fftimg->convol;
"""
Marc Betoule's avatar
Marc Betoule committed
366
#+end_src
Maude Le Jeune's avatar
Maude Le Jeune committed
367 368 369 370 371 372

where segment 'mkgauss' computes the Gaussian filter, 'fftimg' computes the
Fourier transforms of the input images, and 'convol' performs the
filtering in Fourier domain, and the inverse transform of the filtered
images. 

Marc Betoule's avatar
Marc Betoule committed
373
#+begin_src python
Maude Le Jeune's avatar
Maude Le Jeune committed
374 375
P = pipeline.Pipeline(pipedot, code_dir=op.abspath('./'), prefix=op.abspath('./'))
P.to_dot('pipeline.dot')
Marc Betoule's avatar
Marc Betoule committed
376
#+end_src
Maude Le Jeune's avatar
Maude Le Jeune committed
377 378 379 380

The pipe scheme is output as a .dot file, that can be converted to an
image file with the command line: 

Marc Betoule's avatar
Marc Betoule committed
381
=dot -Tpng -o pipeline.png pipeline.dot=
Maude Le Jeune's avatar
Maude Le Jeune committed
382 383 384

To apply this filter to several images (in our case 4 input images),
the pipe data parallelism is used. 
Marc Betoule's avatar
Marc Betoule committed
385
From the main script, a 4-element list is pushed to the =fftimg=
Maude Le Jeune's avatar
Maude Le Jeune committed
386 387
segment. 

Marc Betoule's avatar
Marc Betoule committed
388
#+begin_src python
Maude Le Jeune's avatar
Maude Le Jeune committed
389
P.push(fftimg=[1,2,3,4]) 
Marc Betoule's avatar
Marc Betoule committed
390
#+end_src
Maude Le Jeune's avatar
Maude Le Jeune committed
391

Marc Betoule's avatar
Marc Betoule committed
392
At execution, 4 instances of the =fftimg= segment will be
Maude Le Jeune's avatar
Maude Le Jeune committed
393 394
created, and each of them outputs one element of this list : 

Marc Betoule's avatar
Marc Betoule committed
395
#+begin_src python
Maude Le Jeune's avatar
Maude Le Jeune committed
396 397
img = seg_input.values()[0] #(fftimg.py - line 16)
seg_output = [img]          #(fftimg.py - line 41)
Marc Betoule's avatar
Marc Betoule committed
398
#+end_src
Maude Le Jeune's avatar
Maude Le Jeune committed
399

Marc Betoule's avatar
Marc Betoule committed
400
On the other side, a single instance of the =mkgauss= segment will be
Maude Le Jeune's avatar
Maude Le Jeune committed
401 402
executed, as there is one filter to apply. 

Marc Betoule's avatar
Marc Betoule committed
403
The last segment =convol=, which depends on the two others, will be
Maude Le Jeune's avatar
Maude Le Jeune committed
404 405 406
executed with a number of instances that is the Cartesian product of
its 4+1 inputs (ie 4 instances)

Marc Betoule's avatar
Marc Betoule committed
407
The instance identifier which is set by the =fftimg= output, can be
Maude Le Jeune's avatar
Maude Le Jeune committed
408 409
retrieve with the following instruction: 

Marc Betoule's avatar
Marc Betoule committed
410
#+begin_src python
Maude Le Jeune's avatar
Maude Le Jeune committed
411
img = seg_input['fftimg']   #(convol.py - line 12)
Marc Betoule's avatar
Marc Betoule committed
412
#+end_src
Maude Le Jeune's avatar
Maude Le Jeune committed
413 414 415 416 417 418 419

***** Running the pipe

Follow the same procedure than for the first example pipeline, to run
this pipe and browse the result. 


420 421
**** cmb
***** Running the pipe
Maude Le Jeune's avatar
Maude Le Jeune committed
422

423 424 425
This CMB pipeline depends on two external python modules: 
+ healpy   :  http://code.google.com/p/healpy/
+ spherelib:  http://gitorious.org/spherelib
Maude Le Jeune's avatar
Maude Le Jeune committed
426 427


Maude Le Jeune's avatar
Maude Le Jeune committed
428 429 430 431 432 433 434 435 436 437 438 439 440 441
***** Problematic

This example illustrates a very simple CMB data processing use.  

The problematic is the following : one wants to characterize the
inverse noise weighting spectral estimator (as applied to the WMAP 1yr
data). A first demo pipeline is built to check that the algorithm
has correctly been implemented. Then, Monte Carlo simulations are used
to compute error bars estimates. 

***** A design pipeline

The design pipe scheme is: 

Marc Betoule's avatar
Marc Betoule committed
442
#+begin_src python
Maude Le Jeune's avatar
Maude Le Jeune committed
443 444 445 446 447
pipe_dot = """ 
cmb->clcmb->clplot;
noise->clcmb;
noise->clnoise->clplot;
"""
Marc Betoule's avatar
Marc Betoule committed
448
#+end_src
Maude Le Jeune's avatar
Maude Le Jeune committed
449 450

where: 
Marc Betoule's avatar
Marc Betoule committed
451 452 453
+ =cmb=: generate a CMB map from LCDM power spectrum. 
+ =noise=: compute the mode coupling matrix from the input hit-count map
+ =clnoise=: compute the empirical noise power spectrum from a noise
Maude Le Jeune's avatar
Maude Le Jeune committed
454
  realization. 
Marc Betoule's avatar
Marc Betoule committed
455
+ =clcmb=: generate two noise realizations, add them to the CMB map, to compute a
Maude Le Jeune's avatar
Maude Le Jeune committed
456 457 458
  first cross spectrum estimator. Then weighting mask and mode
  coupling matrix are applied to get the inverse noise weighting
  estimator
Marc Betoule's avatar
Marc Betoule committed
459
+ =clplot=: make a plot to compare pure cross spectrum vs inverse noise
Maude Le Jeune's avatar
Maude Le Jeune committed
460 461 462 463 464 465 466 467 468 469
  weighting estimators. 

As the two first orphan segments depends on a single shared parameter
which is the map resolution nside, this argument is pushed from the
main script. 

Another input argument of the cmb segment, is its simulation identifier,
which will be used for latter Monte Carlo. In order to push two
inputs to a single segment instance, we use python tuple data type.

Marc Betoule's avatar
Marc Betoule committed
470
#+begin_src python
Maude Le Jeune's avatar
Maude Le Jeune committed
471 472
P.push(cmb=[(nside, 1)])
P.push(noise=[nside])
Marc Betoule's avatar
Marc Betoule committed
473
#+end_src
Maude Le Jeune's avatar
Maude Le Jeune committed
474 475 476

From the segment, those inputs are retrieved with : 

Marc Betoule's avatar
Marc Betoule committed
477
#+begin_src python
Maude Le Jeune's avatar
Maude Le Jeune committed
478 479 480
nside  = seg_input.values()[0][0] ##(cmb.py line 13)
sim_id = seg_input.values()[0][1] ##(cmb.py line 14)
nside  = seg_input.values()[0]  ##(noise.py line 16)
Marc Betoule's avatar
Marc Betoule committed
481
#+end_src
Maude Le Jeune's avatar
Maude Le Jeune committed
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497

The last segment produces a plot in which we compare: 
+ the input LCDM power spectrum
+ the binned cross spectrum of the noisy CMB maps
+ the binned cross spectrum of which we applied hitcount weight and
  mode coupling matrix. 
+ the noise power spectrum computed by clnoise segment. 

In this plot we check that both estimators are corrects, and that the
noise level is the expected one.

***** From the design pipeline to Monte Carlo

As a second step, Monte Carlo simulations are used to compute error
bars. 

Marc Betoule's avatar
Marc Betoule committed
498
The =clnoise= segment is no longer needed, so that the new pipe scheme
Maude Le Jeune's avatar
Maude Le Jeune committed
499 500
reads : 

Marc Betoule's avatar
Marc Betoule committed
501
#+begin_src python
Maude Le Jeune's avatar
Maude Le Jeune committed
502 503 504 505
pipe_dot = """ 
cmb->clcmb->clplot;
noise->clcmb;
"""
Marc Betoule's avatar
Marc Betoule committed
506
#+end_src
Maude Le Jeune's avatar
Maude Le Jeune committed
507 508

We now use the native data parallelization scheme of the pipe to build
Marc Betoule's avatar
Marc Betoule committed
509
many instances of the =cmb= and =clcmb= segments. 
Maude Le Jeune's avatar
Maude Le Jeune committed
510

Marc Betoule's avatar
Marc Betoule committed
511
#+begin_src python
Maude Le Jeune's avatar
Maude Le Jeune committed
512 513 514 515
cmbin = []
for sim_id in [1,2,3,4,5,6]:
    cmbin.append((nside, sim_id))
P.push(cmb=cmbin)
Marc Betoule's avatar
Marc Betoule committed
516
#+end_src
Maude Le Jeune's avatar
Maude Le Jeune committed
517 518


Marc Betoule's avatar
Marc Betoule committed
519
** Running Pipes
520
   
521 522
*** The sample main file

523
A sample main file is made available when creating a new Pipelet
524 525
framework. It is copied from the reference file: 

Marc Betoule's avatar
Marc Betoule committed
526
=pipelet/pipelet/static/main.py=
527 528 529 530 531 532

This script illustrates various ways of running pipes. It describes
the different parameters, and also, how to write a
main python script can be used as any binary from the command line
(including options parsing). 

Maude Le Jeune's avatar
Maude Le Jeune committed
533
	   
534 535 536 537 538 539
*** Common options
Some options are common to each running modes.
**** log level

The logging system is handle by the python logging facility module. 
This module defines the following log levels : 
Marc Betoule's avatar
Marc Betoule committed
540 541 542 543 544
+ =DEBUG=
+ =INFO=
+ =WARNING=
+ =ERROR=
+ =CRITICAL=
545

546
All logging messages are saved in the different Pipelet log files,
547 548 549 550 551
available from the web interface (rotating file logging).  It is also
possible to print those messages on the standard output (stream
logging), by setting the desired log level in the launchers options:
For example: 

Marc Betoule's avatar
Marc Betoule committed
552
#+begin_src python
553 554
import logging
launch_process(P, N,log_level=logging.DEBUG)
Marc Betoule's avatar
Marc Betoule committed
555
#+end_src
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575

If set to 0, stream logging will be disable. 

**** matplotlib

The matplotlib documentation says: 

"Many users report initial problems trying to use maptlotlib in web
application servers, because by default matplotlib ships configured to
work with a graphical user interface which may require an X11
connection. Since many barebones application servers do not have X11
enabled, you may get errors if you don’t configure matplotlib for use
in these environments. Most importantly, you need to decide what kinds
of images you want to generate (PNG, PDF, SVG) and configure the
appropriate default backend. For 99% of users, this will be the Agg
backend, which uses the C++ antigrain rendering engine to make nice
PNGs. The Agg backend is also configured to recognize requests to
generate other output formats (PDF, PS, EPS, SVG). The easiest way to
configure matplotlib to use Agg is to call:

Marc Betoule's avatar
Marc Betoule committed
576
=matplotlib.use('Agg')=
577

Marc Betoule's avatar
Marc Betoule committed
578
The =matplotlib= and =matplotlib_interactive= options turn the matplotlib
579 580 581
backend to Agg in order to allow the execution in non-interactive
environment.

Marc Betoule's avatar
Marc Betoule committed
582 583 584
Those two options are set to =True= by default in the sample main
script. Setting them to =matplotlib_interactive=
TODO
585

Marc Betoule's avatar
Marc Betoule committed
586
*** The interactive mode
Marc Betoule's avatar
Marc Betoule committed
587
This mode has been designed to ease debugging. If =P= is an instance of
588
the pipeline object, the syntax reads :
Marc Betoule's avatar
Marc Betoule committed
589

Marc Betoule's avatar
Marc Betoule committed
590
#+begin_src python
Marc Betoule's avatar
Marc Betoule committed
591 592 593
from pipelet.launchers import launch_interactive
w, t = launch_interactive(P)
w.run()
Marc Betoule's avatar
Marc Betoule committed
594
#+end_src
Marc Betoule's avatar
Marc Betoule committed
595 596 597 598

In this mode, each tasks will be computed in a sequential way. 
Do not hesitate to invoque the Python debugger from IPython : %pdb

Maude Le Jeune's avatar
Maude Le Jeune committed
599
To use the interactive mode, run: 
Marc Betoule's avatar
Marc Betoule committed
600
=main.py -d=
601 602


Marc Betoule's avatar
Marc Betoule committed
603
*** The process mode
604 605 606 607
In this mode, one can run simultaneous tasks (if the pipe scheme
allows to do so). 
The number of subprocess is set by the N parameter : 

Marc Betoule's avatar
Marc Betoule committed
608
#+begin_src python
609 610
from pipelet.launchers import launch_process
launch_process(P, N)
Marc Betoule's avatar
Marc Betoule committed
611
#+end_src
612

Maude Le Jeune's avatar
Maude Le Jeune committed
613
To use the process mode, run: 
Marc Betoule's avatar
Marc Betoule committed
614
=main.py=
Maude Le Jeune's avatar
Maude Le Jeune committed
615
or
Marc Betoule's avatar
Marc Betoule committed
616
=main.py -p 4=
Maude Le Jeune's avatar
Maude Le Jeune committed
617

Marc Betoule's avatar
Marc Betoule committed
618
*** The batch mode
619 620 621
In this mode, one can submit some batch jobs to execute the tasks. 
The number of job is set by the N parameter : 

Marc Betoule's avatar
Marc Betoule committed
622
#+begin_src python
623 624
from pipelet.launchers import launch_pbs
launch_pbs(P, N , address=(os.environ['HOST'],50000))
Marc Betoule's avatar
Marc Betoule committed
625
#+end_src
Marc Betoule's avatar
Marc Betoule committed
626

627 628 629 630 631 632 633 634 635 636 637
It is possible to specify some job submission options like: 
+ job name 
+ job header: this string is prepend to the PBS job scripts. You may
  want to add some environment specific paths. Log and error files are
  automatically handled by the pipelet engine, and made available from
  the web interface. 
+ cpu time: syntax is: "hh:mm:ss"

The 'server' option can be disable to add some workers to an existing
scheduler.

Maude Le Jeune's avatar
Maude Le Jeune committed
638
To use the batch mode, run: 
Marc Betoule's avatar
Marc Betoule committed
639
=main.py -b=
Maude Le Jeune's avatar
Maude Le Jeune committed
640 641 642

to start the server, and: 

Marc Betoule's avatar
Marc Betoule committed
643
=main.py -a 4=
644

Maude Le Jeune's avatar
Maude Le Jeune committed
645
to add 4 workers. 
Maude Le Jeune's avatar
Maude Le Jeune committed
646

Marc Betoule's avatar
Marc Betoule committed
647
** Browsing Pipes
648 649 650 651 652
*** The pipelet webserver and ACL

The pipelet webserver allows the browsing of multiple pipelines. 
Each pipeline has to be register using : 

Marc Betoule's avatar
Marc Betoule committed
653
=pipeweb track <shortname> sqlfile=
654

655 656
To remove a pipeline from the tracked list, use : 

Marc Betoule's avatar
Marc Betoule committed
657
=pipeweb untrack <shortname>=
658

659 660 661 662
As the pipeline browsing implies a disk parsing, some basic security
has to be set also. All users have to be register with a specific access
level (1 for read-only access, and 2 for write access).  

Marc Betoule's avatar
Marc Betoule committed
663
=pipeutils -a <username> -l 2 sqlfile=
Marc Betoule's avatar
Marc Betoule committed
664

665 666
To remove a user from the user list: 

Marc Betoule's avatar
Marc Betoule committed
667
=pipeutils -d <username> sqlfile=
668

669 670
Start the web server using : 

Marc Betoule's avatar
Marc Betoule committed
671
=pipeweb start=
672 673

Then the web application will be available on the web page http://localhost:8080
Marc Betoule's avatar
Marc Betoule committed
674

675 676
To stop the web server : 

Marc Betoule's avatar
Marc Betoule committed
677
=pipeweb stop=
678

Marc Betoule's avatar
Marc Betoule committed
679
*** The web application
680

681
In order to ease the comparison of different processing, the web
682 683 684 685
interface displays various views of the pipeline data : 

**** The index page 

686
The index page displays a tree view of all pipeline instances. Each
687 688 689 690 691 692
segment may be expand or reduce via the +/- buttons.  

The parameters used in each segments are resumed and displayed with
the date of execution and the number of related tasks order by
status. 

693
A check-box allows to performed operation on multiple segments :
694 695 696
  - deletion : to clean unwanted data
  - tag : to tag remarkable data

697
The filter panel allows to display the segment instances with respect to 2
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
criterions :
  - tag
  - date of execution

**** The code page

Each segment names is a link to its code page. From this page the user
can view all python scripts code which have been applied to the data.

The tree view is reduced to the current segment and its related
parents.

The root path corresponding to the data storage is also displayed.


**** The product page

The number of related tasks, order by status, is a link to the product
pages, where the data can be directly displayed (if images, or text
files) or downloaded. 
From this page it is also possible to delete a specific product and
its dependencies. 


**** The log page

724
The log page can be acceded via the log button of the filter panel.
725 726 727 728
Logs are ordered by date. 



Marc Betoule's avatar
Marc Betoule committed
729 730

* Advanced usage
731 732

** Multiplex directive
Marc Betoule's avatar
Marc Betoule committed
733
   
734

Marc Betoule's avatar
Marc Betoule committed
735
The default behavior can be altered by specifying a =#multiplex=
736 737 738 739 740
directive in the commentary of the segment code. If several multiplex
directives are present in the segment code the last one is retained.

The multiplex directive can be one of: 

Marc Betoule's avatar
Marc Betoule committed
741
+ =#multiplex cross_prod= : default behavior, return the Cartesian
742
  product. 
Marc Betoule's avatar
Marc Betoule committed
743
+ =#multiplex union= : make the union of the inputs
744

Marc Betoule's avatar
Marc Betoule committed
745
Moreover the =#multiplex cross_prod= directive admits filtering and
746 747
grouping by class similarly to SQL requests:

Marc Betoule's avatar
Marc Betoule committed
748
#+begin_src python
749
#multiplex cross_prod where "condition" group_by "class_function"
Marc Betoule's avatar
Marc Betoule committed
750
#+end_src
751

Marc Betoule's avatar
Marc Betoule committed
752
=condition= and =class_function= are python code evaluated for each element
753 754
of the product set. 

Marc Betoule's avatar
Marc Betoule committed
755 756
The argument of =where= is a condition. The element will be part of the
input set only if it evaluates to =True=.
757

Marc Betoule's avatar
Marc Betoule committed
758
The =group_by= directive groups elements into class according to the
759 760 761 762 763 764 765 766 767
result of the evaluation of the given class function. The input set
contains all the resulting class. For example, if the function is a
constant, the input set will contain only one element: the class
containing all elements.

During the evaluation, the values of the tuple elements are accessible
as variable wearing the name of the corresponding parents.


Marc Betoule's avatar
Marc Betoule committed
768 769 770 771 772 773 774 775
Given the Cartesian product set:
#+begin_src python
 [('Lancelot','the Brave'), ('Lancelot,'the Pure'), ('Galahad','the Brave'), ('Galahad','the
Pure')]
#+end_src

one can use :
#+begin_src python
776
#multiplex cross_prod where "quality=='the Brave'" 
Marc Betoule's avatar
Marc Betoule committed
777 778 779 780 781
#+end_src
to get 2 instances of the following segment (=melt=) running on: 
#+begin_src python
('Lancelot','the Brave'), ('Galahad','the Brave')
#+end_src
782

Marc Betoule's avatar
Marc Betoule committed
783
#+begin_src python
784
#multiplex cross_prod group_by "knights"
Marc Betoule's avatar
Marc Betoule committed
785 786 787 788 789
#+end_src
to get 2 instances of the =melt= segment running on:
#+begin_src python
('Lancelot'), ('Galahad')
#+end_src
790

Marc Betoule's avatar
Marc Betoule committed
791
#+begin_src python
792
#multiplex cross_prod group_by "0"
Marc Betoule's avatar
Marc Betoule committed
793 794
#+end_src
to get 1 instance of the =melt= segment running on: (0)
795

Marc Betoule's avatar
Marc Betoule committed
796
Note that to make use of =group_by=, elements of the output set have to be
797 798 799 800
hashable.

Another caution on the use of group: segment input data type is no
longer a dictionary in those cases as the original tuple is
Marc Betoule's avatar
Marc Betoule committed
801
lost and replaced by the result of the class function.
802

Marc Betoule's avatar
Marc Betoule committed
803
See section [[*The%20segment%20environment][The segment environment]] for more details.
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824

** Depend directive

As explained in the introduction section, Pipelet offers the
possibility to spare CPU time by saving intermediate products on disk.
We call intermediate products the input/output data files of the
different segments.  

Each segment repository is identified by a unique key which depends
on: 
- the segment processing code and parameters (segment and hook
  scripts)
- the input data (identified from the key of the parent segments)

Every change made on a segment (new parameter or new parent) will then
give a different key, and tell the Pipelet engine to compute a new
segment instance.

It is possible to add some external dependencies to the key
computation using the depend directive: 

Marc Betoule's avatar
Marc Betoule committed
825
#+begin_src python
826
#depend file1 file2
Marc Betoule's avatar
Marc Betoule committed
827
#+end_src
828 829 830 831 832 833 834 835 836

At the very beginning of the pipeline execution, all dependencies will
be stored, to prevent any change (code edition) between the key
computation and actual processing.

Note that this mechanism works only for segment and hook
scripts. External dependencies are also read as the beginning of the
pipeline execution, but only used for the key computation.

Marc Betoule's avatar
Marc Betoule committed
837 838
** Database reconstruction

839 840 841
In case of unfortunate lost of the pipeline sql data base, it is
possible to reconstruct it from the disk : 

Marc Betoule's avatar
Marc Betoule committed
842
#+begin_src python
843 844
import pipelet
pipelet.utils.rebuild_db_from_disk (prefix, sqlfile)
Marc Betoule's avatar
Marc Betoule committed
845
#+end_src
Marc Betoule's avatar
Marc Betoule committed
846

847 848 849
All information will be retrieve, but with new identifiers. 

** The hooking system
850

851
As described in the 'segment environment' section, Pipelet supports
852 853 854 855 856 857
an hooking system which allows the use of generic processing code, and
code sectioning.

Let's consider a set of instructions that have to be systematically
applied at the end of a segment (post processing), one can put those
instruction in the separate script file named for example
Marc Betoule's avatar
Marc Betoule committed
858
=segname_postproc.py= and calls the hook function: 
859

Marc Betoule's avatar
Marc Betoule committed
860
#+begin_src python
861
hook('postproc', globals()) 
Marc Betoule's avatar
Marc Betoule committed
862
#+end_src
863

864
A specific dictionary can be passed to the hook script to avoid
865 866
confusion. 

Marc Betoule's avatar
Marc Betoule committed
867
The hook scripts are included into the hash key computation.
868

Marc Betoule's avatar
Marc Betoule committed
869 870
** Writing custom environments

871
The Pipelet software provides a set of default utilities available
Maude Le Jeune's avatar
Maude Le Jeune committed
872 873 874 875 876 877
from the segment environment. It is possible to extend this default
environment or even re-write a completely new one.

*** Extending the default environment

The different environment utilities are actually methods of the class
878
Environment. It is possible to add new functionalities by using the
Maude Le Jeune's avatar
Maude Le Jeune committed
879 880
python heritage mechanism: 

Marc Betoule's avatar
Marc Betoule committed
881
File : =myenvironment.py=
Maude Le Jeune's avatar
Maude Le Jeune committed
882

Marc Betoule's avatar
Marc Betoule committed
883 884 885 886 887 888 889 890 891
#+begin_src python
  from pipelet.environment import *
  
  class MyEnvironment(Environment):
        def my_function (self):
           """ My function do nothing
           """
           return 
#+end_src
Maude Le Jeune's avatar
Maude Le Jeune committed
892

893
The Pipelet engine objects (segments, tasks, pipeline) are available
Marc Betoule's avatar
Marc Betoule committed
894
from the worker attribut =self._worker=. See section [[*The%20Pipelet%20actors][The Pipelet actors]]
Marc Betoule's avatar
Marc Betoule committed
895
for more details about the Pipelet machinery.
Maude Le Jeune's avatar
Maude Le Jeune committed
896 897 898 899 900 901 902


*** Writing new environment

In order to start with a completely new environment, extend the base
environment: 

Marc Betoule's avatar
Marc Betoule committed
903 904
File : =myenvironment.py=
#+begin_src python
Maude Le Jeune's avatar
Maude Le Jeune committed
905 906 907 908 909 910 911 912 913 914 915 916
   from pipelet.environment import *

   class MyEnvironment(EnvironmentBase):
         def my_get_data_fn (self, x):
            """ New name for get_data_fn
	    """
	    return self._get_data_fn(x)

         def _close(self, glo):
            """ Post processing code
            """	 
	    return glo['seg_output']
Marc Betoule's avatar
Marc Betoule committed
917
#+end_src
Maude Le Jeune's avatar
Maude Le Jeune committed
918

919
From the base environment, the basic functionalities for getting file
Maude Le Jeune's avatar
Maude Le Jeune committed
920
names and executing hook scripts are still available through: 
Marc Betoule's avatar
Marc Betoule committed
921 922
- =self._get_data_fn=
- =self._hook=
Maude Le Jeune's avatar
Maude Le Jeune committed
923

Marc Betoule's avatar
Marc Betoule committed
924 925
The segment input argument is also stored in =self._seg_input=
The segment output argument has to be returned by the =_close(self, glo)=
Maude Le Jeune's avatar
Maude Le Jeune committed
926 927 928
method. 

The pipelet engine objects (segments, tasks, pipeline) are available
Marc Betoule's avatar
Marc Betoule committed
929
from the worker attribut =self._worker=. See section [[*The%20Pipelet%20actors][The Pipelet
Marc Betoule's avatar
Marc Betoule committed
930
actors]] for more details about the Pipelet machinery.
Maude Le Jeune's avatar
Maude Le Jeune committed
931 932


Marc Betoule's avatar
Marc Betoule committed
933

Maude Le Jeune's avatar
Maude Le Jeune committed
934 935
*** Loading another environment

936
To load another environment, set the pipeline environment attribute
Maude Le Jeune's avatar
Maude Le Jeune committed
937 938
accordingly. 

Marc Betoule's avatar
Marc Betoule committed
939
#+begin_src python
Maude Le Jeune's avatar
Maude Le Jeune committed
940
Pipeline(pipedot, codedir=, prefix=, env=MyEnvironment)
Marc Betoule's avatar
Marc Betoule committed
941
#+end_src