deploy: c8b5128

Author: wolfidan

API/generated/generated/pyrad.prod.generate_colocated_gates_products.html

@@ -1307,7 +1307,7 @@ <h1>pyrad.prod.generate_colocated_gates_products<a class="headerlink" href="#pyr
 <span class="sig-prename descclassname"><span class="pre">pyrad.prod.</span></span><span class="sig-name descname"><span class="pre">generate_colocated_gates_products</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prdcfg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/pyrad/prod/process_intercomp_products.html#generate_colocated_gates_products"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyrad.prod.generate_colocated_gates_products" title="Link to this definition">#</a></dt>
 <dd><dl>
 <dt>Generates colocated gates products. Accepted product types:</dt><dd><dl class="simple">
-<dt>‘WRITE_COLOCATED_GATES’: Writes the position of the co-located gates</dt><dd><p>in a csv file</p>
+<dt>WRITE_COLOCATED_GATES: Writes the position of the co-located gates</dt><dd><p>in a csv file</p>
 </dd>
 </dl>
 <p>All the products of the ‘VOL’ dataset group</p>

API/generated/generated/pyrad.prod.generate_grid_products.html

@@ -1309,6 +1309,8 @@ <h1>pyrad.prod.generate_grid_products<a class="headerlink" href="#pyrad-prod-gen
 <dt>generates grid products. Accepted product types:</dt><dd><dl>
 <dt>‘CROSS_SECTION’: Plots a cross-section of gridded data</dt><dd><dl class="simple">
 <dt>User defined parameters:</dt><dd><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
 <dt>coord1, coord2: dict</dt><dd><p>The two lat-lon coordinates marking the limits. They have
 the keywords ‘lat’ and ‘lon’ [degree]. The altitude limits
 are defined by the parameters in ‘xsecImageConfig’ in the
@@ -1320,6 +1322,8 @@ <h1>pyrad.prod.generate_grid_products<a class="headerlink" href="#pyrad-prod-gen
 </dd>
 <dt>‘HISTOGRAM’: Computes a histogram of the radar volum data</dt><dd><dl class="simple">
 <dt>User defined parameters:</dt><dd><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
 <dt>step: float or None</dt><dd><p>the data quantization step. If none it will be obtained
 from the Py-ART configuration file</p>
 </dd>
@@ -1338,6 +1342,8 @@ <h1>pyrad.prod.generate_grid_products<a class="headerlink" href="#pyrad-prod-gen
 User defined parameters:</p>
 <blockquote>
 <div><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
 <dt>lon, lat: floats</dt><dd><p>The starting point of the cross-section. The ending point
 is defined by the parameters in ‘xsecImageConfig’ in the
 ‘loc’ configuration file</p>
@@ -1349,6 +1355,8 @@ <h1>pyrad.prod.generate_grid_products<a class="headerlink" href="#pyrad-prod-gen
 User defined parameters:</p>
 <blockquote>
 <div><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
 <dt>lon, lat: floats</dt><dd><p>The starting point of the cross-section. The ending point
 is defined by the parameters in ‘xsecImageConfig’ in the
 ‘loc’ configuration file</p>
@@ -1370,6 +1378,8 @@ <h1>pyrad.prod.generate_grid_products<a class="headerlink" href="#pyrad-prod-gen
 </dd>
 <dt>‘SAVEVOL’: Saves on field of a gridded data object in a netcdf file.</dt><dd><dl class="simple">
 <dt>User defined parameters:</dt><dd><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
 <dt>file_type: str</dt><dd><p>The type of file used to save the data. Can be ‘nc’ or
 ‘h5’. Default ‘nc’</p>
 </dd>
@@ -1395,6 +1405,8 @@ <h1>pyrad.prod.generate_grid_products<a class="headerlink" href="#pyrad-prod-gen
 User defined parameters:</p>
 <blockquote>
 <div><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
 <dt>stat: str</dt><dd><p>The statistic used. Can be mean, median, min, max</p>
 </dd>
 </dl>
@@ -1404,6 +1416,8 @@ <h1>pyrad.prod.generate_grid_products<a class="headerlink" href="#pyrad-prod-gen
 User defined parameters:</p>
 <blockquote>
 <div><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
 <dt>level: int</dt><dd><p>The altitude level to plot. The rest of the parameters are
 defined by the parameters in ‘ppiImageConfig’ and
 ‘ppiMapImageConfig’ in the ‘loc’ configuration file</p>
@@ -1413,6 +1427,8 @@ <h1>pyrad.prod.generate_grid_products<a class="headerlink" href="#pyrad-prod-gen
 </dd>
 <dt>‘SURFACE_IMAGE’: Plots a surface image of gridded data.</dt><dd><dl class="simple">
 <dt>User defined parameters:</dt><dd><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
 <dt>level: int</dt><dd><p>The altitude level to plot. The rest of the parameters are
 defined by the parameters in ‘ppiImageConfig’ and
 ‘ppiMapImageConfig’ in the ‘loc’ configuration file</p>
@@ -1423,6 +1439,8 @@ <h1>pyrad.prod.generate_grid_products<a class="headerlink" href="#pyrad-prod-gen
 </dd>
 <dt>‘SURFACE_CONTOUR’: Plots a surface image of contour gridded data.</dt><dd><dl class="simple">
 <dt>User defined parameters:</dt><dd><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
 <dt>level: int</dt><dd><p>The altitude level to plot. The rest of the parameters are
 defined by the parameters in ‘ppiImageConfig’ and
 ‘ppiMapImageConfig’ in the ‘loc’ configuration file</p>
@@ -1445,6 +1463,8 @@ <h1>pyrad.prod.generate_grid_products<a class="headerlink" href="#pyrad-prod-gen
 User defined parameters:</p>
 <blockquote>
 <div><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
 <dt>level: int</dt><dd><p>The altitude level to plot. The rest of the parameters are
 defined by the parameters in ‘ppiImageConfig’ and
 ‘ppiMapImageConfig’ in the ‘loc’ configuration file</p>
@@ -1466,6 +1486,8 @@ <h1>pyrad.prod.generate_grid_products<a class="headerlink" href="#pyrad-prod-gen
 User defined parameters:</p>
 <blockquote>
 <div><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
 <dt>level: int</dt><dd><p>The altitude level to plot. The rest of the parameters are
 defined by the parameters in ‘ppiImageConfig’ and
 ‘ppiMapImageConfig’ in the ‘loc’ configuration file</p>
@@ -1479,11 +1501,13 @@ <h1>pyrad.prod.generate_grid_products<a class="headerlink" href="#pyrad-prod-gen
 </dl>
 </div></blockquote>
 </dd>
-<dt>‘DDA_MAP’:</dt><dd><p>Plots wind vectors obtained from a DDA analysis. The pyDDA package is
-required
+<dt>‘DDA_MAP’:</dt><dd><p>Plots horizontal wind vectors obtained from a DDA analysis on a 2D map.
+The pyDDA package is required
 User defined parameters:</p>
 <blockquote>
 <div><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
 <dt>level: int</dt><dd><p>The altitude level to plot. The rest of the parameters are
 defined by the parameters in ‘ppiImageConfig’ and
 ‘ppiMapImageConfig’ in the ‘loc’ configuration file</p>
@@ -1518,6 +1542,90 @@ <h1>pyrad.prod.generate_grid_products<a class="headerlink" href="#pyrad-prod-gen
 </dl>
 </div></blockquote>
 </dd>
+<dt>‘DDA_LONGITUDE_SLICE’:</dt><dd><p>Plots horizontal wind vectors obtained from a DDA analysis on a vertical transect
+along a given longitude
+The pyDDA package is required
+User defined parameters:</p>
+<blockquote>
+<div><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
+<dt>level: int</dt><dd><p>The longitude level to plot. The rest of the parameters are
+defined by the parameters in ‘xsecImageConfig’ in the ‘loc’
+configuration file</p>
+</dd>
+<dt>display_type: str</dt><dd><p>Display method for the wind vectors, can be either
+‘streamline’, ‘quiver’ or ‘barbs’</p>
+</dd>
+<dt>bg_ref_rad: int</dt><dd><p>Which radar to use as reference to display the background
+voltype.</p>
+</dd>
+<dt>u_vel_contours: list of int</dt><dd><p>The contours to use for plotting contours of u. Set to None to not
+display such contours.</p>
+</dd>
+<dt>v_vel_contours: list of int</dt><dd><p>The contours to use for plotting contours of v. Set to None to not
+display such contours.</p>
+</dd>
+<dt>w_vel_contours: list of int</dt><dd><p>The contours to use for plotting contours of w. Set to None to not
+display such contours.</p>
+</dd>
+<dt>vector_spacing_km: float</dt><dd><p>Spacing in km between wind vectors in x and y axis
+(only used for barbs and quiver plots)</p>
+</dd>
+<dt>quiver_len: float</dt><dd><p>Length to use for the quiver key in m/s.
+(only used for quiver plots)</p>
+</dd>
+<dt>streamline_arrowsize: float</dt><dd><p>Factor scale arrow size for streamlines.
+(only used for streamline plots)</p>
+</dd>
+<dt>linewidth: float</dt><dd><p>Linewidths for streamlines.
+(only used for streamline plots)</p>
+</dd>
+</dl>
+</div></blockquote>
+</dd>
+<dt>‘DDA_LATITUDE_SLICE’:</dt><dd><p>Plots horizontal wind vectors obtained from a DDA analysis on a vertical transect
+along a given latitude
+The pyDDA package is required
+User defined parameters:</p>
+<blockquote>
+<div><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
+<dt>level: int</dt><dd><p>The latitude level to plot. The rest of the parameters are
+defined by the parameters in ‘xsecImageConfig’ in the ‘loc’
+configuration file</p>
+</dd>
+<dt>display_type: str</dt><dd><p>Display method for the wind vectors, can be either
+‘streamline’, ‘quiver’ or ‘barbs’</p>
+</dd>
+<dt>bg_ref_rad: int</dt><dd><p>Which radar to use as reference to display the background
+voltype.</p>
+</dd>
+<dt>u_vel_contours: list of int</dt><dd><p>The contours to use for plotting contours of u. Set to None to not
+display such contours.</p>
+</dd>
+<dt>v_vel_contours: list of int</dt><dd><p>The contours to use for plotting contours of v. Set to None to not
+display such contours.</p>
+</dd>
+<dt>w_vel_contours: list of int</dt><dd><p>The contours to use for plotting contours of w. Set to None to not
+display such contours.</p>
+</dd>
+<dt>vector_spacing_km: float</dt><dd><p>Spacing in km between wind vectors in x and y axis
+(only used for barbs and quiver plots)</p>
+</dd>
+<dt>quiver_len: float</dt><dd><p>Length to use for the quiver key in m/s.
+(only used for quiver plots)</p>
+</dd>
+<dt>streamline_arrowsize: float</dt><dd><p>Factor scale arrow size for streamlines.
+(only used for streamline plots)</p>
+</dd>
+<dt>linewidth: float</dt><dd><p>Linewidths for streamlines.
+(only used for streamline plots)</p>
+</dd>
+</dl>
+</div></blockquote>
+</dd>
 </dl>
 </dd>
 </dl>

API/generated/generated/pyrad.prod.generate_intercomp_products.html

@@ -1312,20 +1312,25 @@ <h1>pyrad.prod.generate_intercomp_products<a class="headerlink" href="#pyrad-pro
 User defined parameters:</p>
 <blockquote>
 <div><dl class="simple">
-<dt>‘add_date_in_fname’: Bool</dt><dd><p>If true adds the year in the csv file containing the
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
+<dt>add_date_in_fname: Bool</dt><dd><p>If true adds the year in the csv file containing the
 statistics. Default False</p>
 </dd>
-<dt>‘sort_by_date’: Bool</dt><dd><p>If true sorts the statistics by date when reading the
+<dt>sort_by_date: Bool</dt><dd><p>If true sorts the statistics by date when reading the
 csv file containing the statistics. Default False</p>
 </dd>
-<dt>‘rewrite’: Bool</dt><dd><p>If true rewrites the csv file containing the statistics.
+<dt>step: float</dt><dd><p>The quantization step of the data. If none it will be
+computed using the Py-ART config file. Default None</p>
+</dd>
+<dt>rewrite: Bool</dt><dd><p>If true rewrites the csv file containing the statistics.
 Default False</p>
 </dd>
-<dt>‘npoints_min’: int</dt><dd><p>The minimum number of points to consider the statistics
+<dt>npoints_min: int</dt><dd><p>The minimum number of points to consider the statistics
 valid and therefore use the data point in the plotting.
 Default 0</p>
 </dd>
-<dt>‘corr_min’: float</dt><dd><p>The minimum correlation to consider the statistics
+<dt>corr_min: float</dt><dd><p>The minimum correlation to consider the statistics
 valid and therefore use the data point in the plotting.
 Default 0.</p>
 </dd>
@@ -1336,19 +1341,35 @@ <h1>pyrad.prod.generate_intercomp_products<a class="headerlink" href="#pyrad-pro
 User defined parameters:</p>
 <blockquote>
 <div><dl class="simple">
-<dt>‘step’: float</dt><dd><p>The quantization step of the data. If none it will be
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
+<dt>step: float</dt><dd><p>The quantization step of the data. If none it will be
 computed using the Py-ART config file. Default None</p>
 </dd>
-<dt>‘scatter_type’: str</dt><dd><p>Type of scatter plot. Can be a plot for each radar volume
-(‘instant’) or at the end of the processing period
-(‘cumulative’). Default is ‘cumulative’</p>
+<dt>scatter_type: str</dt><dd><p>Type of scatter plot. Can be a plot for each radar volume
+(instant) or at the end of the processing period
+(cumulative). Default is cumulative</p>
+</dd>
+</dl>
+</div></blockquote>
+</dd>
+<dt>‘WRITE_INTERCOMP’: Writes the instantaneously intercompared data</dt><dd><p>(gate positions, values, etc.) in a csv file.
+User defined parameters:</p>
+<blockquote>
+<div><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
 </dd>
 </dl>
 </div></blockquote>
 </dd>
-<dt>‘WRITE_INTERCOMP’: Writes the instantaneously intercompared data</dt><dd><p>(gate positions, values, etc.) in a csv file.</p>
+<dt>‘WRITE_INTERCOMP_TIME_AVG’: Writes the time-averaged intercompared</dt><dd><p>data (gate positions, values, etc.) in a csv file.
+User defined parameters:</p>
+<blockquote>
+<div><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
 </dd>
-<dt>‘WRITE_INTERCOMP_TIME_AVG’: Writes the time-averaged intercompared</dt><dd><p>data (gate positions, values, etc.) in a csv file.</p>
+</dl>
+</div></blockquote>
 </dd>
 </dl>
 </dd>

API/generated/generated/pyrad.prod.generate_monitoring_products.html

@@ -1318,6 +1318,8 @@ <h1>pyrad.prod.generate_monitoring_products<a class="headerlink" href="#pyrad-pr
 User defined parameters:</p>
 <blockquote>
 <div><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
 <dt>anglenr: int</dt><dd><p>The elevation angle number to plot</p>
 </dd>
 <dt>quantiles: list of floats</dt><dd><p>The quantiles to plot. Default 25., 50., 75.</p>
@@ -1334,6 +1336,8 @@ <h1>pyrad.prod.generate_monitoring_products<a class="headerlink" href="#pyrad-pr
 User defined parameters:</p>
 <blockquote>
 <div><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
 <dt>quantiles: list of 3 floats</dt><dd><p>the quantiles to compute. Default 25., 50., 75.</p>
 </dd>
 <dt>ref_value: float</dt><dd><p>The reference value. Default 0</p>
@@ -1385,6 +1389,8 @@ <h1>pyrad.prod.generate_monitoring_products<a class="headerlink" href="#pyrad-pr
 User defined parameters:</p>
 <blockquote>
 <div><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
 <dt>anglenr: int</dt><dd><p>The elevation angle number to plot</p>
 </dd>
 </dl>
@@ -1397,6 +1403,8 @@ <h1>pyrad.prod.generate_monitoring_products<a class="headerlink" href="#pyrad-pr
 User defined parameters:</p>
 <blockquote>
 <div><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
 <dt>write_data: bool</dt><dd><p>If true the resultant histogram is also saved in a csv
 file. Default True.</p>
 </dd>
@@ -1407,6 +1415,8 @@ <h1>pyrad.prod.generate_monitoring_products<a class="headerlink" href="#pyrad-pr
 User defined parameters:</p>
 <blockquote>
 <div><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
 <dt>quantiles: list of 3 floats</dt><dd><p>the quantiles to compute. Default 25., 50., 75.</p>
 </dd>
 <dt>ref_value: float</dt><dd><p>The reference value. Default 0</p>

API/generated/generated/pyrad.prod.generate_occurrence_products.html

@@ -1312,6 +1312,8 @@ <h1>pyrad.prod.generate_occurrence_products<a class="headerlink" href="#pyrad-pr
 User defined parameters:</p>
 <blockquote>
 <div><dl class="simple">
+<dt>voltype: name of the pyrad variable to use, it must be available</dt><dd><p>in the dataset</p>
+</dd>
 <dt>quant_min: float</dt><dd><p>Minimum frequency of occurrence in percentage to keep the
 gate as valid. Default 95.</p>
 </dd>