-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpipelines.html
More file actions
534 lines (414 loc) · 31.2 KB
/
pipelines.html
File metadata and controls
534 lines (414 loc) · 31.2 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
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Pipelines — 1.3.1</title>
<link rel="shortcut icon" href="_static/favicon.png"/>
<link rel="canonical" href="https://podpac.orgpipelines.html"/>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/style.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html">
<img src="_static/icon.svg" class="logo" alt="Logo"/>
</a>
<div class="version">
1.3.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="aws.html">AWS Integration</a></li>
</ul>
<p class="caption"><span class="caption-text">Topics</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="why-podpac.html">Why PODPAC?</a></li>
<li class="toctree-l1"><a class="reference internal" href="design.html">Design</a></li>
<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="nodes.html">Nodes</a></li>
<li class="toctree-l1"><a class="reference internal" href="coordinates.html">Coordinates</a></li>
<li class="toctree-l1"><a class="reference internal" href="cache.html">Cache</a></li>
<li class="toctree-l1"><a class="reference internal" href="datasets.html">Supported Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="earthdata.html">NASA Earth Data Login</a></li>
<li class="toctree-l1"><a class="reference internal" href="aws-development.html">AWS Development</a></li>
</ul>
<p class="caption"><span class="caption-text">References</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
</ul>
<p class="caption"><span class="caption-text">Support</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs.html">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="roadmap.html">Development Roadmap</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">PODPAC</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Pipelines</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/pipelines.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="pipelines">
<h1>Pipelines<a class="headerlink" href="#pipelines" title="Permalink to this headline">¶</a></h1>
<p><em>DEPRECATED: This functionality has been integrated into the Node class. Pipelines will be removed in popdac 2</em></p>
<div class="section" id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p>A podpac pipeline can be defined using JSON. The pipeline definition describes the <em>nodes</em> used in the pipeline and the <em>output</em> for the pipeline.</p>
<div class="section" id="attributes">
<h3>Attributes<a class="headerlink" href="#attributes" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">nodes</span></code>: node definitions <em>(object, required)</em></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">output</span></code>: output definition <em>(object, optional)</em></p></li>
</ul>
</div>
<div class="section" id="sample">
<h3>Sample<a class="headerlink" href="#sample" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"nodes"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"myNode"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
<span class="s2">"myOtherNode"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">}</span>
<span class="o">...</span>
<span class="s2">"myResult"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">}</span>
<span class="p">},</span>
<span class="s2">"output"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"node"</span><span class="p">:</span> <span class="s2">"myResult"</span><span class="p">,</span>
<span class="s2">"mode"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span>
<span class="o">...</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="node-definitions">
<h2>Node definitions<a class="headerlink" href="#node-definitions" title="Permalink to this headline">¶</a></h2>
<p>A node definition defines the node and its inputs, attributes, and default execution parameters. It also names the node so that it can be used as an input to other nodes in the pipeline. Nodes must be defined before they are referenced in a later node.</p>
<p>The podpac core library includes three basic types of nodes: <em>DataSource</em>, <em>Compositor</em>, and <em>Algorithm</em>. A <em>Pipeline</em> node can also be used an an input to a pipeline. These nodes and their additional attributes are described below.</p>
<div class="section" id="common-attributes">
<h3>Common Attributes<a class="headerlink" href="#common-attributes" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">node</span></code>: a path to the node class. The path is relative to the podpac module, unless <code class="docutils literal notranslate"><span class="pre">plugin</span></code> is defined. See Notes. <em>(string, required)</em></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">plugin</span></code>: a path to a plugin module to use (prepended node path). See Notes. <em>(string, optional)</em></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">attrs</span></code>: set attributes in the node for custom behavior. Each value can be a number, string, boolean, dictionary, or list. <em>(object, optional)</em></p></li>
</ul>
</div>
</div>
<div class="section" id="datasource">
<h2>DataSource<a class="headerlink" href="#datasource" title="Permalink to this headline">¶</a></h2>
<div class="section" id="id1">
<h3>Sample<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"nodes"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"sm"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"node"</span><span class="p">:</span> <span class="s2">"algorithm.CoordData"</span><span class="p">,</span>
<span class="s2">"attrs"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"coord_name"</span><span class="p">:</span> <span class="s2">"time"</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="compositor">
<h2>Compositor<a class="headerlink" href="#compositor" title="Permalink to this headline">¶</a></h2>
<div class="section" id="additional-attributes">
<h3>Additional Attributes<a class="headerlink" href="#additional-attributes" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sources</span></code>: nodes to composite <em>(list, required)</em></p></li>
</ul>
</div>
<div class="section" id="id2">
<h3>Sample<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"nodes"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"SourceA"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
<span class="s2">"SourceB"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
<span class="s2">"SourceC"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
<span class="n">MyCompositor</span><span class="s2">": {</span>
<span class="s2">"node"</span><span class="p">:</span> <span class="s2">"OrderedCompositor"</span><span class="p">,</span>
<span class="s2">"sources"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"SourceA"</span><span class="p">,</span> <span class="s2">"SourceB"</span><span class="p">,</span> <span class="s2">"SourceC"</span><span class="p">]</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="algorithm">
<h2>Algorithm<a class="headerlink" href="#algorithm" title="Permalink to this headline">¶</a></h2>
<div class="section" id="id3">
<h3>Additional Attributes<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">inputs</span></code>: node inputs to the algorithm. <em>(object, required)</em></p></li>
</ul>
</div>
<div class="section" id="id4">
<h3>Sample<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"nodes"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"MyNode"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
<span class="s2">"MyOtherNode"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
<span class="s2">"MyThirdNode"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
<span class="s2">"downscaled_sm"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"node"</span><span class="p">:</span> <span class="s2">"Arithmetic"</span><span class="p">,</span>
<span class="s2">"inputs"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"A"</span><span class="p">:</span> <span class="s2">"MyNode"</span><span class="p">,</span>
<span class="s2">"B"</span><span class="p">:</span> <span class="s2">"MyOtherNode"</span><span class="p">,</span>
<span class="s2">"C"</span><span class="p">:</span> <span class="s2">"MyThirdNode"</span>
<span class="p">},</span>
<span class="s2">"attrs"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"eqn"</span><span class="p">:</span> <span class="s2">"A + </span><span class="si">{tsmtr}</span><span class="s2"> / </span><span class="si">{kappa}</span><span class="s2"> * (B - C)"</span><span class="p">,</span>
<span class="s2">"params"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"kappa"</span><span class="p">:</span> <span class="s2">"13"</span><span class="p">,</span>
<span class="s2">"tsmtr"</span><span class="p">:</span> <span class="s2">"0.3"</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="pipeline">
<h2>Pipeline<a class="headerlink" href="#pipeline" title="Permalink to this headline">¶</a></h2>
<div class="section" id="id5">
<h3>Additional Attributes<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">path</span></code>: path to another pipeline JSON definition. <em>(string, required)</em></p></li>
</ul>
</div>
<div class="section" id="id6">
<h3>Sample<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"nodes"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"MyDataSource"</span><span class="p">:</span> <span class="p">{</span>
<span class="o">...</span>
<span class="p">},</span>
<span class="s2">"MyOtherPipeline"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"path"</span><span class="p">:</span> <span class="s2">"path to pipeline"</span>
<span class="p">},</span>
<span class="s2">"result"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"node"</span><span class="p">:</span> <span class="s2">"Arithmetic"</span><span class="p">,</span>
<span class="s2">"inputs"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"A"</span><span class="p">:</span> <span class="s2">"MyDataSource"</span><span class="p">,</span>
<span class="s2">"B"</span><span class="p">:</span> <span class="s2">"MyOtherPipeline"</span><span class="p">,</span>
<span class="p">},</span>
<span class="s2">"attrs"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"eqn"</span><span class="p">:</span> <span class="s2">"A + B"</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="notes">
<h3>Notes<a class="headerlink" href="#notes" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p>The <code class="docutils literal notranslate"><span class="pre">node</span></code> path should include the submodule path and the node class. The submodule path is omitted for top-level classes. For example:</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">"node":</span> <span class="pre">"datalib.smap.SMAP"</span></code> is equivalent to <code class="docutils literal notranslate"><span class="pre">from</span> <span class="pre">podpac.datalib.smap</span> <span class="pre">import</span> <span class="pre">SMAP</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">"node":</span> <span class="pre">"compositor.OrderedCompositor"</span></code> is equivalent to <code class="docutils literal notranslate"><span class="pre">from</span> <span class="pre">podpac.compositor</span> <span class="pre">import</span> <span class="pre">OrderedCompositor</span></code>.</p></li>
</ul>
</li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">plugin</span></code> path replaces ‘podpac’ in the full node path. For example</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">"plugin":</span> <span class="pre">"path.to.myplugin",</span> <span class="pre">"node":</span> <span class="pre">"mymodule.MyCustomNode"</span></code> is equivalent to <code class="docutils literal notranslate"><span class="pre">from</span> <span class="pre">path.to.myplugin.mymodule</span> <span class="pre">import</span> <span class="pre">MyCustomNode</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">"plugin":</span> <span class="pre">"myplugin",</span> <span class="pre">"node":</span> <span class="pre">"MyCustomNode"</span></code> is equivalent to <code class="docutils literal notranslate"><span class="pre">from</span> <span class="pre">myplugin</span> <span class="pre">import</span> <span class="pre">MyCustomNode</span></code></p></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="output-definition">
<h2>Output Definition<a class="headerlink" href="#output-definition" title="Permalink to this headline">¶</a></h2>
<p>The output definition defines the node to output and, optionally, an additional output mode along with associated parameters. If an output definition is not supplied, the last defined node is used.</p>
<p>Podpac provides several builtin output types, <em>file</em> and <em>image</em>. You can also define custom outputs in a plugins.</p>
<div class="section" id="id7">
<h3>Common Attributes<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">node</span></code>: The nodes to output. <em>(list, required)</em></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">mode</span></code>: For builtin outputs, options are ‘none’ (default), ‘file’, ‘image’. <em>(string, optional)</em></p></li>
</ul>
</div>
</div>
<div class="section" id="none-default">
<h2>None (default)<a class="headerlink" href="#none-default" title="Permalink to this headline">¶</a></h2>
<p>No additional output. The output will be returned from the <code class="docutils literal notranslate"><span class="pre">Pipeline.execute</span></code> method.</p>
</div>
<div class="section" id="files">
<h2>Files<a class="headerlink" href="#files" title="Permalink to this headline">¶</a></h2>
<p>Nodes can be output to file in a variety of formats.</p>
<div class="section" id="id8">
<h3>Additional Attributes<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">format</span></code>: file format, options are ‘pickle’ (default), ‘geotif’, ‘png’. <em>(string, optional)</em></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">outdir</span></code>: destination path for the output file <em>(string, required)</em></p></li>
</ul>
</div>
<div class="section" id="id9">
<h3>Sample<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"nodes"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"MyNode1"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
<span class="s2">"MyNode2"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">}</span>
<span class="p">},</span>
<span class="s2">"output"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"nodes"</span><span class="p">:</span> <span class="s2">"MyNode2"</span><span class="p">,</span>
<span class="s2">"mode"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span>
<span class="s2">"format"</span><span class="p">:</span> <span class="s2">"png"</span><span class="p">,</span>
<span class="s2">"outdir"</span><span class="p">:</span> <span class="s2">"C:\Path\To\OutputData"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="images">
<h2>Images<a class="headerlink" href="#images" title="Permalink to this headline">¶</a></h2>
<p>Nodes can be output to a png image (in memory).</p>
<div class="section" id="id10">
<h3>Additional Attributes<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">format</span></code>: image format, options are ‘png’ (default). <em>(string, optional)</em></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">vmin</span></code>: min value for the colormap <em>(number, optional)</em></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">vmax</span></code>: max value for the colormap <em>(number, optional)</em></p></li>
</ul>
</div>
<div class="section" id="id11">
<h3>Sample<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"nodes"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"MyNode1"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
<span class="s2">"MyNode2"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">}</span>
<span class="p">},</span>
<span class="s2">"output"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"nodes"</span><span class="p">:</span> <span class="s2">"MyNode2"</span><span class="p">,</span>
<span class="s2">"mode"</span><span class="p">:</span> <span class="s2">"image"</span><span class="p">,</span>
<span class="s2">"format"</span><span class="p">:</span> <span class="s2">"png"</span><span class="p">,</span>
<span class="s2">"vmin"</span><span class="p">:</span> <span class="mf">0.1</span><span class="p">,</span>
<span class="s2">"vmax"</span><span class="p">:</span> <span class="mf">0.35</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="custom-outputs">
<h2>Custom Outputs<a class="headerlink" href="#custom-outputs" title="Permalink to this headline">¶</a></h2>
<p>Custom outputs can be defined in a plugin by subclassing the <code class="docutils literal notranslate"><span class="pre">Output</span></code> base class found in <code class="docutils literal notranslate"><span class="pre">core.pipeline.output</span></code>. Custom
outputs must define the <code class="docutils literal notranslate"><span class="pre">write</span></code> method with no arguments, and may define additional parameters.</p>
<div class="section" id="id12">
<h3>Attributes<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3>
<p>Replace the ‘mode’ parameter with a plugin path and output class name:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">plugin</span></code>: path to a plugin module to use <em>(string, required)</em></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">output</span></code>: output class name <em>(string, required)</em></p></li>
</ul>
</div>
<div class="section" id="sample-custom-output-class">
<h3>Sample Custom Output Class<a class="headerlink" href="#sample-custom-output-class" title="Permalink to this headline">¶</a></h3>
<p>File: <strong>my_plugin/outputs.py</strong></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">traitlets</span> <span class="k">as</span> <span class="nn">tl</span>
<span class="kn">import</span> <span class="nn">podpac</span>
<span class="k">class</span> <span class="nc">NpyOutput</span><span class="p">(</span><span class="n">podpac</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">pipeline</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">Output</span><span class="p">):</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">tl</span><span class="o">.</span><span class="n">String</span><span class="p">()</span>
<span class="n">allow_pickle</span> <span class="o">=</span> <span class="n">tl</span><span class="o">.</span><span class="n">Bool</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
<span class="n">fix_imports</span> <span class="o">=</span> <span class="n">tl</span><span class="o">.</span><span class="n">Bool</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">numpy</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">data</span><span class="p">,</span> <span class="n">allow_pickle</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">allow_pickle</span><span class="p">,</span> <span class="n">fix_imports</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">fix_imports</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="sample-pipeline">
<h3>Sample Pipeline<a class="headerlink" href="#sample-pipeline" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"nodes"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"MyNode1"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
<span class="s2">"MyNode2"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">}</span>
<span class="p">},</span>
<span class="s2">"output"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"nodes"</span><span class="p">:</span> <span class="s2">"MyNode2"</span><span class="p">,</span>
<span class="s2">"plugin"</span><span class="p">:</span> <span class="s2">"my_plugin"</span><span class="p">,</span>
<span class="s2">"output"</span><span class="p">:</span> <span class="s2">"NpyOutput"</span><span class="p">,</span>
<span class="s2">"path"</span><span class="p">:</span> <span class="s2">"my_pipeline_output.npy"</span><span class="p">,</span>
<span class="s2">"allow_pickle"</span><span class="p">:</span> <span class="n">false</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017-2020, Creare
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>