Improving references of methods in Py-ART

[zssherman]

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)

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

pyart.retrieve (Max)

• [x] calculate_snr_from_reflectivity
• [x] composite_reflectivity
• [x] calculate_velocity_texture
• [x] compute_cdr
• [x] compute_l
• [x] compute_noisedBZ
• [x] compute_snr
• [x] conv_strat_yuter
• [x] dealias_spectra
• [x] est_rain_rate_a
• [x] 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
• [x] 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)

• [x] GateFilter
• [x] calculate_attenuation
• [ ] calculate_attenuation_philinear
• [x] calculate_attenuation_zphi
• [x] 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)

• [x] angular_mean
• [x] angular_mean_deg
• [x] angular_std
• [x] angular_std_deg
• [x] interval_mean
• [x] interval_std
• [x] mean_of_two_angles
• [x] mean_of_two_angles_deg
• [ ] for_azimuth
• [ ] get_column_rays
• [ ] get_field_location
• [ ] sphere_distance
• [x] datetime_from_dataset
• [x] datetime_from_grid
• [x] datetime_from_radar
• [x] estimate_noise_hs74
• [x] image_mute_radar
• [ ] is_vpt
• [ ] join_radar
• [ ] subset_radar
• [ ] to_vpt
• [ ] angular_texture_2d
• [ ] rolling_window
• [ ] texture
• [ ] texture_along_ray
• [ ] simulated_vel_from_profile
• [ ] cross_section_ppi
• [ ] cross_section_rhi