Improving references of methods in Py-ART

[zssherman]

trafficstars

Mentioned by users as well as digging through the code from years ago. Looking into adding better reference to journals etc to methods. Working on qpe methods at the moment.

[mgrover1]

Let's put a checklist together for this!

[mgrover1]

@zssherman are there any remaining references that need to be added?

[jrobrien91]

I can keep a list of missing/needed references as I go through PyART getting more familiar with the package.

[mgrover1]

@jrobrien91 could you share that list here? That would be super helpful!!

[zssherman]

@mgrover1 I'm not sure, alot of the older code I need to still go through. I opened this to kinda address them as they popped up as well.

[mgrover1]

Py-ART Reference Checklist

Here is a list of modules and associated references that are added or still need to be added

pyart.io (open)

• [ ] prepare_for_read
• [ ] read
• [ ] read_arm_sonde
• [ ] read_arm_sonde_vap
• [ ] read_cfradial
• [ ] read_chl
• [ ] read_grid
• [ ] read_grid_mdv
• [ ] read_mdv
• [x] read_nexrad_archive
• [x] read_nexrad_cdm
• [x] read_nexrad_level3
• [ ] read_rsl
• [ ] read_sigmet
• [ ] read_uf
• [ ] write_cfradial
• [ ] write_grid
• [ ] write_grid_geotiff
• [ ] write_grid_mdv
• [ ] write_uf

pyart.retrieve (Max)

• [ ] calculate_snr_from_reflectivity
• [x] composite_reflectivity
• [ ] calculate_velocity_texture
• [ ] compute_cdr
• [ ] compute_l
• [ ] compute_noisedBZ
• [ ] compute_snr
• [x] conv_strat_yuter
• [ ] dealias_spectra
• [x] est_rain_rate_a
• [ ] est_rain_rate_hydro
• [x] est_rain_rate_kdp (need to fix docstring)
• [x] est_rain_rate_z (need to fix docstring)
• [ ] est_rain_rate_za
• [ ] est_rain_rate_zkdp
• [x] est_rain_rate_zpoly (need DOI links)
• [ ] fetch_radar_time_profile
• [ ] get_freq_band
• [x] grid_displacement_pc
• [ ] grid_shift
• [x] hydroclass_semisupervised
• [x] kdp_maesaka
• [x] kdp_schneebeli
• [x] kdp_vulpiani
• [ ] map_profile_to_gates
• [x] quasi_vertical_profile
• [ ] spectra_moments
• [x] steiner_conv_strat
• [x] texture_of_complex_phase
• [x] vad_browning (need to fix docstring)
• [x] vad_michelson

pyart.correct (Joe)

• [ ] GateFilter
• [x] calculate_attenuation
• [ ] calculate_attenuation_philinear
• [x] calculate_attenuation_zphi
• [ ] correct_bias
• [x] correct_noise_rhohv
• [x] dealias_fourdd
• [ ] dealias_region_based
• [x] dealias_unwrap_phase
• [ ] despeckle_field
• [ ] find_objects
• [ ] moment_based_gate_filter
• [x] phase_proc_lp
• [x] phase_proc_lp_gf

pyart.util (Zach)

• [ ]