diff --git a/src/metpy/calc/kinematics.py b/src/metpy/calc/kinematics.py index 73f8d7a64c..6d3725f550 100644 --- a/src/metpy/calc/kinematics.py +++ b/src/metpy/calc/kinematics.py @@ -1266,7 +1266,8 @@ def inertial_advective_wind( broadcast=('u', 'v', 'temperature', 'pressure', 'static_stability', 'parallel_scale', 'meridional_scale') ) -@check_units('[speed]', '[speed]', '[temperature]', '[pressure]', '[length]', '[length]') +@check_units('[speed]', '[speed]', '[temperature]', '[pressure]', '[length]', '[length]', + '[energy] / [mass] / [pressure]**2') def q_vector( u, v, @@ -1298,6 +1299,12 @@ def q_vector( - 2 \nabla_p \cdot \vec{Q} - \frac{R}{\sigma p} \beta \frac{\partial T}{\partial x} + By default, this function uses a unitless value of 1 for ``static_stability``, which + replicates the functionality of the GEMPAK ``QVEC`` function. If a value is given for + ``static_stability, it should have dimensionality of ``energy / mass / pressure^2``, and + will result in behavior that matches that of GEMPAK's ``QVCL`` function; + `static_stability` can be used to calculate this value if desired. + Parameters ---------- u : (..., M, N) `xarray.DataArray` or `pint.Quantity`