-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
333 lines (313 loc) · 20 KB
/
index.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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>The Python ARM Radar Toolkit - Py-ART — Py-ART 1.11.7.dev+c829faf documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/plot_directive.css" type="text/css" />
<link rel="stylesheet" href="_static/copybutton.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" 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/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="API Reference Manual" href="API/index.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="#" class="icon icon-home"> Py-ART
</a>
<div class="version">
1.11.7.dev+c829faf
</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="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="API/index.html">API Reference Manual</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="setting_up_an_environment.html">Setting up an Environment</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributors_guide.html">Contributor’s Guide</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Downloads</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://anaconda.org/conda-forge/arm_pyart">Anaconda Cloud</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/ARM-DOE/pyart">GitHub Repo</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/ARM-DOE/pyart/archive/master.zip">Zip File of Repository</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Notebooks</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="notebooks/basic_ingest_using_test_radar_object.html">Creating a basic ingest of a NetCDF file</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/changing_fields_and_saving.html">Field manipulation and Saving the Radar Object to a file.</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/dealiasing_velocity.html">Dealiasing Velocity</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/mapping_data_to_a_cartesian_grid.html">Mapping Data to a Cartesian Grid</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/masking_data_with_gatefilters.html">Masking Data With Py-ART Gatefilters</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/the_pyart_radar_object_and_indexing.html">The Py-ART Radar object and indexing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Getting Help</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://github.com/ARM-DOE/pyart/issues">GitHub Issue Tracker</a></li>
<li class="toctree-l1"><a class="reference external" href="https://groups.google.com/forum/#!forum/pyart-users">Mailing List</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Science Lead</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://www.anl.gov/profile/scott-m-collis">Scott Collis</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">Py-ART</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home"></a> »</li>
<li>The Python ARM Radar Toolkit - Py-ART</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.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">
<style>
/* CSS overrides for sphinx_rtd_theme */
/* 24px margin */
.nbinput.nblast.container,
.nboutput.nblast.container {
margin-bottom: 19px; /* padding has already 5px */
}
/* ... except between code cells! */
.nblast.container + .nbinput.container {
margin-top: -19px;
}
.admonition > p:before {
margin-right: 4px; /* make room for the exclamation icon */
}
/* Fix math alignment, see https://github.com/rtfd/sphinx_rtd_theme/pull/686 */
.math {
text-align: unset;
}
</style>
<section id="the-python-arm-radar-toolkit-py-art">
<h1>The Python ARM Radar Toolkit - Py-ART<a class="headerlink" href="#the-python-arm-radar-toolkit-py-art" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
<section id="what-is-py-art">
<h2>What is Py-ART?<a class="headerlink" href="#what-is-py-art" title="Permalink to this headline">¶</a></h2>
<p>The Python ARM Radar Toolkit, Py-ART, is a Python module containing a
collection of weather radar algorithms and utilities. Py-ART is used by the
<a class="reference external" href="https://www.arm.gov/">Atmospheric Radiation Measurement (ARM) Climate Research Facility</a> for working
with data from a number of its <a class="reference external" href="https://radar.arm.gov/radar_status">precipitation and cloud radars</a>, but has been
designed so that it can be used by others in the radar and atmospheric
communities to examine, processes, and analyze data from many types of
weather radars.</p>
</section>
<section id="citing-py-art">
<h2>Citing Py-ART<a class="headerlink" href="#citing-py-art" title="Permalink to this headline">¶</a></h2>
<p>If you use Py-ART in your work please cite it in your paper. While the
developers appreciate mentions in the text and acknowledgements citing the
paper helps more.</p>
<p>For Py-ART cite our paper in the <a class="reference external" href="https://openresearchsoftware.metajnl.com/articles/10.5334/jors.119/">Journal of Open Research Software</a></p>
<p>Helmus, J.J. & Collis, S.M., (2016). The Python ARM Radar Toolkit (Py-ART), a
Library for Working with Weather Radar Data in the Python Programming Language.
Journal of Open Research Software. 4(1), p.e25. DOI: <a class="reference external" href="http://doi.org/10.5334/jors.119">http://doi.org/10.5334/jors.119</a></p>
<p>For a general citation on Open Radar Software please cite Maik Heistermann in
<a class="reference external" href="https://journals.ametsoc.org/doi/full/10.1175/BAMS-D-13-00240.1">BAMS</a></p>
<p>M. Heistermann, S. Collis, M. J. Dixon, S. Giangrande, J. J. Helmus, B. Kelley,
J. Koistinen, D. B. Michelson, M. Peura, T. Pfaff, and D. B. Wolff, 2015: The
Emergence of Open-Source Software for the Weather Radar Community. Bull. Amer.
Meteor. Soc. 96, 117–128, doi: 10.1175/BAMS-D-13-00240.1.</p>
</section>
<section id="what-can-py-art-do">
<h2>What can Py-ART do?<a class="headerlink" href="#what-can-py-art-do" title="Permalink to this headline">¶</a></h2>
<p>Py-ART has the ability to ingest (read) from a number of common weather radar
formats including Sigmet/IRIS, MDV, CF/Radial, UF, and NEXRAD Level II archive
files. Radar data can be written to NetCDF files which conform to the CF/Radial
convention.</p>
<p>Py-ART also contains routines which can produce common radar plots including
PPIs and RHIs.</p>
<p><img alt="PPI" src="_images/ppi.png" /></p>
<p><img alt="RHI" src="_images/rhi.png" /></p>
<p>Algorithms in the module are able to performs a number of corrections on the
radar moment data in antenna coordinate including attenuation correction of
the reflectivity, velocity dealiasing, and correction of the specific (Kdp)
and differential (PhiDP) phases.</p>
<p>A sophisticated mapping routines is able to efficiently create uniform
Cartesian grids of radar fields from one or more radars. Routines exist in
Py-ART for plotting these grids as well as saving them to NetCDF files.</p>
</section>
<section id="short-courses">
<h2>Short Courses<a class="headerlink" href="#short-courses" title="Permalink to this headline">¶</a></h2>
<p>Various short courses on Py-ART and open source radar software have been given
which contain tutorial like materials and additional examples.</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/openradar/AMS-Short-Course-on-Open-Source-Radar-Software">2015 AMS, Open Source Radar Short Course</a></p></li>
<li><p><a class="reference external" href="https://github.com/ARM-DOE/notebooks/tree/master/ASR_PI_2015">2015 ARM/ASR Meeting, PyART, the Python ARM Radar Toolkit</a></p></li>
<li><p><a class="reference external" href="https://github.com/ARM-DOE/notebooks/tree/master/ASR_PI_2014">2014 ARM/ASM Meeting, Py-ART tutorial</a></p></li>
<li><p><a class="reference external" href="https://github.com/openradar/open_source_radar_short_course">2014 ERAD, Open Source Radar Short Course</a></p></li>
</ul>
</section>
<section id="install">
<h2>Install<a class="headerlink" href="#install" title="Permalink to this headline">¶</a></h2>
<p>The easiest method for installing Py-ART is to use the conda packages from
the latest release and use Python 3, as Python 2 support ended January 1st,
2020 and many packages including Py-ART no longer support Python 2.
To do this you must download and install
<a class="reference external" href="https://www.anaconda.com/download/#">Anaconda</a> or
<a class="reference external" href="https://conda.io/miniconda.html">Miniconda</a>.
With Anaconda or Miniconda install, it is recommended to create a new conda
environment when using Py-ART or even other packages. To create a new
environment based on the <a class="reference external" href="https://github.com/ARM-DOE/pyart/blob/master/environment.yml">environment.yml</a>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">env</span> <span class="n">create</span> <span class="o">-</span><span class="n">f</span> <span class="n">environment</span><span class="o">.</span><span class="n">yml</span>
</pre></div>
</div>
<p>Or for a basic environment and downloading optional dependencies as needed:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">create</span> <span class="o">-</span><span class="n">n</span> <span class="n">pyart_env</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">python</span><span class="o">=</span><span class="mf">3.8</span> <span class="n">arm_pyart</span>
</pre></div>
</div>
<p>Basic command in a terminal or command prompt to install the latest version of
Py-ART:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">arm_pyart</span>
</pre></div>
</div>
<p>To update an older version of Py-ART to the latest release use:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">update</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">arm_pyart</span>
</pre></div>
</div>
<p>If you do not wish to use Anaconda or Miniconda as a Python environment or want
to use the latest, unreleased version of Py-ART clone the git repository or
download the repositories zip file and extract the file. Then run:</p>
<p>$ python setup.py install</p>
<p>Additional detail on installing Py-ART can be found in the installation section.</p>
</section>
<section id="dependencies">
<h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h2>
<p>Py-ART is tested to work under Python 3.6, 3.7 and 3.8</p>
<p>The required dependencies to install Py-ART in addition to Python are:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://www.numpy.org/">NumPy</a></p></li>
<li><p><a class="reference external" href="https://www.scipy.org">SciPy</a></p></li>
<li><p><a class="reference external" href="https://matplotlib.org/">matplotlib</a></p></li>
<li><p><a class="reference external" href="https://github.com/Unidata/netcdf4-python">netCDF4</a></p></li>
</ul>
<p>A working C/C++ compiler is required for some optional modules. An easy method
to install these dependencies is by using a
<a class="reference external" href="http://scipy.org/install.html">Scientific Python distributions</a>.
<a class="reference external" href="https://www.anaconda.com/distribution/">Anaconda Compilers</a> will install
all of the above packages by default on Windows, Linux and Mac computers and is
provided free of charge by Anaconda. Anaconda also has their own compilers,
which may be required for optional dependencies such as CyLP. These compilers
can be found here:
<a class="reference external" href="https://docs.conda.io/projects/conda-build/en/latest/resources/compiler-tools.html">https://docs.conda.io/projects/conda-build/en/latest/resources/compiler-tools.html</a></p>
</section>
<section id="optional-dependences">
<h2>Optional Dependences<a class="headerlink" href="#optional-dependences" title="Permalink to this headline">¶</a></h2>
<p>The above Python modules are require before installing Py-ART, additional
functionality is available of the following modules are installed.</p>
<ul class="simple">
<li><p><a class="reference external" href="https://trmm-fc.gsfc.nasa.gov/trmm_gv/software/rsl/">TRMM Radar Software Library (RSL)</a>.
If installed Py-ART will be able t`o read in radar data in a number of
additional formats (Lassen, McGill, Universal Format, and RADTEC) and
perform automatic dealiasing of Doppler velocities. RSL should be
install prior to installing Py-ART. The environmental variable <cite>RSL_PATH</cite>
should point to the location where RSL was installed if RSL was not
installed in the default location (/usr/local/trmm), such as a anaconda path
(/usr/anaconda3/envs/pyart_env/.</p></li>
<li><p>In order to read files which are stored in HDF5 files the
<a class="reference external" href="https://www.h5py.org/">h5py</a> package and related libraries must be
installed.</p></li>
<li><p>A linear programming solver and Python wrapper to use the LP phase
processing method. <a class="reference external" href="https://github.com/mpy/CyLP">CyLP</a> is recommended as
it gives the fastest results, but
<a class="reference external" href="https://tfinley.net/software/pyglpk/">PyGLPK</a> and
<a class="reference external" href="https://cvxopt.org/">CVXOPT</a> are also supported. The underlying LP
solvers <a class="reference external" href="https://projects.coin-or.org/Cbc">CBC</a> or
<a class="reference external" href="https://www.gnu.org/software/glpk/">GLPK</a> will also be required depending
on which wrapper is used. When using <a class="reference external" href="https://github.com/mpy/CyLP">CyLP</a>
a path to coincbc is needed by setting the <cite>COIN_INSTALL_DIR</cite> path, such as
(/usr/anaconda3/envs/pyart_env/).</p></li>
<li><p><a class="reference external" href="https://scitools.org.uk/cartopy/docs/latest/">Cartopy</a>. If installed,
the ability to plot grids on geographic maps is available.</p></li>
<li><p><a class="reference external" href="https://xarray.pydata.org/en/stable/">xarray</a>. If installed, gives the
ability to work with the grid dataset used in grid plotting.</p></li>
<li><p><a class="reference external" href="https://matplotlib.org/basemap/">Basemap</a>. If installed, also gives the
ability to plot grids on geographic maps, but Cartopy is recommended over
Basemap.</p></li>
<li><p><a class="reference external" href="https://docs.wradlib.org/en/latest/">wradlib</a>. Needed to calculate the texture
of a differential phase field.</p></li>
<li><p><a class="reference external" href="https://docs.pytest.org/en/latest/">pytest</a>.
Required to run the Py-ART unit tests.</p></li>
<li><p><a class="reference external" href="https://pypi.python.org/pypi/GDAL/">gdal</a>.
Required to output GeoTIFFs from <cite>Grid</cite> objects.</p></li>
</ul>
</section>
<section id="getting-help">
<h2>Getting help<a class="headerlink" href="#getting-help" title="Permalink to this headline">¶</a></h2>
<p>Py-ART has a <a class="reference external" href="https://groups.google.com/forum/#!forum/pyart-users">mailing list</a> where you can ask questions and request help.</p>
</section>
<section id="contributing">
<h2>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h2>
<p>Py-ART is an open source software package distributed under the <a class="reference external" href="https://opensource.org/licenses/BSD-3-Clause">New BSD License</a>
Source code for the package is available on <a class="reference external" href="https://github.com/ARM-DOE/pyart">GitHub</a>. Feature requests and bug reports
can be submitted to the <a class="reference external" href="https://github.com/ARM-DOE/pyart/issues">Issue tracker</a>, posting to the pyart-users <a class="reference external" href="https://groups.google.com/forum/#!forum/pyart-users">mailing list</a>.
Contributions of source code, documentation or additional example are always
appreciated from both developers and users. To learn more on contributing to Py-ART, see
the contributor’s guide.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="API/index.html" class="btn btn-neutral float-right" title="API Reference Manual" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2013-2020, Py-ART developers.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>