-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathpythonAPIReference.html
619 lines (455 loc) · 29.8 KB
/
pythonAPIReference.html
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
611
612
613
614
615
616
617
618
619
<!DOCTYPE html>
<html lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-VY29EEZ393"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-VY29EEZ393');
</script>
<title>Python API Reference — 3.9.3 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=e353d410970836974a52" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" href="_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<script src="_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'pythonAPIReference';</script>
<link rel="icon" href="_static/vaporVLogo.png"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Download and Installation" href="pythonAPIReference/downloadAndInstallation.html" />
<link rel="prev" title="Class Reference" href="vaporApplicationReference/vaporClassReference.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<a class="skip-link" href="#main-content">Skip to main content</a>
<input type="checkbox"
class="sidebar-toggle"
name="__primary"
id="__primary"/>
<label class="overlay overlay-primary" for="__primary"></label>
<input type="checkbox"
class="sidebar-toggle"
name="__secondary"
id="__secondary"/>
<label class="overlay overlay-secondary" for="__secondary"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
id="search-input"
placeholder="Search..."
aria-label="Search..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>
<nav class="bd-header navbar navbar-expand-lg bd-navbar">
</nav>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<a class="navbar-brand logo" href="index.html">
<img src="_static/vaporLogoBlack.png" class="logo__image only-light" alt="Logo image"/>
<script>document.write(`<img src="_static/vaporLogoBlack.png" class="logo__image only-dark" alt="Logo image"/>`);</script>
</a></div>
<div class="sidebar-primary-item"><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<ul class="current nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="downloads.html">Downloads</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="current.html">Current Release</a></li>
<li class="toctree-l2"><a class="reference internal" href="downloads/installationInstructions.html">Installation Instructions</a></li>
<li class="toctree-l2"><a class="reference internal" href="downloads/runningVaporOnCasper.html">Running VAPOR on Casper</a></li>
<li class="toctree-l2"><a class="reference internal" href="downloads/sampleData.html">Sample Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="downloads/thirdPartyLibraries.html">Third Party Libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="downloads/buildingVaporWithSpack.html">Building VAPOR with SPACK</a></li>
<li class="toctree-l2"><a class="reference internal" href="downloads/vapor2.html">VAPOR 2 (Legacy)</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="dataFormatRequirements.html">Data Format Requirements</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="dataFormatRequirements/nativelySupportedDataFormats.html">Natively Supported Data Formats</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="dataFormatRequirements/dataFormattingInstructions.html">Data Formatting Instructions</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3 has-children"><a class="reference internal" href="dataFormatRequirements/netCDF/nonCompliantNetCDF.html">Non CF-Compliant NetCDF</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="dataFormatRequirements/netCDF/cfRequirements.html">NetCDF-CF Requirements</a></li>
<li class="toctree-l4"><a class="reference internal" href="dataFormatRequirements/netCDF/examples/index.html">Examples</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="dataFormatRequirements/rawData.html">Raw Binary Data</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="dataFormatRequirements/brickOfValues.html">Brick of Values (BOV)</a></li>
<li class="toctree-l4"><a class="reference internal" href="dataFormatRequirements/rawToVDC.html">Converting raw binary data into VDC</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="dataFormatRequirements/dataCollectionParticles.html">Data Collection Particles (DCP)</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="dataFormatRequirements/vdc.html">Big Data with VDC</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-6"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="dataFormatRequirements/vdcConversionCommands.html">VDC Conversion Commands</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="dataFormatRequirements/notesOnDifferentFormats.html">Notes on Different Formats</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="vaporApplicationReference.html">VAPOR Application Reference</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-7"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="vaporApplicationReference/quickStartGuide.html">Quick Start Guide</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="vaporApplicationReference/renderers.html">The Renderers</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-8"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="vaporApplicationReference/basicRendererControls.html">Basic Renderer Controls</a></li>
<li class="toctree-l3"><a class="reference internal" href="vaporApplicationReference/contourRenderer.html">Contours</a></li>
<li class="toctree-l3"><a class="reference internal" href="vaporApplicationReference/twoDData.html">2D Data</a></li>
<li class="toctree-l3 has-children"><a class="reference internal" href="vaporApplicationReference/imageRenderer/index.html">Image Renderer</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-9"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="vaporApplicationReference/imageRenderer/makeGeotiff.html">makeGeotiff.py</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="vaporApplicationReference/volumeRenderer.html">Volume Renderer</a></li>
<li class="toctree-l3"><a class="reference internal" href="vaporApplicationReference/isosurfaceRenderer.html">Isosurfaces</a></li>
<li class="toctree-l3"><a class="reference internal" href="vaporApplicationReference/flowRenderer.html">Flow</a></li>
<li class="toctree-l3"><a class="reference internal" href="vaporApplicationReference/sliceRenderer.html">Slices</a></li>
<li class="toctree-l3"><a class="reference internal" href="vaporApplicationReference/barbRenderer.html">Barbs</a></li>
<li class="toctree-l3"><a class="reference internal" href="vaporApplicationReference/wireFrameRenderer.html">Wire Frames</a></li>
<li class="toctree-l3"><a class="reference internal" href="vaporApplicationReference/modelRenderer.html">3D Models</a></li>
<li class="toctree-l3"><a class="reference internal" href="vaporApplicationReference/particleRenderer.html">Particle Renderer</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="vaporApplicationReference/navigationSettings.html">Navigation Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="vaporApplicationReference/globalSettings.html">Global Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="vaporApplicationReference/export.html">Exporting Visualizations</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="vaporApplicationReference/otherTools.html">Other Tools</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-10"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="vaporApplicationReference/otherTools/pythonEngine.html">Python Engine</a></li>
<li class="toctree-l3"><a class="reference internal" href="vaporApplicationReference/otherTools/2dPlots.html">2D Plots</a></li>
<li class="toctree-l3"><a class="reference internal" href="vaporApplicationReference/otherTools/statistics.html">Statistics</a></li>
<li class="toctree-l3"><a class="reference internal" href="vaporApplicationReference/otherTools/vaporWrfModule.html">The vapor_wrf module</a></li>
<li class="toctree-l3"><a class="reference internal" href="vaporApplicationReference/otherTools/vaporUtilsModule.html">The vapor_utils module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="vaporApplicationReference/vaporClassReference.html">Class Reference</a></li>
</ul>
</li>
<li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">Python API Reference</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-11"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="pythonAPIReference/downloadAndInstallation.html">Download and Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="pythonAPIReference/wslInstructions.html">Windows Instructions</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="pythonAPIReference/classReference.html">Class Reference</a><input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-12"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3 has-children"><a class="reference internal" href="pythonAPIReference/userModules/vapor.html">User Modules</a><input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-13"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="pythonAPIReference/userModules/vapor.utils.html">vapor.utils package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythonAPIReference/userModules/vapor.animation.html">vapor.animation module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythonAPIReference/userModules/vapor.annotations.html">vapor.annotations module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythonAPIReference/userModules/vapor.camera.html">vapor.camera module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythonAPIReference/userModules/vapor.dataset.html">vapor.dataset module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythonAPIReference/userModules/vapor.renderer.html">vapor.renderer module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythonAPIReference/userModules/vapor.session.html">vapor.session module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythonAPIReference/userModules/vapor.transferfunction.html">vapor.transferfunction module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythonAPIReference/userModules/vapor.transform.html">vapor.transform module</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="pythonAPIReference/devModules/vapor.html">Developer Modules</a><input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-14"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="pythonAPIReference/devModules/vapor.utils.html">vapor.utils package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythonAPIReference/devModules/vapor.cmake.html">vapor.cmake module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythonAPIReference/devModules/vapor.common.html">vapor.common module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythonAPIReference/devModules/vapor.config.html">vapor.config module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythonAPIReference/devModules/vapor.cppyyDoxygenWrapper.html">vapor.cppyyDoxygenWrapper module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythonAPIReference/devModules/vapor.link.html">vapor.link module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythonAPIReference/devModules/vapor.params.html">vapor.params module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythonAPIReference/devModules/vapor.smartwrapper.html">vapor.smartwrapper module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference external" href="https://projectpythia.org/vapor-python-cookbook/notebooks/quickstart.html">Quickstart</a></li>
<li class="toctree-l2"><a class="reference external" href="https://projectpythia.org/vapor-python-cookbook/README.html">Examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference external" href="https://www.youtube.com/channel/UCpf-d1GDO1sotzjJ2t_QkDw">YouTube Channel</a></li>
<li class="toctree-l1"><a class="reference external" href="https://vapor.discourse.group">Get Help on Our Forum</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="contributingToVapor.html">Contributing to Vapor</a><input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-15"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="contributingToVapor/bugReports.html">Bug Reports</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributingToVapor/docsContributions.html">Docs Contributions</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributingToVapor/codeContributions.html">Code Contributions</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributingToVapor/galleryContributions.html">Gallery Contributions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="citationAndLicense.html">Citation and License</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main">
<div class="sbt-scroll-pixel-helper"></div>
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item"><label class="sidebar-toggle primary-toggle btn btn-sm" for="__primary" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-bars"></span>
</label></div>
</div>
<div class="header-article-items__end">
<div class="header-article-item">
<div class="article-header-buttons">
<div class="dropdown dropdown-source-buttons">
<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Source repositories">
<i class="fab fa-github"></i>
</button>
<ul class="dropdown-menu">
<li><a href="https://github.com/NCAR/VAPOR" target="_blank"
class="btn btn-sm btn-source-repository-button dropdown-item"
title="Source repository"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fab fa-github"></i>
</span>
<span class="btn__text-container">Repository</span>
</a>
</li>
<li><a href="https://github.com/NCAR/VAPOR/edit/main/doc/pythonAPIReference.rst" target="_blank"
class="btn btn-sm btn-source-edit-button dropdown-item"
title="Suggest edit"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-pencil-alt"></i>
</span>
<span class="btn__text-container">Suggest edit</span>
</a>
</li>
<li><a href="https://github.com/NCAR/VAPOR/issues/new?title=Issue%20on%20page%20%2FpythonAPIReference.html&body=Your%20issue%20content%20here." target="_blank"
class="btn btn-sm btn-source-issues-button dropdown-item"
title="Open an issue"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-lightbulb"></i>
</span>
<span class="btn__text-container">Open issue</span>
</a>
</li>
</ul>
</div>
<div class="dropdown dropdown-download-buttons">
<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Download this page">
<i class="fas fa-download"></i>
</button>
<ul class="dropdown-menu">
<li><a href="_sources/pythonAPIReference.rst" target="_blank"
class="btn btn-sm btn-download-source-button dropdown-item"
title="Download source file"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file"></i>
</span>
<span class="btn__text-container">.rst</span>
</a>
</li>
<li>
<button onclick="window.print()"
class="btn btn-sm btn-download-pdf-button dropdown-item"
title="Print to PDF"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file-pdf"></i>
</span>
<span class="btn__text-container">.pdf</span>
</button>
</li>
</ul>
</div>
<button onclick="toggleFullScreen()"
class="btn btn-sm btn-fullscreen-button"
title="Fullscreen mode"
data-bs-placement="bottom" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-expand"></i>
</span>
</button>
<script>
document.write(`
<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
</button>
`);
</script>
<script>
document.write(`
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
</button>
`);
</script>
<label class="sidebar-toggle secondary-toggle btn btn-sm" for="__secondary"title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-list"></span>
</label>
</div></div>
</div>
</div>
</div>
<div id="jb-print-docs-body" class="onlyprint">
<h1>Python API Reference</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
<div>
<h2> Contents </h2>
</div>
<nav aria-label="Page">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#download-and-installation">Download and Installation</a></li>
</ul>
</nav>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article" role="main">
<section id="python-api-reference">
<span id="pythonapireference"></span><h1>Python API Reference<a class="headerlink" href="#python-api-reference" title="Permalink to this heading">#</a></h1>
<section id="download-and-installation">
<h2>Download and Installation<a class="headerlink" href="#download-and-installation" title="Permalink to this heading">#</a></h2>
<p>The easiest way to download and install VAPOR Python is using conda, which can be downloaded at <a class="reference external" href="https://anaconda.org/">Anaconda.org</a>.</p>
<p>It is recommended to start with a new conda environment. In the example below we create a new environment named vapor_python.</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">conda create -n vapor_python</span>
</pre></div>
</div>
<p>Activate the environment</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">conda activate vapor_python</span>
</pre></div>
</div>
<p>Install the package</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">conda install -c conda-forge -c ncar-vapor vapor</span>
</pre></div>
</div>
<p>Now run examples in the following directories like so:</p>
<p>Jupyter Notebooks:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">cd $CONDA_PREFIX/lib/python3.9/site-packages/vapor/example_notebooks/</span>
<span class="go">jupyter notebook</span>
</pre></div>
</div>
<p>Python Scripts:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span>CONDA_PREFIX/lib/python3.9/site-packages/vapor/examples/
<span class="go">./workflow_example.py</span>
</pre></div>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="pythonAPIReference/downloadAndInstallation.html">Download and Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="pythonAPIReference/wslInstructions.html">Windows Instructions</a></li>
<li class="toctree-l1"><a class="reference internal" href="pythonAPIReference/classReference.html">Class Reference</a></li>
<li class="toctree-l1"><a class="reference external" href="https://projectpythia.org/vapor-python-cookbook/notebooks/quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference external" href="https://projectpythia.org/vapor-python-cookbook/README.html">Examples</a></li>
</ul>
</div>
</section>
</section>
</article>
<footer class="bd-footer-article">
<div class="footer-article-items footer-article__inner">
<div class="footer-article-item"><!-- Previous / next buttons -->
<div class="prev-next-area">
<a class="left-prev"
href="vaporApplicationReference/vaporClassReference.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Class Reference</p>
</div>
</a>
<a class="right-next"
href="pythonAPIReference/downloadAndInstallation.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Download and Installation</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div></div>
</div>
</footer>
</div>
<div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> Contents
</div>
<nav class="bd-toc-nav page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#download-and-installation">Download and Installation</a></li>
</ul>
</nav></div>
</div></div>
</div>
<footer class="bd-footer-content">
<div class="bd-footer-content__inner container">
<div class="footer-item">
</div>
<div class="footer-item">
<p class="copyright">
© Copyright 2023 University Corporation for Atmospheric Research.
<br/>
</p>
</div>
<div class="footer-item">
</div>
<div class="footer-item">
</div>
</div>
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="_static/scripts/bootstrap.js?digest=e353d410970836974a52"></script>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52"></script>
<footer class="bd-footer">
</footer>
</body>
</html>