FIX: wrong docstring for voltype

MeteoSwiss · Sep 30, 2024 · db0f74d · db0f74d
1 parent 869fdb7
commit db0f74d
Show file tree

Hide file tree

Showing 6 changed files with 86 additions and 86 deletions.
diff --git a/src/pyrad_proc/pyrad/prod/process_grid_products.py b/src/pyrad_proc/pyrad/prod/process_grid_products.py
@@ -160,17 +160,17 @@ def generate_grid_products(dataset, prdcfg):
  generates grid products. Accepted product types:
  'CROSS_SECTION': Plots a cross-section of gridded data
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  coord1, coord2: dict
  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
  'loc' configuration file
  'HISTOGRAM': Computes a histogram of the radar volum data
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  step: float or None
  the data quantization step. If none it will be obtained
  from the Py-ART configuration file
@@ -184,17 +184,17 @@ def generate_grid_products(dataset, prdcfg):
  'LATITUDE_SLICE': Plots a cross-section of gridded data over a
  constant latitude.
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  lon, lat: floats
  The starting point of the cross-section. The ending point
  is defined by the parameters in 'xsecImageConfig' in the
  'loc' configuration file
  'LONGITUDE_SLICE': Plots a cross-ection of gridded data over a
  constant longitude.
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  lon, lat: floats
  The starting point of the cross-section. The ending point
  is defined by the parameters in 'xsecImageConfig' in the
@@ -209,8 +209,8 @@ def generate_grid_products(dataset, prdcfg):
  dataset, as there is no ambiguity with SAVEALL for VOL datasets
  'SAVEVOL': Saves on field of a gridded data object in a netcdf file.
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  file_type: str
  The type of file used to save the data. Can be 'nc' or
  'h5'. Default 'nc'
@@ -231,31 +231,31 @@ def generate_grid_products(dataset, prdcfg):
  'STATS': Computes statistics over the whole images and stores them in
  a file.
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  stat: str
  The statistic used. Can be mean, median, min, max
  'SURFACE_RAW': Plots a surface image of gridded data without
  projecting it into a map
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  level: int
  The altitude level to plot. The rest of the parameters are
  defined by the parameters in 'ppiImageConfig' and
  'ppiMapImageConfig' in the 'loc' configuration file
  'SURFACE_IMAGE': Plots a surface image of gridded data.
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  level: int
  The altitude level to plot. The rest of the parameters are
  defined by the parameters in 'ppiImageConfig' and
  'ppiMapImageConfig' in the 'loc' configuration file
  'SURFACE_CONTOUR': Plots a surface image of contour gridded data.
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  level: int
  The altitude level to plot. The rest of the parameters are
  defined by the parameters in 'ppiImageConfig' and
@@ -273,8 +273,8 @@ def generate_grid_products(dataset, prdcfg):
  'SURFACE_CONTOUR_OVERPLOT':
  Plots a surface image of gridded data with a contour overplotted.
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  level: int
  The altitude level to plot. The rest of the parameters are
  defined by the parameters in 'ppiImageConfig' and
@@ -292,8 +292,8 @@ def generate_grid_products(dataset, prdcfg):
  'SURFACE_OVERPLOT':
  Plots on the same surface two images, one on top of the other.
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  level: int
  The altitude level to plot. The rest of the parameters are
  defined by the parameters in 'ppiImageConfig' and
@@ -308,8 +308,8 @@ def generate_grid_products(dataset, prdcfg):
  Plots horizontal wind vectors obtained from a DDA analysis on a 2D map. 
  The pyDDA package is required
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  level: int
  The altitude level to plot. The rest of the parameters are
  defined by the parameters in 'ppiImageConfig' and
@@ -346,8 +346,8 @@ def generate_grid_products(dataset, prdcfg):
  along a given longitude
  The pyDDA package is required
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  level: int
  The longitude level to plot. The rest of the parameters are
  defined by the parameters in 'xsecImageConfig' in the 'loc' 
@@ -384,8 +384,8 @@ def generate_grid_products(dataset, prdcfg):
  along a given latitude
  The pyDDA package is required
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  level: int
  The latitude level to plot. The rest of the parameters are
  defined by the parameters in 'xsecImageConfig' in the 'loc' 

diff --git a/src/pyrad_proc/pyrad/prod/process_intercomp_products.py b/src/pyrad_proc/pyrad/prod/process_intercomp_products.py
@@ -42,8 +42,8 @@ def generate_intercomp_products(dataset, prdcfg):
  intercomparison in a file and plots the time series of the
  statistics.
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  add_date_in_fname: Bool
  If true adds the year in the csv file containing the
  statistics. Default False
@@ -67,8 +67,8 @@ def generate_intercomp_products(dataset, prdcfg):
  'PLOT_SCATTER_INTERCOMP': Plots a density plot with the points of
  radar 1 versus the points of radar 2
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  step: float
  The quantization step of the data. If none it will be
  computed using the Py-ART config file. Default None
@@ -79,13 +79,13 @@ def generate_intercomp_products(dataset, prdcfg):
  'WRITE_INTERCOMP': Writes the instantaneously intercompared data
  (gate positions, values, etc.) in a csv file.
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  'WRITE_INTERCOMP_TIME_AVG': Writes the time-averaged intercompared
  data (gate positions, values, etc.) in a csv file.
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
 
  Parameters
  ----------

diff --git a/src/pyrad_proc/pyrad/prod/process_monitoring_products.py b/src/pyrad_proc/pyrad/prod/process_monitoring_products.py
@@ -47,8 +47,8 @@ def generate_monitoring_products(dataset, prdcfg):
  in the Y-axis. The reference values and the user defined quantiles
  are also plot on the same figure
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  anglenr: int
  The elevation angle number to plot
  quantiles: list of floats
@@ -61,8 +61,8 @@ def generate_monitoring_products(dataset, prdcfg):
  'CUMUL_VOL_TS': Plots time series of the average of instantaneous
  quantiles stored in a csv file.
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  quantiles: list of 3 floats
  the quantiles to compute. Default 25., 50., 75.
  ref_value: float
@@ -110,8 +110,8 @@ def generate_monitoring_products(dataset, prdcfg):
  'PPI_HISTOGRAM': Plots a histogram of data at a particular
  elevation angle.
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  anglenr: int
  The elevation angle number to plot
  'SAVEVOL': Saves the monitoring data in a C/F radar file. The data
@@ -120,16 +120,16 @@ def generate_monitoring_products(dataset, prdcfg):
  'VOL_HISTOGRAM': Plots a histogram of data collected from all the
  radar volume.
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  write_data: bool
  If true the resultant histogram is also saved in a csv
  file. Default True.
  'VOL_TS': Computes statistics of the gathered data and writes them in
  a csv file and plots a time series of those statistics.
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  quantiles: list of 3 floats
  the quantiles to compute. Default 25., 50., 75.
  ref_value: float

diff --git a/src/pyrad_proc/pyrad/prod/process_product.py b/src/pyrad_proc/pyrad/prod/process_product.py
@@ -66,8 +66,8 @@ def generate_occurrence_products(dataset, prdcfg):
  with clutter that has a frequency of occurrence above a certain
  threshold.
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  quant_min: float
  Minimum frequency of occurrence in percentage to keep the
  gate as valid. Default 95.
@@ -368,18 +368,18 @@ def generate_sun_hits_products(dataset, prdcfg):
  elevation difference grid the values of all sun hits obtained
  during the processing period
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  'PLOT_SUN_RETRIEVAL': Plots in a sun-radar azimuth difference-sun-
  radar elevation difference grid the retrieved sun pattern
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  'PLOT_SUN_RETRIEVAL_TS': Plots time series of the retrieved sun
  pattern parameters
  User defined parameters:
- voltype: name of the pyrad variable to use, it must be available
- in the dataset
+ voltype: str
+ name of the pyrad variable to use, it must be available in the dataset in the dataset
  dpi: int
  The pixel density of the plot. Default 72
  add_date_in_fname: Bool