merge with dev

Author: wolfidan

doc/source/overview/loc.rst

@@ -77,25 +77,93 @@ it is not necessarily defined in this file. The fields are described in the tabl
      - Maximum elevation [°] to consider.
    * - ppiImageConfig
      - STRUCT
-     - Structure defining the PPI image generating (PPI_IMAGE or PSEUDOPPI_IMAGE products).
+     - Structure defining the PPI image generating (PPI_IMAGE or PSEUDOPPI_IMAGE products). It can contain the following keys:
+
+       - dpi: INT: dpi of the output image
+       - xsize: FLOAT: width of the image in inches
+       - ysize: FLOAT: height of the image in inches
+       - ymin: FLOAT: minimum displayed y-coordinate (northwards, in radar centric coordinates)
+       - ymax: FLOAT: minimum displayed y-coordinate (northwards, in radar centric coordinates)
+       - xmin: FLOAT: minimum displayed x-coordinate (eastwards, in radar centric coordinates)
+       - xmax: FLOAT: minimum displayed x-coordinate (northwards, in radar centric coordinates)
+       - rngRing: INT: if defined will plot range rings every x kilometers from the radar (x is the specified value)
    * - rhiImageConfig
      - STRUCT
-     - Structure defining the RHI image generating (RHI_IMAGE or PSEUDORHI_IMAGE products).
+     - Structure defining the RHI image generating (RHI_IMAGE or PSEUDORHI_IMAGE products). It can contain the following keys:
+
+       - dpi: INT: dpi of the output image
+       - xsize: FLOAT: width of the image in inches
+       - ysize: FLOAT: height of the image in inches
+       - ymin: FLOAT: minimum displayed y-coordinate (altitude)
+       - ymax: FLOAT: minimum displayed y-coordinate (altitude)
+       - xmin: FLOAT: minimum displayed x-coordinate (distance at ground along RHI)
+       - xmax: FLOAT: minimum displayed x-coordinate (distance at ground along RHI)
    * - ppiMapImageConfig
      - STRUCT
-     - Structure defining the PPI image overlaid on a map (PPI_MAP product).
+     - Structure defining the PPI image overlaid on a map (PPI_MAP product). It can contain the following keys:
+
+       - dpi: INT: dpi of the output image
+       - xsize: FLOAT: width of the image in inches
+       - ysize: FLOAT: height of the image in inches
+       - min_lon: FLOAT: minimum displayed longitude
+       - max_lon: FLOAT: maximum displayed longitude
+       - min_lat: FLOAT: minimum displayed latitude
+       - max_lat: FLOAT: maximum displayed latitude
+       - resolution: INT: resolution of additional cartopy geodata, only "10m", "50m" or "110m" is supported
+       - alpha: FLOAT: transparency value (between 0 and 1) of the displayed radar data, alpha smaller than 1 is required when plotting over a relief or OTM map
+       - background_zoom: INT: Zoom level of the additional cartopy raster geodata, the higher the value, the higher the resolution (typically between 8 and 12). Default is 8.
+       - maps: list of STRING: list of additional geodata to plot. The following are supported: relief (hillshade), OTM (opentopomaps), provinces, urban_areas, roads, railroads, coastlines, lakes, lakes_europe, rivers, rivers_europe.
+       - rngRing: INT: if defined will plot range rings every x kilometers from the radar (x is the specified value)
    * - gridMapImageConfig
      - STRUCT
-     - Structure defining the display of gridded data overlaid on a map (SURFACE_IMAGE product).
+     - Structure defining the display of gridded data overlaid on a map (SURFACE_IMAGE product). It can contain the following keys:
+
+       - dpi: INT: dpi of the output image
+       - xsize: FLOAT: width of the image in inches
+       - ysize: FLOAT: height of the image in inches
+       - min_lon: FLOAT: minimum displayed longitude
+       - max_lon: FLOAT: maximum displayed longitude
+       - min_lat: FLOAT: minimum displayed latitude
+       - max_lat: FLOAT: maximum displayed latitude
+       - resolution: INT: resolution of additional cartopy geodata, only "10m", "50m" or "110m" is supported
+       - alpha: FLOAT: transparency value (between 0 and 1) of the displayed radar data, alpha smaller than 1 is required when plotting over a relief or OTM map
+       - background_zoom: INT: Zoom level of the additional cartopy raster geodata, the higher the value, the higher the resolution (typically between 8 and 12). Default is 8.
+       - maps: list of STRING: list of additional geodata to plot. The following are supported: relief (hillshade), OTM (opentopomaps), provinces, urban_areas, roads, railroads, coastlines, lakes, lakes_europe, rivers, rivers_europe.
    * - xsecImageConfig
      - STRUCT
-     - Structure defining the cross-section images generated from gridded data (CROSS_SECTION, LATITUDE_SLICE and LONGITUDE_SLICE products).
+     - Structure defining the cross-section images generated from gridded data (CROSS_SECTION, LATITUDE_SLICE and LONGITUDE_SLICE products). It can contain the following keys:
+
+       - dpi: INT: dpi of the output image
+       - xsize: FLOAT: width of the image in inches
+       - ysize: FLOAT: height of the image in inches
+       - ymin: FLOAT: minimum displayed y-coordinate (altitude)
+       - ymax: FLOAT: minimum displayed y-coordinate (altitude)
+       - xmin: FLOAT: minimum displayed x-coordinate (distance at ground along cross-section)
+       - xmax: FLOAT: minimum displayed x-coordinate (distance at ground along cross-section)
    * - spectraImageConfig
      - STRUCT
-     - Structure defining the Doppler spectral plots.
+     - Structure defining the Doppler spectral plots (radar observable as a function of altitude and velocity).  It can contain the following keys:
+
+       - dpi: INT: dpi of the output image
+       - xsize: FLOAT: width of the image in inches
+       - ysize: FLOAT: height of the image in inches
+       - ymin: FLOAT: minimum displayed y-coordinate (altitude)
+       - ymax: FLOAT: minimum displayed y-coordinate (altitude)
+       - velmin: FLOAT: minimum displayed velocity
+       - velmax: FLOAT: minimum displayed velocity
    * - sunhitsImageConfig
      - STRUCT
-     - Structure defining the sun hits image.
+     - Structure defining the sun hits image. It shows the sun observables as a function of azimuth and elevation.  It can contain the following keys:
+
+       - dpi: INT: dpi of the output image
+       - xsize: FLOAT: width of the image in inches
+       - ysize: FLOAT: height of the image in inches
+       - azmin: FLOAT: minimum displayed azimuth angle
+       - azmax: FLOAT: minimum displayed azimuth angle
+       - elmin: FLOAT: minimum displayed elevation angle
+       - elmax: FLOAT: minimum displayed elevation angle
+       - azres: FLOAT: azimuth step to use in the plot
+       - elres: FLOAT: elevation step to use in the plot
    * - azPatternFile
      - STRING
      - Name of the azimuth pattern file of the antenna. This file and path must be ``<configpath>/antenna/<azPatternFile>``.

doc/source/userguide/usage.rst

@@ -8,13 +8,13 @@ Configuration files
 Pyrad uses 3 different configuration files which are typically stored in the folder::
 *pyrad/config/processing/*
 
-The first file specifies the input data, output data and configuration files packages, the second 
-specifies radar related parameters (radar name, scan name and frequency, etc.) and the general 
-configuration of the various image output, the last file specifies the datasets and products to be 
+The first file specifies the input data, output data and configuration files packages, the second
+specifies radar related parameters (radar name, scan name and frequency, etc.) and the general
+configuration of the various image output, the last file specifies the datasets and products to be
 produced.
 
-The easiest way to start is to copy one of the available config files and modify it according to your 
-needs. 
+The easiest way to start is to copy one of the available config files and modify it according to your
+needs.
 
 Examples of pyrad config files are available in the repository https://github.com/MeteoSwiss/pyrad-examples/.
 
@@ -27,7 +27,7 @@ To run the programs first you need to activate the conda pyrad environment::
         conda activate pyrad
 
 A number of script are available as executables. You can use them by simply typing::
-    
+
         [name_of_the_program] [arguments]
 
 At the moment there are three main programs:
@@ -36,9 +36,14 @@ main_process_data.py
     will process (and optionally post-process) data from a starting point in time to an ending point in time.
 
 main_process_data_period.py
-        will process (and optionally post-process) data over several days starting the processing at a given starting and ending time (default 00:00:00 for start and 23:59:59 for 
+        will process (and optionally post-process) data over several days starting the processing at a given starting and ending time (default 00:00:00 for start and 23:59:59 for
         the end).
 
 main_process_gecsx.py
-    will run the GECSX algorithm (visibility and clutter estimation from a DEM map) 
+    will run the GECSX algorithm (visibility and clutter estimation from a DEM map)
+
+Caching data
+---------------------------
 
+To avoid repeating multiple http requests, such as when retrieving radiosounding or geodata, pyrad caches some files. By default the cache directory is *$HOME/pyrad_cache*. It can be overriden
+by defining the environment variable $PYRAD_CACHE.

src/pyart

@@ -21,6 +21,7 @@
 import os
 from datetime import datetime
 from datetime import timedelta
+from datetime import timezone
 import gc
 import subprocess
 import queue
@@ -308,7 +309,7 @@ def main(
             bokeh_plot,
             filename=(
                 profile_path
-                + datetime.utcnow().strftime("%Y%m%d%H%M%S")
+                + datetime.now(timezone.utc).strftime("%Y%m%d%H%M%S")
                 + "_profile.png"
             ),
         )
@@ -376,7 +377,7 @@ def main_rt(
 
     # The processing will be allowed to run for a limited period
     if proc_finish is not None:
-        startime_proc = datetime.utcnow()
+        startime_proc = datetime.now(timezone.utc)
         # for offline testing
         # startime_proc = startime_proc.replace(
         #     year=endtime.year, month=endtime.month, day=endtime.day)
@@ -455,7 +456,7 @@ def main_rt(
             except queue.Empty:
                 pass
 
-        nowtime = datetime.utcnow()
+        nowtime = datetime.now(timezone.utc)
         # for offline testing
         # nowtime = nowtime.replace(
         #     year=endtime.year, month=endtime.month, day=endtime.day)
@@ -548,7 +549,7 @@ def main_rt(
 
             gc.collect()
 
-        nowtime_new = datetime.utcnow()
+        nowtime_new = datetime.now(timezone.utc)
         # for offline testing
         # nowtime_new = nowtime_new.replace(
         #     year=endtime.year, month=endtime.month, day=endtime.day)
@@ -742,7 +743,7 @@ def main_cosmo_rt(
 
     # The processing will be allowed to run for a limited period
     if proc_finish is not None:
-        startime_proc = datetime.utcnow()
+        startime_proc = datetime.now(timezone.utc)
         # for offline testing
         # startime_proc = startime_proc.replace(
         #     year=endtime.year, month=endtime.month, day=endtime.day)
@@ -821,7 +822,7 @@ def main_cosmo_rt(
             except queue.Empty:
                 pass
 
-        nowtime = datetime.utcnow()
+        nowtime = datetime.now(timezone.utc)
         # for offline testing
         # nowtime = nowtime.replace(
         #     year=endtime.year, month=endtime.month, day=endtime.day)
@@ -905,7 +906,7 @@ def main_cosmo_rt(
 
             gc.collect()
 
-        nowtime_new = datetime.utcnow()
+        nowtime_new = datetime.now(timezone.utc)
         # for offline testing
         # nowtime_new = nowtime_new.replace(
         #     year=endtime.year, month=endtime.month, day=endtime.day)
@@ -978,10 +979,10 @@ def main_gecsx(cfgfile, starttime=None, endtime=None, infostr="", gather_plots=T
     datacfg = _create_datacfg_dict(cfg)
 
     if starttime is None:
-        starttime = datetime.now()
+        starttime = datetime.now(timezone.utc)
         endtime = starttime
     if endtime is None:
-        endtime = datetime.now()
+        endtime = datetime.now(timezone.utc)
 
     if infostr:
         print("- Info string : {}".format(infostr))

src/pyrad_proc/pyrad/flow/flow_control.py

@@ -152,7 +152,7 @@ def plot_pos(
 
     if save_fig:
         for fname in fname_list:
-            fig.savefig(fname, dpi=dpi)
+            fig.savefig(fname, dpi=dpi, bbox_inches="tight")
         plt.close(fig)
 
         return fname_list
@@ -323,7 +323,7 @@ def plot_pos_map(
 
     if save_fig:
         for fname in fname_list:
-            fig.savefig(fname, dpi=dpi)
+            fig.savefig(fname, dpi=dpi, bbox_inches="tight")
         plt.close(fig)
 
         return fname_list
@@ -513,7 +513,7 @@ def plot_density(
     ax.grid()
 
     for fname in fname_list:
-        fig.savefig(fname, dpi=dpi)
+        fig.savefig(fname, dpi=dpi, bbox_inches="tight")
     plt.close(fig)
 
     return fname_list
@@ -633,7 +633,7 @@ def plot_scatter(
     fig.tight_layout()
 
     for fname in fname_list:
-        fig.savefig(fname, dpi=dpi)
+        fig.savefig(fname, dpi=dpi, bbox_inches="tight")
     plt.close(fig)
 
     return fname_list
@@ -728,7 +728,7 @@ def plot_centroids(
     fig.tight_layout()
 
     for fname in fname_list:
-        fig.savefig(fname, dpi=dpi)
+        fig.savefig(fname, dpi=dpi, bbox_inches="tight")
     plt.close(fig)
 
     return fname_list
@@ -784,7 +784,7 @@ def plot_quantiles(
     ax.grid()
 
     for fname in fname_list:
-        fig.savefig(fname, dpi=dpi)
+        fig.savefig(fname, dpi=dpi, bbox_inches="tight")
     plt.close(fig)
 
     return fname_list
@@ -845,7 +845,7 @@ def plot_histogram(
     fig.tight_layout()
 
     for fname in fname_list:
-        fig.savefig(fname, dpi=dpi)
+        fig.savefig(fname, dpi=dpi, bbox_inches="tight")
     plt.close(fig)
 
     return fname_list
@@ -927,7 +927,7 @@ def plot_histogram2(
 
     if save_fig:
         for fname in fname_list:
-            fig.savefig(fname, dpi=dpi)
+            fig.savefig(fname, dpi=dpi, bbox_inches="tight")
         plt.close(fig)
 
         return fname_list
@@ -1016,7 +1016,7 @@ def plot_antenna_pattern(
     fig.tight_layout()
 
     for fname in fname_list:
-        fig.savefig(fname, dpi=dpi)
+        fig.savefig(fname, dpi=dpi, bbox_inches="tight")
     plt.close(fig)
 
     return fname_list
@@ -1081,7 +1081,7 @@ def plot_selfconsistency(
 
     if save_fig:
         for fname in fname_list:
-            fig.savefig(fname, dpi=dpi)
+            fig.savefig(fname, dpi=dpi, bbox_inches="tight")
         plt.close(fig)
 
         return fname_list
@@ -1719,7 +1719,7 @@ def plot_scatter_comp(
 
     if save_fig:
         for fname in fname_list:
-            fig.savefig(fname, dpi=dpi)
+            fig.savefig(fname, dpi=dpi, bbox_inches="tight")
         plt.close(fig)
 
         return fname_list
@@ -1799,7 +1799,7 @@ def plot_sun_hits(field, field_name, fname_list, prdcfg):
     fig.tight_layout()
 
     for fname in fname_list:
-        fig.savefig(fname, dpi=dpi)
+        fig.savefig(fname, dpi=dpi, bbox_inches="tight")
     plt.close(fig)
 
     return fname_list
@@ -1916,7 +1916,7 @@ def _plot_sunscan(
 
     if save_fig:
         for fname in fname_list:
-            fig.savefig(fname, dpi=dpi)
+            fig.savefig(fname, dpi=dpi, bbox_inches="tight")
         plt.close(fig)
 
         return fname_list
@@ -2028,7 +2028,7 @@ def _plot_time_range(
 
     if save_fig:
         for fname in fname_list:
-            fig.savefig(fname, dpi=dpi)
+            fig.savefig(fname, dpi=dpi, bbox_inches="tight")
         plt.close(fig)
 
         return fname_list