ENH: updated doc to account for changes in pyrad 2.0.0

doc/source/overview/list_datadescriptors.rst

@@ -214,6 +214,9 @@ usage
 	where 
 		- datatype is a pyrad variable name as listed `here <https://github.com/MeteoSwiss/pyrad/blob/master/doc/source/overview/list_variables.rst>`_
 		- dataset is an optional descriptor used to describe where the data is stored, it has the format "*D{time_descr_folder}-F{time_descr_file}*", where *time_descr_folder* is a datetime descriptor used to name the parent directory of the radar files, and *time_descr_file* is a datetime descriptor used to name the radar files. *time_descr_folder* can be left empty if wanted.
+
+	The ODIM reader and all similar readers (e.g. CFRADIAL) assume that the names within the files are the `standard names <https://meteoswiss.github.io/pyrad/overview/list_variables.html>`_. If this is not the case, you can use the structure `DataTypeIDInFiles <https://meteoswiss.github.io/pyrad/overview/loc.html>`_ in the loc files to provide explicitely the mapping between the pyrad variable names and the variable names within your files.
+
 example
 	*ODIM:ZDR,D{%Y%m%d}-F{%Y%m%d%H%M00}* will attempt to read the differential reflectivity from the h5 file located under *datapath/ScanList/day_dir/filename* where *datapath* and *ScanList* are as defined in the main and loc configuration files and *day_dir* contains the datetime format string *%Y%m%d* and filename contains the datetime format *%Y%m%d%H%M00*.
 
@@ -335,7 +338,7 @@ COSMO
 
 description
 	Reads data from the COSMO model, previously ingested by pyrad and converted to polar coordinates with the `COSMO_LOOKUP dataset <https://meteoswiss.github.io/pyrad/_modules/pyrad/proc/process_cosmo.html#process_cosmo_lookup_table>`_.
-	For this to work you will need to define the variable *cosmopath* in the main pyrad configuration file.
+	For this to work you will need to define the variable *iconpath* in the main pyrad configuration file.
 
 
 usage
@@ -600,14 +603,17 @@ usage
 MFCFRADIAL
 ----------------------------- 
 
+.. warning::
+	MFCFRADIAL is deprecated since pyrad 2.0.0, please use CFRADIAL with path_convention=ODIM and specify the struct DataTypeIDInFiles in the loc file instead.
+
+
 description
 	Used to read radar data from MeteoFrance written in CFRadial
-				
+
 usage
 	*MFCFRADIAL:datatype,dataset* 
 	See the data descriptor *ODIM* for usage info as it works exactly in the same way.
-example
-	::
+
 
 
 -------------------------------------
@@ -724,6 +730,4 @@ example
 					type STRING HISTOGRAM
 					voltype STRING prec_type
 					binwidth_equal INT 1
-					write_data INT 1
-
-					
+					write_data INT 1

doc/source/overview/loc.rst

@@ -12,6 +12,14 @@ Name                  Type     Description
 RadarName             STRING   Short version name of a C-band radar (i.e., A, D, L, P) or DX50, MXPol for the X-band radars.
 RadarRes              STRING   rad4alp radar resolution (H or L). Only necessary if rad4alp (swiss C-band) data is processed.
 RadarBeamwidth        FLOAT    Radar antenna beam width [Deg].
+DataTypeIDInFiles     STRUCT   Structure of strings defining the mapping between pyrad names and variable names in input files. If not provided it will be expected that the name in the files are the standard py-ART names (defined in the py-ART config file). An example of such a struct could be:
+- dBZ                 STRING   DBZ
+- ZDR                 STRING   ZDR
+- RhoHV               STRING   RHOHV
+- PhiDP               STRING   PHIDP
+- KDP                 STRING   KDP
+- V                   STRING   VEL
+- W                   STRING   WIDTH
 AntennaGaindB         FLOAT    Antenna gain [dB].
 ScanList              STRARR   A list with the scans used for this data processing. Note that the first scan in this list is used as master scan. The master scan must be the first (temporal) scan of the corresponding rainbow task. In case of composite volumes the master scan is usually a PPI and the following are RHIs. If the radar processed is MCH C-band the scan list consists of the radar elevation (i.e., from 001 to 020). All scan names must have a trailing '/' except if rad4alp data is processed.
 ScanPeriod            FLOAT    Repetition period of each scan in minutes.
@@ -21,8 +29,8 @@ AntennaGain           FLOAT    Radar antenna gain. Not used for X-band MCH data.
 radarconsth(v)        FLOAT    Radar constant h (v). Not mandatory.
 mflossh(v)            FLOAT    Matched filter losses h (v). Not mandatory.
 attg                  FLOAT    Gas attenuation coefficient (units? (1 way attenuation)).
-CosmoRunFreq          INT      Frequency of a COSMO model run in hours.
-CosmoForecasted       INT      Hours forecasted by the COSMO model.
+IconRunFreq           INT      Frequency of a Icon model run in hours.
+IconForecasted        INT      Hours forecasted by the Icon model.
 rmax                  FLOAT    For C-band data, the maximum range in [m] to be considered. Useful for speed considerations.
 elmax                 FLOAT    Maximum elevation [°] to consider.
 ppiImageConfig        STRUCT   Structure defining the PPI image generating (PPI_IMAGE or PSEUDOPPI_IMAGE products). The following 6 fields are described below:
@@ -40,7 +48,7 @@ rhiImageConfig        STRUCT   Structure defining the RHI image generating (RHI_
 - xmax                FLOAT    Distance of the right image boundary to the radar in km.
 - ymin                FLOAT    Distance of the lower image boundary (vertical direction) to the radar in km.
 - ymax                FLOAT    Distance of the upper image boundary (vertical direction) to the radar in km.
-- dpi		      INT      Resolution of the image in dots per inch.
+- dpi		          INT      Resolution of the image in dots per inch.
 ppiMapImageConfig     STRUCT   Structure defining the PPI image overlaid on a map (PPI_MAP product). The following 9 fields are described below:
 - rngRing             FLOAT    Distance between range rings (0 means no range ring) [km].
 - xsize               FLOAT    Image size (inches) [inch].
@@ -55,7 +63,7 @@ ppiMapImageConfig     STRUCT   Structure defining the PPI image overlaid on a ma
 - mapres              STRING   Map resolution. Accepted strings are: “10m”, “50m”, “110m”.
 - maps                STRARR   String array of possible maps to overplot. Accepted entries include: relief, countries, provinces, 
                                  urban_areas, roads, railroads, coastline, lakes, lakes_europe, rivers, rivers_europe.
-- dpi		      INT      Resolution of the image in dots per inch.
+- dpi		          INT      Resolution of the image in dots per inch.
 gridMapImageConfig    STRUCT   Structure defining the display of gridded data overlaid on a map (SURFACE_IMAGE product).
 - xsize               FLOAT    Image size (inches) [inch].
 - ysize               FLOAT    Image size (inches) [inch].
@@ -69,7 +77,7 @@ gridMapImageConfig    STRUCT   Structure defining the display of gridded data ov
 - mapres              STRING   Map resolution. Accepted strings are: “10m”, “50m”, “110m”.
 - maps                STRARR   String array of possible maps to overplot. Accepted entries include: relief, countries, provinces, 
                                urban_areas, roads, railroads, coastline, lakes, lakes_europe, rivers, rivers_europe
-- dpi		      INT      Resolution of the image in dots per inch.
+- dpi		          INT      Resolution of the image in dots per inch.
 xsecImageConfig       STRUCT   Structure defining the cross-section images generated from gridded data (CROSS_SECTION, LATITUDE_SLICE and LONGITUDE_SLICE products)
 - xsize               INT      Number of horizontal pixels of the picture (without frame).
 - ysize               INT      Number of vertical pixels of the picture (without frame).