Skip to content

Commit

Permalink
DOC: Correct docstring for gradient_richardson_number
Browse files Browse the repository at this point in the history
Based on some reading, it doesn't seem like our implementation is
strictly equivalent to flux Richardson number, which seems to rely on
prototypical boundarly layer perturbations rather than gradients. To be
safe, let's just leave flux out of the docstring.
  • Loading branch information
dopplershift committed Aug 18, 2021
1 parent ed2f57b commit a5e8cb4
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/metpy/calc/thermo.py
Original file line number Diff line number Diff line change
Expand Up @@ -3323,7 +3323,7 @@ def k_index(pressure, temperature, dewpoint):
)
@check_units('[length]', '[temperature]', '[speed]', '[speed]')
def gradient_richardson_number(height, potential_temperature, u, v, vertical_dim=0):
r"""Calculate the gradient (or flux) Richardson number.
r"""Calculate the gradient Richardson number.
.. math:: Ri = \frac{g}{\theta} \frac{\left(\partial \theta/\partial z\right)}
{\left(\partial u / \partial z\right)^2 + \left(\partial v / \partial z\right)^2}
Expand Down

0 comments on commit a5e8cb4

Please sign in to comment.