Skip to content

Commit

Permalink
DOCS: Add more documentation on adding frequency for hydroclass (#1563)
Browse files Browse the repository at this point in the history
* ENH:Docs:hydroclass

* Fix:linting
  • Loading branch information
RBhupi authored Apr 16, 2024
1 parent 77830b6 commit db95df7
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions pyart/retrieve/echo_class.py
Original file line number Diff line number Diff line change
Expand Up @@ -647,6 +647,21 @@ def hydroclass_semisupervised(
of polarimetric radar measurements: a semi-supervised approach,
Atmos. Meas. Tech., 9, 4425-4445, doi:10.5194/amt-9-4425-2016, 2016
Notes
-----
The default hydrometeor classification is valid for C-band radars. For X-band radars,
if frequency information is not present in the `radar.instrument_parameters`, a warning that the
algorithm is defaulting to the C band is printed.
If the radar frequency information is missing from the radar object, you can add it in
`radar.instrument_parameters`, as follows:
.. code-block:: python
radar.instrument_parameters["frequency"] = {
"long_name": "Radar frequency",
"units": "Hz",
"data": [9.2e9]
}
"""
lapse_rate = -6.5

Expand Down

0 comments on commit db95df7

Please sign in to comment.