deploy: 108e8e2

API/index.html

@@ -1174,7 +1174,7 @@
 <dd class="field-odd"><p>1.19</p>
 </dd>
 <dt class="field-even">Date<span class="colon">:</span></dt>
-<dd class="field-even"><p>Sep 03, 2024</p>
+<dd class="field-even"><p>Sep 04, 2024</p>
 </dd>
 </dl>
 <p>This guide provides documentation for all modules, function, methods,

_downloads/507fce1ff610c02b5a302b5e844cb7bc/plot_cloud_mask.py

@@ -61,6 +61,6 @@
 
 # And now we can plot the masked reflectivity field.
 display = pyart.graph.RadarDisplay(cloud_mask_radar)
-display.plot("reflectivity_copol")
+display.plot("reflectivity_cloud_mask")
 display.set_limits(xlim=(0, 55))
 plt.show()

_downloads/e417eb06d7ddaf7b02425f979fd10ab4/plot_cloud_mask.ipynb

@@ -51,7 +51,7 @@
       },
       "outputs": [],
       "source": [
-        "# First lets correct the data by calculating the mask.\ncloud_mask_radar = pyart.correct.calc_cloud_mask(radar, \"reflectivity_copol\", \"range\")\n\n# In this new radar object we should now have a new cloud mask field.\nprint(cloud_mask_radar.fields[\"cloud_mask_2\"])\n\n# Next we'll create a copy of the reflectivity field so we are not\n# overwriting the original data.\ncloud_mask_radar.add_field_like(\n    \"reflectivity_copol\",\n    \"reflectivity_cloud_mask\",\n    cloud_mask_radar.fields[\"reflectivity_copol\"][\"data\"].copy(),\n)\n\n# Now let's apply the mask to the copied reflectivity data.\ncloud_mask_radar.fields[\"reflectivity_cloud_mask\"][\"data\"][\n    cloud_mask_radar.fields[\"cloud_mask_2\"][\"data\"] == 0\n] = np.nan\n\n# And now we can plot the masked reflectivity field.\ndisplay = pyart.graph.RadarDisplay(cloud_mask_radar)\ndisplay.plot(\"reflectivity_copol\")\ndisplay.set_limits(xlim=(0, 55))\nplt.show()"
+        "# First lets correct the data by calculating the mask.\ncloud_mask_radar = pyart.correct.calc_cloud_mask(radar, \"reflectivity_copol\", \"range\")\n\n# In this new radar object we should now have a new cloud mask field.\nprint(cloud_mask_radar.fields[\"cloud_mask_2\"])\n\n# Next we'll create a copy of the reflectivity field so we are not\n# overwriting the original data.\ncloud_mask_radar.add_field_like(\n    \"reflectivity_copol\",\n    \"reflectivity_cloud_mask\",\n    cloud_mask_radar.fields[\"reflectivity_copol\"][\"data\"].copy(),\n)\n\n# Now let's apply the mask to the copied reflectivity data.\ncloud_mask_radar.fields[\"reflectivity_cloud_mask\"][\"data\"][\n    cloud_mask_radar.fields[\"cloud_mask_2\"][\"data\"] == 0\n] = np.nan\n\n# And now we can plot the masked reflectivity field.\ndisplay = pyart.graph.RadarDisplay(cloud_mask_radar)\ndisplay.plot(\"reflectivity_cloud_mask\")\ndisplay.set_limits(xlim=(0, 55))\nplt.show()"
       ]
     }
   ],

_sources/examples/correct/plot_attenuation.rst.txt

@@ -114,7 +114,7 @@ for a polarimetric radar using a Z-PHI method implemented in Py-ART.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 8.430 seconds)
+   **Total running time of the script:** (0 minutes 8.589 seconds)
 
 
 .. _sphx_glr_download_examples_correct_plot_attenuation.py:

_sources/examples/correct/plot_cloud_mask.rst.txt

@@ -114,7 +114,7 @@ to calculate the mask.
 
     # And now we can plot the masked reflectivity field.
     display = pyart.graph.RadarDisplay(cloud_mask_radar)
-    display.plot("reflectivity_copol")
+    display.plot("reflectivity_cloud_mask")
     display.set_limits(xlim=(0, 55))
     plt.show()
 
@@ -154,7 +154,7 @@ to calculate the mask.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.692 seconds)
+   **Total running time of the script:** (0 minutes 0.774 seconds)
 
 
 .. _sphx_glr_download_examples_correct_plot_cloud_mask.py:

_sources/examples/correct/plot_dealias.rst.txt

@@ -124,7 +124,7 @@ using the region-based dealiasing algorithm in Py-ART.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 59.693 seconds)
+   **Total running time of the script:** (0 minutes 57.941 seconds)
 
 
 .. _sphx_glr_download_examples_correct_plot_dealias.py:

_sources/examples/correct/plot_zdr_check.rst.txt

@@ -95,7 +95,7 @@ bias calculation to ensure that we are taking the average ZDR in light rain.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.483 seconds)
+   **Total running time of the script:** (0 minutes 0.647 seconds)
 
 
 .. _sphx_glr_download_examples_correct_plot_zdr_check.py:

_sources/examples/correct/sg_execution_times.rst.txt

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**01:09.298** total execution time for 4 files **from examples/correct**:
+**01:07.952** total execution time for 4 files **from examples/correct**:
 
 .. container::
 
@@ -33,14 +33,14 @@ Computation times
      - Time
      - Mem (MB)
    * - :ref:`sphx_glr_examples_correct_plot_dealias.py` (``plot_dealias.py``)
-     - 00:59.693
+     - 00:57.941
      - 0.0
    * - :ref:`sphx_glr_examples_correct_plot_attenuation.py` (``plot_attenuation.py``)
-     - 00:08.430
+     - 00:08.589
      - 0.0
    * - :ref:`sphx_glr_examples_correct_plot_cloud_mask.py` (``plot_cloud_mask.py``)
-     - 00:00.692
+     - 00:00.774
      - 0.0
    * - :ref:`sphx_glr_examples_correct_plot_zdr_check.py` (``plot_zdr_check.py``)
-     - 00:00.483
+     - 00:00.647
      - 0.0

_sources/examples/io/plot_nexrad_data_aws.rst.txt

@@ -116,7 +116,7 @@ Let's take a look at a summary of what fields are available.
  .. code-block:: none
 
 
-    ['reflectivity', 'differential_phase', 'velocity', 'clutter_filter_power_removed', 'spectrum_width', 'cross_correlation_ratio', 'differential_reflectivity']
+    ['velocity', 'differential_reflectivity', 'spectrum_width', 'clutter_filter_power_removed', 'reflectivity', 'differential_phase', 'cross_correlation_ratio']
 
 
 
@@ -314,7 +314,7 @@ Note: the reflectivity and velocity fields are in different radars, so we need t
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 14.564 seconds)
+   **Total running time of the script:** (0 minutes 14.306 seconds)
 
 
 .. _sphx_glr_download_examples_io_plot_nexrad_data_aws.py:

_sources/examples/io/plot_older_nexrad_data_aws.rst.txt

@@ -227,7 +227,7 @@ Everything now looks correct as this is in Handford CA!
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 8.521 seconds)
+   **Total running time of the script:** (0 minutes 9.152 seconds)
 
 
 .. _sphx_glr_download_examples_io_plot_older_nexrad_data_aws.py:

_sources/examples/io/sg_execution_times.rst.txt

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:23.085** total execution time for 2 files **from examples/io**:
+**00:23.458** total execution time for 2 files **from examples/io**:
 
 .. container::
 
@@ -33,8 +33,8 @@ Computation times
      - Time
      - Mem (MB)
    * - :ref:`sphx_glr_examples_io_plot_nexrad_data_aws.py` (``plot_nexrad_data_aws.py``)
-     - 00:14.564
+     - 00:14.306
      - 0.0
    * - :ref:`sphx_glr_examples_io_plot_older_nexrad_data_aws.py` (``plot_older_nexrad_data_aws.py``)
-     - 00:08.521
+     - 00:09.152
      - 0.0

_sources/examples/mapping/plot_compare_two_radars_gatemapper.rst.txt

@@ -354,7 +354,7 @@ case where our scans don't neccessarily match exactly in time.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 36.124 seconds)
+   **Total running time of the script:** (0 minutes 36.126 seconds)
 
 
 .. _sphx_glr_download_examples_mapping_plot_compare_two_radars_gatemapper.py:

_sources/examples/mapping/plot_grid_single_sweep_ppi.rst.txt

@@ -187,7 +187,7 @@ negligible at low elevation angles common to PPI sweeps.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 5.911 seconds)
+   **Total running time of the script:** (0 minutes 5.965 seconds)
 
 
 .. _sphx_glr_download_examples_mapping_plot_grid_single_sweep_ppi.py:

_sources/examples/mapping/plot_map_one_radar_to_grid.rst.txt

@@ -82,7 +82,7 @@ Cartesian grid.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 5.846 seconds)
+   **Total running time of the script:** (0 minutes 5.916 seconds)
 
 
 .. _sphx_glr_download_examples_mapping_plot_map_one_radar_to_grid.py:

_sources/examples/mapping/plot_map_two_radars_to_grid.rst.txt

@@ -90,7 +90,7 @@ coordinates to a Cartesian grid.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 9.982 seconds)
+   **Total running time of the script:** (0 minutes 10.189 seconds)
 
 
 .. _sphx_glr_download_examples_mapping_plot_map_two_radars_to_grid.py:

_sources/examples/mapping/sg_execution_times.rst.txt

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:57.862** total execution time for 4 files **from examples/mapping**:
+**00:58.196** total execution time for 4 files **from examples/mapping**:
 
 .. container::
 
@@ -33,14 +33,14 @@ Computation times
      - Time
      - Mem (MB)
    * - :ref:`sphx_glr_examples_mapping_plot_compare_two_radars_gatemapper.py` (``plot_compare_two_radars_gatemapper.py``)
-     - 00:36.124
+     - 00:36.126
      - 0.0
    * - :ref:`sphx_glr_examples_mapping_plot_map_two_radars_to_grid.py` (``plot_map_two_radars_to_grid.py``)
-     - 00:09.982
+     - 00:10.189
      - 0.0
    * - :ref:`sphx_glr_examples_mapping_plot_grid_single_sweep_ppi.py` (``plot_grid_single_sweep_ppi.py``)
-     - 00:05.911
+     - 00:05.965
      - 0.0
    * - :ref:`sphx_glr_examples_mapping_plot_map_one_radar_to_grid.py` (``plot_map_one_radar_to_grid.py``)
-     - 00:05.846
+     - 00:05.916
      - 0.0

_sources/examples/plotting/plot_cappi.rst.txt

@@ -89,7 +89,7 @@ both the PPI and CAPPI for comparison.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 1.983 seconds)
+   **Total running time of the script:** (0 minutes 2.249 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_cappi.py:

_sources/examples/plotting/plot_choose_a_colormap.rst.txt

@@ -322,7 +322,7 @@ Setup a display to plot the data
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 1.968 seconds)
+   **Total running time of the script:** (0 minutes 1.971 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_choose_a_colormap.py:

_sources/examples/plotting/plot_corner_reflector.rst.txt

@@ -63,7 +63,7 @@ This is an example of how to plot a corner reflector.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 1.092 seconds)
+   **Total running time of the script:** (0 minutes 0.932 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_corner_reflector.py:

_sources/examples/plotting/plot_cross_section.rst.txt

@@ -113,7 +113,7 @@ of your radar grid using the GridMapDisplay
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 9.007 seconds)
+   **Total running time of the script:** (0 minutes 9.015 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_cross_section.py:

_sources/examples/plotting/plot_max_cappi.rst.txt

@@ -185,7 +185,7 @@ Let's read in a cfradial file and create a grid.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 12.834 seconds)
+   **Total running time of the script:** (0 minutes 12.998 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_max_cappi.py:

_sources/examples/plotting/plot_modify_colorbar.rst.txt

@@ -197,7 +197,7 @@ and slightly overlaps the PPI display
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 3.054 seconds)
+   **Total running time of the script:** (0 minutes 3.053 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_modify_colorbar.py:

_sources/examples/plotting/plot_nexrad_image_muted_reflectivity.rst.txt

@@ -102,7 +102,7 @@ of regions of melting or mixed precipitation as opposed to heavy snow or heavy r
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 3.790 seconds)
+   **Total running time of the script:** (0 minutes 3.975 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_nexrad_image_muted_reflectivity.py:

_sources/examples/plotting/plot_nexrad_multiple_moments.rst.txt

@@ -102,7 +102,7 @@ NEXRAD Archive file.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 3.385 seconds)
+   **Total running time of the script:** (0 minutes 3.316 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_nexrad_multiple_moments.py:

_sources/examples/plotting/plot_nexrad_reflectivity.rst.txt

@@ -75,7 +75,7 @@ NEXRAD file.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 1.626 seconds)
+   **Total running time of the script:** (0 minutes 1.570 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_nexrad_reflectivity.py:

_sources/examples/plotting/plot_ppi_cfradial.rst.txt

@@ -66,7 +66,7 @@ An example which creates a PPI plot of a Cfradial file.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 1.349 seconds)
+   **Total running time of the script:** (0 minutes 1.355 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_ppi_cfradial.py:

_sources/examples/plotting/plot_ppi_mdv.rst.txt

@@ -66,7 +66,7 @@ An example which creates a PPI plot of a MDV file using a RadarDisplay object.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 2.118 seconds)
+   **Total running time of the script:** (0 minutes 2.160 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_ppi_mdv.py:

_sources/examples/plotting/plot_ppi_with_rings.rst.txt

@@ -105,7 +105,7 @@ and range rings
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 6.290 seconds)
+   **Total running time of the script:** (0 minutes 6.364 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_ppi_with_rings.py:

_sources/examples/plotting/plot_rhi_cfradial.rst.txt

@@ -97,7 +97,7 @@ a RadarDisplay object.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 1.810 seconds)
+   **Total running time of the script:** (0 minutes 1.820 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_rhi_cfradial.py:

_sources/examples/plotting/plot_rhi_cfradial_singlescan.rst.txt

@@ -84,7 +84,7 @@ a RadarDisplay object.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 1.045 seconds)
+   **Total running time of the script:** (0 minutes 1.055 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_rhi_cfradial_singlescan.py:

_sources/examples/plotting/plot_rhi_contours_differential_reflectivity.rst.txt

@@ -134,7 +134,7 @@ and adding differnential Reflectivity contours from the same MDV file.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 1.384 seconds)
+   **Total running time of the script:** (0 minutes 1.438 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_rhi_contours_differential_reflectivity.py:

_sources/examples/plotting/plot_rhi_data_overlay.rst.txt

@@ -131,7 +131,7 @@ and adding Reflectivity contours from the same MDV file.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.945 seconds)
+   **Total running time of the script:** (0 minutes 0.908 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_rhi_data_overlay.py:

_sources/examples/plotting/plot_rhi_mdv.rst.txt

@@ -63,7 +63,7 @@ An example which creates a RHI plot of a MDV file using a RadarDisplay object.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.619 seconds)
+   **Total running time of the script:** (0 minutes 0.616 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_rhi_mdv.py:

_sources/examples/plotting/plot_three_panel_gridmapdisplay.rst.txt

@@ -108,7 +108,7 @@ and longitude slice using xarray and a cartopy background.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 7.209 seconds)
+   **Total running time of the script:** (0 minutes 7.148 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_three_panel_gridmapdisplay.py:

_sources/examples/plotting/plot_xsect.rst.txt

@@ -80,7 +80,7 @@ of PPI scans and plots both cross sections.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 1.372 seconds)
+   **Total running time of the script:** (0 minutes 1.374 seconds)
 
 
 .. _sphx_glr_download_examples_plotting_plot_xsect.py: