Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improving references of methods in Py-ART #1042

Open
zssherman opened this issue Mar 1, 2022 · 6 comments
Open

Improving references of methods in Py-ART #1042

zssherman opened this issue Mar 1, 2022 · 6 comments

Comments

@zssherman
Copy link
Collaborator

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
Copy link
Collaborator

mgrover1 commented Mar 1, 2022

Let's put a checklist together for this!

@mgrover1
Copy link
Collaborator

mgrover1 commented Mar 8, 2022

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

@jrobrien91
Copy link
Collaborator

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

@mgrover1
Copy link
Collaborator

mgrover1 commented Mar 8, 2022

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

@zssherman
Copy link
Collaborator Author

@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
Copy link
Collaborator

mgrover1 commented Nov 22, 2022

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
  • read_nexrad_archive
  • read_nexrad_cdm
  • 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
  • composite_reflectivity
  • calculate_velocity_texture
  • compute_cdr
  • compute_l
  • compute_noisedBZ
  • compute_snr
  • conv_strat_yuter
  • dealias_spectra
  • est_rain_rate_a
  • est_rain_rate_hydro
  • est_rain_rate_kdp (need to fix docstring)
  • est_rain_rate_z (need to fix docstring)
  • est_rain_rate_za
  • est_rain_rate_zkdp
  • est_rain_rate_zpoly (need DOI links)
  • fetch_radar_time_profile
  • get_freq_band
  • grid_displacement_pc
  • grid_shift
  • hydroclass_semisupervised
  • kdp_maesaka
  • kdp_schneebeli
  • kdp_vulpiani
  • map_profile_to_gates
  • quasi_vertical_profile
  • spectra_moments
  • steiner_conv_strat
  • texture_of_complex_phase
  • vad_browning (need to fix docstring)
  • vad_michelson

pyart.correct (Joe)

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

pyart.util (Zach)

  • angular_mean
  • angular_mean_deg
  • angular_std
  • angular_std_deg
  • interval_mean
  • interval_std
  • mean_of_two_angles
  • mean_of_two_angles_deg
  • for_azimuth
  • get_column_rays
  • get_field_location
  • sphere_distance
  • datetime_from_dataset
  • datetime_from_grid
  • datetime_from_radar
  • estimate_noise_hs74
  • 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants