-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathREADME.html
More file actions
executable file
·610 lines (531 loc) · 23 KB
/
Copy pathREADME.html
File metadata and controls
executable file
·610 lines (531 loc) · 23 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" />
<title>IDL Job Parallel Framework</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="idl-job-parallel-framework">
<h1 class="title">IDL Job Parallel Framework</h1>
<table class="docinfo" frame="void" rules="none">
<col class="docinfo-name" />
<col class="docinfo-content" />
<tbody valign="top">
<tr class="field"><th class="docinfo-name" colspan="2">Document Author:</th></tr>
<tr class="field"><td> </td><td class="field-body">Luke Domanski, CSIRO, IM&T, Scientific Computing</td>
</tr>
<tr class="field"><th class="docinfo-name" colspan="2">Document Format:</th></tr>
<tr class="field"><td> </td><td class="field-body">This document was written in <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>. There a
numerous converters and generators for <a class="reference external" href="http://docutils.sourceforge.net/docs/user/links.html#export">exporting from
reStructuredText</a> to pretty document formats.</td>
</tr>
</tbody>
</table>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#introduction" id="id3">Introduction</a></li>
<li><a class="reference internal" href="#software-requirements-and-files" id="id4">Software requirements and files</a><ul>
<li><a class="reference internal" href="#environment-and-licensing-requirements" id="id5">Environment and licensing requirements</a></li>
<li><a class="reference internal" href="#collecting-required-packages" id="id6">Collecting required packages</a></li>
</ul>
</li>
<li><a class="reference internal" href="#compilation-and-setup" id="id7">Compilation and Setup</a><ul>
<li><a class="reference internal" href="#compiling-the-code-and-documentation" id="id8">Compiling the code and documentation</a><ul>
<li><a class="reference internal" href="#compiling-the-job-parallel-framework" id="id9">Compiling the Job Parallel Framework</a></li>
<li><a class="reference internal" href="#setting-idl-path" id="id10">Setting IDL_PATH</a><ul>
<li><a class="reference internal" href="#on-linux-derivative-systems" id="id11">On Linux derivative systems</a></li>
<li><a class="reference internal" href="#on-modern-windows-systems" id="id12">On modern Windows systems</a></li>
</ul>
</li>
<li><a class="reference internal" href="#setting-gdl-path" id="id13">Setting GDL_PATH</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#documentation" id="id14">Documentation</a><ul>
<li><a class="reference internal" href="#user-manual-tutorial" id="id15">User Manual & Tutorial</a></li>
<li><a class="reference internal" href="#extending-the-idl-job-parallel-framework" id="id16">Extending the IDL Job Parallel Framework</a></li>
<li><a class="reference internal" href="#reference-manual" id="id17">Reference Manual</a></li>
</ul>
</li>
</ul>
</div>
<hr class="docutils" />
<div class="section" id="introduction">
<h1><a class="toc-backref" href="#id3">Introduction</a></h1>
<p id="start-short-overview">A generic framework developed for generating job parallel <tt class="docutils literal">jobs</tt> <a class="footnote-reference" href="#id2" id="id1">[1]</a> for
parallel platforms based on a user defined (calling application) set of
preprocessing, work, and postprocessing IDL executables or routines, as well as
a list of application tasks to perform with parallel workers.</p>
<p>Different target parallel platforms are supported via job generator plugins.</p>
<p>The parallel job can be configured and generated on <em>any</em> machine running IDL
or GDL, for execution on a <em>remote</em> parallel machine supported by the chosen
plugin. The generated job directory can then be copied to the remote parallel
machine, and the job executed in a standalone fashion.</p>
<div class="note">
<p class="first admonition-title">Note</p>
<p class="last">The machines used for generation and execution could potentially be the same
machine.</p>
</div>
<table class="docutils footnote" frame="void" id="id2" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>i.e. the method of parallism utilised in the generated job is "job
level parallelism" as opposed to a finer grained parallelism</td></tr>
</tbody>
</table>
</div>
<div class="section" id="software-requirements-and-files">
<span id="end-short-overview"></span><h1><a class="toc-backref" href="#id4">Software requirements and files</a></h1>
<div class="section" id="environment-and-licensing-requirements">
<h2><a class="toc-backref" href="#id5">Environment and licensing requirements</a></h2>
<dl class="docutils">
<dt>Compilation</dt>
<dd><ul class="first last simple">
<li>IDL + IDL Development Licence</li>
</ul>
</dd>
<dt>Job Generation (Client) and Execution (Remote)</dt>
<dd><ul class="first last simple">
<li>IDL + IDL Runtime Licence</li>
<li>GDL (optional alternative, see below)</li>
</ul>
</dd>
</dl>
<p>Some job generator plugins support launching of worker processes using the open
source GDL implementation of the IDL language and environment. The <strong>REMOTE</strong>
user application to be run on the parallel machine must support IDL versions
<7.1 (at time of writing) to utilise GDL.</p>
</div>
<div class="section" id="collecting-required-packages">
<h2><a class="toc-backref" href="#id6">Collecting required packages</a></h2>
<p>You will required the source packages to compile this software. Which can be
downloaded from the GitHub source code repository via:</p>
<pre class="literal-block">
git clone https://github.com/csiro-scientific-computing/parallel_framework.git
</pre>
</div>
</div>
<div class="section" id="compilation-and-setup">
<h1><a class="toc-backref" href="#id7">Compilation and Setup</a></h1>
<div class="section" id="compiling-the-code-and-documentation">
<h2><a class="toc-backref" href="#id8">Compiling the code and documentation</a></h2>
<p>The compilation is a two part process carried out on <strong>both</strong> the <em>client</em> and
<em>remote</em> machines:</p>
<ol class="arabic">
<li><p class="first">Compile The IDL Job Parallel Framework and Documentation</p>
<p>See <a class="reference internal" href="#compiling-the-job-parallel-framework">Compiling the Job Parallel Framework</a></p>
</li>
<li><p class="first">Add the IDL Job Parallel Framework installation directory to your <tt class="docutils literal">IDL_PATH</tt>
and <tt class="docutils literal">GDL_PATH</tt></p>
<p>See <a class="reference internal" href="#setting-idl-path">Setting IDL_PATH</a> and <a class="reference internal" href="#setting-gdl-path">Setting GDL_PATH</a></p>
</li>
</ol>
<p>The package can be installed as a source-binary combination, or as a binary
only installation.</p>
<div class="section" id="compiling-the-job-parallel-framework">
<h3><a class="toc-backref" href="#id9">Compiling the Job Parallel Framework</a></h3>
<p>The compilation processes has been automated in the
<tt class="docutils literal">build/build_parframewrk.pro</tt> and <tt class="docutils literal">build/build_docs.pro</tt> scripts.</p>
<p>To compile:</p>
<ol class="arabic">
<li><p class="first">Start an IDL Development Environment</p>
</li>
<li><p class="first">Change to the Parallel_Framework base directory</p>
</li>
<li><p class="first">Run the build scripts:</p>
<pre class="literal-block">
> @build/build_parframewrk
> @build/build_docs
</pre>
</li>
</ol>
<p><tt class="docutils literal">build_parframewrk</tt> creates two types of binaries in the Parallel_Framework's
<tt class="docutils literal">bin</tt> directory:</p>
<dl class="docutils">
<dt>The IDL Job Parallel Framework Library & API(<tt class="docutils literal">bin/par_framework.sav</tt>)</dt>
<dd>whose functions/procedures you can call from other IDL programs to discover
information about available job generators and generate parallel jobs</dd>
<dt>Job generator plugins (<tt class="docutils literal"><span class="pre">bin/plugins/*.sav</span></tt>)</dt>
<dd>which contain compiled versions of the job generator plugins present in
the Parallel_Framwork's <tt class="docutils literal">src/plugins/</tt> directory. The plugins are loaded
on demanded by <tt class="docutils literal">par_framework.sav</tt> to generate different type of job
output. They should not be called directly by user applications.</dd>
</dl>
<p><tt class="docutils literal">build_docs</tt> generates IDL html help files from the header comment blocks
of functions and procedures in the IDL Job Parallel Framework source code, and
places them in the <tt class="docutils literal">doc/reference</tt> directory.</p>
<p>You can then view the output html files individually in a web browser. See
the <a class="reference internal" href="#reference-manual">Reference Manual</a> section of this document for table of contents.</p>
</div>
<div class="section" id="setting-idl-path">
<h3><a class="toc-backref" href="#id10">Setting IDL_PATH</a></h3>
<p>For other applications to use the framework, you must make the Parallel
Framework Library visible on the IDL <tt class="docutils literal">!PATH</tt>.</p>
<p>To do this, append <tt class="docutils literal"><span class="pre">+<path_to_Parallel_Framework>/bin</span></tt> and
<tt class="docutils literal"><span class="pre">+<path_to_Parallel_Framework>/src</span></tt> to the <tt class="docutils literal">IDL_PATH</tt> system or user
environment variable, where "<path_to_Parallel_Framework>" is a place holder
for the real directory path.</p>
<div class="important">
<p class="first admonition-title">Important</p>
<p class="last">The resulting <tt class="docutils literal">IDL_PATH</tt> must contain the special token <tt class="docutils literal"><IDL_DEFAULT></tt>
for IDL internal use. It is recommend you include this token when appending
to <tt class="docutils literal">IDL_PATH</tt>.</p>
</div>
<div class="section" id="on-linux-derivative-systems">
<h4><a class="toc-backref" href="#id11">On Linux derivative systems</a></h4>
<p>Use your shell's provided mechanism for setting environment variables.</p>
<p>e.g. For bash:</p>
<pre class="literal-block">
> export IDL_PATH=${IDL_PATH}:<IDL_DEFAULT>:+<path_to_Parallel_Framework>/bin:+<path_to_Parallel_Framework>/src
</pre>
<p>e.g. For tcsh:</p>
<pre class="literal-block">
> setenv IDL_PATH ${IDL_PATH}:<IDL_DEFAULT>:+<path_to_Parallel_Framework>/bin:+<path_to_Parallel_Framework>/src
</pre>
<p>Place this command in your user shell start-up script to ensure it is set on
every login. e.g. <tt class="docutils literal">.bashrc</tt> (bash), <tt class="docutils literal">.cshrc</tt> (tcsh), <tt class="docutils literal">.profile</tt>, etc.
This file will be system and shell dependant, please check your system
administrator's policy/recommendation.</p>
</div>
<div class="section" id="on-modern-windows-systems">
<h4><a class="toc-backref" href="#id12">On modern Windows systems</a></h4>
<p>In the <tt class="docutils literal">Systems Properties</tt> menu, accessible via
"Control Panel>System and Security>System>Change Settings" or similar:</p>
<ol class="arabic simple">
<li>click "Advanced Tab>Environment Variables..."</li>
<li>to append an existing <tt class="docutils literal">IDL_PATH</tt><ol class="loweralpha">
<li>Select the <tt class="docutils literal">IDL_PATH</tt> variable in either the "User variables" or
"System variables" section</li>
<li>click "Edit.."</li>
<li>enter <tt class="docutils literal"><span class="pre">;+<path_to_Parallel_Framework>/bin:+<path_to_Parallel_Framework>/src;<IDL_DEFAULT></span></tt>
after the existing text in the "Variable value" text box (<strong>note the leading semi-colon!</strong>)</li>
</ol>
</li>
<li><strong>OR</strong> to specify a new <tt class="docutils literal">IDL_PATH</tt> variable if necessary<ol class="loweralpha">
<li>click "New.." in either the "User variables" or "System variables" section</li>
<li>enter <tt class="docutils literal">IDL_PATH</tt> into the "Variable name" text box</li>
<li>enter <tt class="docutils literal"><span class="pre">+<path_to_Parallel_Framework>/bin:+<path_to_Parallel_Framework>/src;<IDL_DEFAULT></span></tt>
in the "Variable value" text box (<strong>note absence of leading semi-colon!</strong>).</li>
</ol>
</li>
</ol>
<div class="warning">
<p class="first admonition-title">Warning</p>
<p class="last">"System variables" will apply to all users of the system.</p>
</div>
<div class="note">
<p class="first admonition-title">Note</p>
<p class="last">Depending on your system privileges, you might only be able to add or edit the "User variables".</p>
</div>
</div>
</div>
<div class="section" id="setting-gdl-path">
<h3><a class="toc-backref" href="#id13">Setting GDL_PATH</a></h3>
<p>Append <tt class="docutils literal"><span class="pre">+<path_to_Parallel_Framework>/src</span></tt> to the <tt class="docutils literal">GDL_PATH</tt> environment
variable following similar steps to those outlined in <a class="reference internal" href="#setting-idl-path">Setting IDL_PATH</a>, e.g.
for Linux bash:</p>
<pre class="literal-block">
> export GDL_PATH=${GDL_PATH}:+<path_to_Parallel_Framework>/src
</pre>
<div class="note">
<p class="first admonition-title">Note</p>
<p class="last">For GDL you do not need to add the <tt class="docutils literal"><IDL_DEAFAULT></tt> token.</p>
</div>
</div>
</div>
</div>
<div class="section" id="documentation">
<h1><a class="toc-backref" href="#id14">Documentation</a></h1>
<p>If you have not yet followed the instructions in the <a class="reference internal" href="#compiling-the-code-and-documentation">Compiling the
code and documentation</a> section, please do so.</p>
<div class="section" id="user-manual-tutorial">
<h2><a class="toc-backref" href="#id15">User Manual & Tutorial</a></h2>
<p>The Job Parallel Framework can be used in two modes:</p>
<dl class="docutils">
<dt>By the <strong>generator application</strong></dt>
<dd>To generate parallel jobs using the <tt class="docutils literal">generate_parallel_job</tt> procedure</dd>
<dt>By the <strong>remote</strong> worker(s)</dt>
<dd>To take advantage of Job Parallel Framework helper functions which simplify
worker application development</dd>
</dl>
<p>For details on usage please see the <a class="reference external" href="doc/user_guide/user_guide.html">User Guide</a> and <a class="reference external" href="doc/user_guide/user_guide.html#tutorial">Tutorial</a>.</p>
</div>
<div class="section" id="extending-the-idl-job-parallel-framework">
<h2><a class="toc-backref" href="#id16">Extending the IDL Job Parallel Framework</a></h2>
<p>The framework can be extended through user defined job generator plugins which
allow for a broad range of target platforms and job management systems to be
supported through a single library API.</p>
<p>The generator plugins <strong>MUST</strong> implement the <a class="reference external" href="doc/user/developer_guide.html#plugins">plugins interface</a> described in
the <a class="reference external" href="doc/user/developer_guide.html">developer guide</a> and also the <a class="reference external" href="doc/reference/par_framework.html#par_framework_pro">par_framework.pro</a> documentation.</p>
</div>
<div class="section" id="reference-manual">
<h2><a class="toc-backref" href="#id17">Reference Manual</a></h2>
<ul class="simple">
<li>IDL Job Parallel Framework<ul>
<li><a class="reference external" href="doc/reference/par_framework.html#par_framework_pro">par_framework.pro - IDL Job Parallel Framework</a></li>
<li><a class="reference external" href="doc/reference/pbs_job_generator.html#pbs_job_generator_pro">pbs_job_generator.pro - IDL Job Parallel Framework PBS+Linux plugin for non-array job versions of PBS</a></li>
<li><a class="reference external" href="doc/reference/pbs_job_array_job_generator.html#pbs_job_array_job_generator_pro">pbs_job_array_job_generator.pro - IDL Job Parallel Framework PBS+Linux plugin</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</body>
</html>