added description for all config files

.gitignore

@@ -14,7 +14,6 @@ dist/
 downloads/
 eggs/
 .eggs/
-lib/
 lib64/
 parts/
 sdist/

binder/appendix.txt

@@ -1,5 +1,5 @@
 USER root
-RUN echo "export PYART_CONFIG=/home/jovyan/pyrad_config/mch_config.py" >> ~/.profile && \ 
+RUN echo "export PYART_CONFIG=/home/jovyan/pyrad_config/mf_config.py" >> ~/.profile && \ 
     echo "export METRANETLIB_PATH=/home/jovyan/lib/" >> ~/.profile && \
     rm -r /srv/conda/envs/notebook/lib/python3.9/site-packages/pyart_mch-1.8.1.dist-info/ && \
     rm -r /srv/conda/envs/notebook/lib/python3.9/site-packages/pyart && \

binder/environment.yml

@@ -13,6 +13,7 @@ dependencies:
   - pydda
   - pyart_mch
   - xradar
+  - pygrib
   - wradlib
   - sphinx=5.0
   - dask

environment.yml

@@ -13,6 +13,7 @@ dependencies:
   - pydda
   - pyart_mch
   - xradar
+  - pygrib
   - wradlib
   - sphinx=5.0
   - dask

notebooks/pyrad/description-config.ipynb

@@ -19,7 +19,10 @@
     "    - Plot along specific polar coordinates\n",
     "\n",
     "\n",
-    "**How to run** : *cd pyrad_config/00_plot_vol; main_process_data.py --cfgpath ./ --starttime 20230801000000 --endtime 20230802000000 jma_plot_vol.txt*\n",
+    "**How to run** \n",
+    " ```\n",
+    "cd pyrad_config/00_plot_vol; main_process_data.py --cfgpath ./ --starttime 20230801000000 --endtime 20230802000000 jma_plot_vol.txt\n",
+    " ```\n",
     "\n",
     "## 1 : Create a Cartesian grid and plot it (pyrad_config/01_grid)\n",
     "---\n",
@@ -35,39 +38,158 @@
     "    - Cross-section between two points\n",
     "\n",
     "\n",
-    "**How to run** : *cd pyrad_config/01_grid; main_process_data.py --cfgpath ./ --starttime 20230801000000 --endtime 20230802000000 jma_grid.txt*\n",
+    "**How to run** \n",
+    " ```\n",
+    "cd pyrad_config/01_grid; main_process_data.py --cfgpath ./ --starttime 20230801000000 --endtime 20230802000000 jma_grid.txt\n",
+    " ```\n",
     "\n",
-    "## 2 : Create a Cartesian grid and plot it (pyrad_config/01_grid)\n",
+    "## 2 : Ground-clutter removal (pyrad_config/02_clutter_filter)\n",
     "---\n",
     "   \n",
     "This pyrad configuration file does the following:\n",
-    "- Read polar reflectivity and RhoHV data from JMA\n",
-    "- Convert polar data to a Cartesian grid\n",
-    "- Perform a series of plots from the Cartesian data\n",
-    "    - Histogram plot\n",
-    "    - Surfaces at specified heights\n",
-    "    - Latitude slice\n",
-    "    - Longitude slice\n",
-    "    - Cross-section between two points\n",
+    "- Read polar data from MeteoFrance radar (Zh, RhoHV, ZDR, PhiDP)\n",
+    "- Use this data to detect ground-clutter\n",
+    "- Remove ground-clutter from the radar data\n",
+    "- Make PPI plots of filtered Zh, RhoHV, ZDR and PhiDP\n",
     "\n",
     "\n",
-    "**How to run** : *cd pyrad_config/01_grid; main_process_data.py --cfgpath ./ --starttime 20230801000000 --endtime 20230802000000 jma_grid.txt*\n",
+    "**How to run**\n",
+    "```\n",
+    " cd pyrad_config/02_clutter_filter; main_process_data.py --cfgpath ./ --starttime 20210114101500 --endtime 20210114120000 mf_pam_mtcy_filter.txt\n",
+    "```\n",
+    "\n",
+    "## 3 : Compute KDP (pyrad_config/03_phidp_kdp)\n",
+    "---\n",
+    "   \n",
+    "This pyrad configuration file does the following:\n",
+    "- Read polar data from MeteoFrance radar (Zh, RhoHV, ZDR, PhiDP)\n",
+    "- Read a GRIB iso0 height file from MeteoFrance\n",
+    "- Correct ground clutter as in 02_clutter_filter\n",
+    "- Perform smoothing of raw PhiDP\n",
+    "- Estimate KDP with different methods:\n",
+    "    - Vulpiani filtering method\n",
+    "    - Maesaka variational method\n",
+    "    - Linear programming method\n",
+    "    - Kalman filter method\n",
+    "    - Moving least-squares filter\n",
+    "- Perform attenuation correction\n",
+    "    - ZPHI method\n",
+    "    - Philinear method\n",
+    "- Perform PPI plots of KDP, attenuation corrected Zh, specific attenuation, PIA and PIDA\n",
+    "\n",
+    "\n",
+    "**How to run**\n",
+    " ```\n",
+    "cd pyrad_config/03_phidp_kdp; main_process_data.py --cfgpath ./ --starttime 20210114101500 --endtime 20210114120000 mf_pam_mtcy_kdp.txt\n",
+    " ```\n",
+    "\n",
+    "## 4 : Classifiy hydrometeors (pyrad_config/04_hydroclass)\n",
+    "---\n",
+    "   \n",
+    "This pyrad configuration file does the following:\n",
+    "- Read polar data from MeteoFrance radar (Zh, RhoHV, ZDR, PhiDP)\n",
+    "- Read a GRIB iso0 height file from MeteoFrance\n",
+    "- Compute hydrometeor classification\n",
+    "    - With semi-supervised method (Besic, 2016)\n",
+    "    - By mapping MeteoFrance operational classification\n",
+    "- Plot PPIs of hydrometeor classification\n",
     "\n",
     "\n",
-    "## 4 : KDP and specific attenuation (pyrad_config/04_attenuation)\n",
+    "**How to run**\n",
+    " ```\n",
+    " cd pyrad_config/04_hydroclass; main_process_data.py --cfgpath ./ --starttime 20200516200500 --endtime 20200516220000 mf_odim_coll_hydro.txt\n",
+    " ```\n",
+    "\n",
+    "## 5 : Melting layer detection(pyrad_config/05_ml)\n",
+    "---\n",
+    "   \n",
+    "This pyrad configuration file does the following:\n",
+    "- Read polar data from MeteoFrance radar (Zh, RhoHV, ZDR, PhiDP)\n",
+    "- Read a GRIB iso0 height file from MeteoFrance\n",
+    "- Compute melting layer (ML) extent\n",
+    "    - With Giangrande method\n",
+    "    - With MeteoFrance method\n",
+    "- Estimate VPR (vertical profile of reflectivity) with MeteoFrance algorithm\n",
+    "- Correct reflectivity with VPR\n",
+    "- Create relevant products\n",
+    "    - Timeseries of ML and VPR\n",
+    "    - PPIs of corrected reflectivity and ML extent overlaid on radar moments\n",
+    "    - Altitude plots of apparent VPR and theoretical VPR\n",
+    "\n",
+    "\n",
+    "**How to run**\n",
+    " ```\n",
+    " cd pyrad_config/05_ml; main_process_data.py --cfgpath ./ --starttime 20200516200500 --endtime 20200516220000 mf_odim_coll_ml.txt\n",
+    " ```\n",
+    "\n",
+    "## 6 : Quantitative precipitation estimation (pyrad_config/06_rr)\n",
+    "---\n",
+    "   \n",
+    "This pyrad configuration file does the following:\n",
+    "- Read polar data from MeteoFrance radar (Zh, RhoHV, ZDR, PhiDP)\n",
+    "- Read a GRIB iso0 height file from MeteoFrance\n",
+    "- Compute attenuation with ZPHI method\n",
+    "- Estimate precipitation with 4 methods\n",
+    "    - From Zh with R-Z relationship\n",
+    "    - From KDP with R-KDP relationship\n",
+    "    - From Ah (specific attenuation) with R-A relationship\n",
+    "    - From hydrometeor classification using different estimators for every class\n",
+    "- Compute rainfall accumulation over one hour\n",
+    "\n",
+    "**How to run**\n",
+    " ```\n",
+    " cd pyrad_config/06_rr; main_process_data.py --cfgpath ./ --starttime 20200516200500 --endtime 20200516220000 mf_odim_coll_rr.txt\n",
+    " ```\n",
+    "\n",
+    "## 7 : Compute velocity azimuth display (pyrad_config/07_VAD)\n",
     "---\n",
+    "   \n",
     "This pyrad configuration file does the following:\n",
-    "- Read raw radar data from one of the Swiss operational C-band radars\n",
-    "- Plot PPI of reflectivity\n",
-    "- Perform echo classification and filter clutter\n",
-    "- Estimate KDP with the Maesaka method\n",
-    "- Estimate the specific attenuation with the ZPHI method.\n",
-    "- Create PPI maps of KDP, corrected reflectivity and specific attenuation.\n",
+    "- Read Doppler data from MeteoFrance radar\n",
+    "- Compute velocity azimuth display (VAD) from Doppler velocity\n",
+    "- Plot and save (csv) vertical profiles of wind:\n",
+    "    - U,V,W wind components\n",
+    "    - Wind speed and direction\n",
     "\n",
     "\n",
-    "**How to run** : *cd pyrad_config/04_attenuation; main_process_data.py --cfgpath ./ --starttime  20220628072500 --endtime 20220628072500 attenuation.txt*\n",
+    "**How to run**\n",
+    " ```\n",
+    " cd pyrad_config/07_VAD; main_process_data.py --cfgpath ./ --starttime 20210114101500 --endtime 20210114120000 mf_pag_mtcy_doppler.txt\n",
+    " ```\n",
     "\n",
-    "## 11 : Radar visibility from a DEM with the GECSX tool (pyrad_config/11_visibility/)\n",
+    "## 8 : Compute dual-Doppler estimation (pyrad_config/08_DDA)\n",
+    "---\n",
+    "   \n",
+    "This pyrad configuration file does the following:\n",
+    "- Read polar data from MeteoSwiss C-band and X-band radar\n",
+    "- Perform ground clutter removal for X-band data\n",
+    "- Load C-band operational dealiased Doppler velocity\n",
+    "- Perform dual-Doppler estimation using the pyDDA wrapper with sounding data from wmo:06610 for initial conditions\n",
+    "- Generate plots:\n",
+    "    - 2D wind arrow maps at 1000, 2000 and 3000 m.a.s.l\n",
+    "    - Cross-sections of U,V and W wind components along runway 32 (RW32) of Zurich Airport\n",
+    "\n",
+    "**How to run**\n",
+    " ```\n",
+    " cd pyrad_config/08_DDA; main_process_data.py --cfgpath ./ --starttime 20210114101500 --endtime 20210114120000 mf_pag_mtcy_doppler.txt\n",
+    " ```\n",
+    "\n",
+    "## 9 : Quasi-vertical profiles (pyrad_config/09_QVP)\n",
+    "---\n",
+    "\n",
+    "This pyrad configuration file does the following:\n",
+    "- Perform timeseries of QVP profiles of Zh, ZDR, RHoHV and KDP data from MeteoFrance, using 4 QVP algorithms:\n",
+    "    - Original QVP algorithm [Ryzhkov et al. (2016)](https://journals.ametsoc.org/view/journals/atot/37/9/jtechD200011.xml#bib60)\n",
+    "    - Ranged-defined QVP [Tobin and Kumjian (2017)](https://journals.ametsoc.org/view/journals/atot/37/9/jtechD200011.xml#bib76)\n",
+    "    - Enhanced vertical profile [Bukovčić et al. (2017)](https://journals.ametsoc.org/view/journals/atot/37/9/jtechD200011.xml#bib10)\n",
+    "    - Slanted vertical profile [Bukovčić et al. (2017)](https://journals.ametsoc.org/view/journals/atot/37/9/jtechD200011.xml#bib10)\n",
+    "    \n",
+    "**How to run**\n",
+    " ```\n",
+    " cd pyrad_config/09_QVP; main_process_data.py --cfgpath ./ --starttime 20200516200500 --endtime 20200516220000 mf_odim_coll_qvp.txt\n",
+    " ```\n",
+    "\n",
+    "## 10 : Radar visibility from a DEM with the GECSX tool (pyrad_config/11_visibility/)\n",
     "---\n",
     "\n",
     "This pyrad configuration file does the following:\n",
@@ -76,9 +198,11 @@
     "- Create PPI plots of the clutter and the visibility\n",
     "- Create Grid map plots of several other products generated by GECSX (e.g. slope, aspect, min. visible elevation angle,...)\n",
     "\n",
-    "**How to run** : \n",
-    "- *cd pyrad_config/11_visibility/; main_process_gecsx.py --cfgpath ./ visibility_norad.txt* (no radar data)\n",
-    "- *cd pyrad_config/11_visibility/; main_process_gecsx.py --cfgpath ./ --starttime 20231127170000 --endtime 20231127180000 visibility.txt* (with radar data)"
+    "**How to run**\n",
+    " ```\n",
+    "cd pyrad_config/11_visibility/; main_process_gecsx.py --cfgpath ./ visibility_norad.txt # no radar data\n",
+    "cd pyrad_config/11_visibility/; main_process_gecsx.py --cfgpath ./ --starttime 20231127170000 --endtime 20231127180000 visibility.txt # with radar data\n",
+    " ```"
    ]
   }
  ],

pyrad_config/00_plot_vol/jma_plot_vol.txt

@@ -7,7 +7,7 @@
 
 # Name of this configuration:
 # Will be used in product generation save path
-name STRING PLOT_VOL
+name STRING 00_plot_vol
 
 # ---------------------------------------------------------
 #  Raw data pathes

pyrad_config/01_grid/jma_grid.txt

@@ -7,7 +7,7 @@
 
 # Name of this configuration:
 # Will be used in product generation save path
-name STRING GRID
+name STRING 01_grid
 
 # ---------------------------------------------------------
 #  Raw data pathes

pyrad_config/02_clutter_filter/mf_pam_mtcy_filter.txt

@@ -8,7 +8,7 @@
 
 # Name of this configuration:
 # Will be used in product generation save path
-name STRING MF_PAM_MTCY
+name STRING 02_clutter_filter
 
 # ---------------------------------------------------------
 #  Raw data pathes

pyrad_config/03_phidp_kdp/mf_pam_mtcy_kdp.txt

@@ -10,7 +10,7 @@
 
 # Name of this configuration:
 # Will be used in product generation save path
-name STRING MF_PAM_MTCY
+name STRING 03_phidp_kdp
 
 # ---------------------------------------------------------
 #  Raw data pathes

pyrad_config/03_phidp_kdp/mf_pam_mtcy_kdp_loc.txt

@@ -16,6 +16,9 @@ rmax FLOAT 100000.
 ScanList STRARR 1
       PAM_67_data_  # masterscan: first scan of a volume
 
+# Radar frequency
+frequency FLOAT 5.6E9
+
 # scan strategy      
 # cycle 1: 90/5  /2.2/1.2/0.7/0.4
 # cycle 2:  7/3.9/2.2/1.2/0.7/0.4