From 664865b552092c944a877db8e3644a0feaa9adbf Mon Sep 17 00:00:00 2001 From: Max Grover Date: Tue, 27 Aug 2024 14:52:22 -0500 Subject: [PATCH] Add more references (#1620) * ADD: Add reference for compute_cdf * ADD: Add reference for computations * ADD: Add qpe references --- pyart/retrieve/qpe.py | 6 ++++++ pyart/retrieve/simple_moment_calculations.py | 14 ++++++++++++++ 2 files changed, 20 insertions(+) diff --git a/pyart/retrieve/qpe.py b/pyart/retrieve/qpe.py index c657228d82..ad8b28856b 100644 --- a/pyart/retrieve/qpe.py +++ b/pyart/retrieve/qpe.py @@ -475,6 +475,12 @@ def est_rain_rate_hydro( rain : dict Field dictionary containing the rainfall rate. + References + ---------- + Besic, N., Figueras i Ventura, J., Grazioli, J., Gabella, M., Germann, U., and Berne, A.: Hydrometeor classification + through statistical clustering of polarimetric radar measurements: a semi-supervised approach, + Atmos. Meas. Tech., 9, 4425–4445, https://doi.org/10.5194/amt-9-4425-2016, 2016. + """ # parse the field parameters if refl_field is None: diff --git a/pyart/retrieve/simple_moment_calculations.py b/pyart/retrieve/simple_moment_calculations.py index 61beb2db04..0dfd32c629 100644 --- a/pyart/retrieve/simple_moment_calculations.py +++ b/pyart/retrieve/simple_moment_calculations.py @@ -165,6 +165,11 @@ def compute_l(radar, rhohv_field=None, l_field=None): l_field_out : dict L field. + References + ---------- + Ryzhkov, A. V., 2001: Interpretation of Polarimetric Radar Covariance Matrix for Meteorological Scatterers: Theoretical Analysis. + J. Atmos. Oceanic Technol., 18, 315–328, https://doi.org/10.1175/1520-0426(2001)018<0315:IOPRCM>2.0.CO;2. + """ # parse the field parameters if rhohv_field is None: @@ -191,6 +196,8 @@ def compute_cdr(radar, rhohv_field=None, zdr_field=None, cdr_field=None): """ Computes the Circular Depolarization Ratio. + + Parameters ---------- radar : Radar @@ -207,6 +214,13 @@ def compute_cdr(radar, rhohv_field=None, zdr_field=None, cdr_field=None): cdr : dict CDR field. + References + ---------- + Matrosov, S. Y., 2004: Depolarization Estimates from Linear H and V Measurements with Weather + Radars Operating in Simultaneous Transmission–Simultaneous Receiving Mode. + J. Atmos. Oceanic Technol., 21, 574–583, + https://doi.org/10.1175/1520-0426(2004)021<0574:DEFLHA>2.0.CO;2. + """ # parse the field parameters if rhohv_field is None: