u (xarray.DataArray
) – The input DataArray of the x-component (in terms of data projection) of the wind.
v (xarray.DataArray
) – The input DataArray of the y-component (in terms of data projection) of the wind.
u (xarray.DataArray
) – The input DataArray of the x-component (in terms of data projection) of the wind.
v (xarray.DataArray
) – The input DataArray of the y-component (in terms of data projection) of the wind.
index (str or int, optional) – Denotes the index coordinate of the cross-section, defaults to ‘index’ as
set by metpy.interpolate.cross_section
absolute_momentum (xarray.DataArray
) – Absolute momentum
absolute_momentum (xarray.DataArray
) – Absolute momentum
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the wind
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the wind
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the wind
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the wind
dx (pint.Quantity
, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
dy (pint.Quantity
, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
latitude (pint.Quantity
, optional) – Latitude of the wind data. Optional if xarray.DataArray
with latitude/longitude
+
latitude (pint.Quantity
, optional) – Latitude of the wind data. Optional if xarray.DataArray
with latitude/longitude
coordinates used as input. Note that an argument without units is treated as
dimensionless, which translates to radians.
x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
xarray.DataArray
.
y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
+parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
+
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
+
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
(…, M, N) xarray.DataArray
or pint.Quantity
– absolute vorticity
(…, M, N) xarray.DataArray
or pint.Quantity
– absolute vorticity
Calculate the advection of a scalar field by 1D, 2D, or 3D winds.
-If scalar
is a xarray.DataArray
, only u
, v
, and/or w
are required
+
If scalar
is a xarray.DataArray
, only u
, v
, and/or w
are required
to compute advection. The horizontal and vertical spacing (dx
, dy
, and dz
)
and axis numbers (x_dim
, y_dim
, and z_dim
) are automatically inferred from
scalar
. But if scalar
is a pint.Quantity
, the horizontal and vertical
@@ -754,17 +754,17 @@
meridional_scale
specify the parallel and meridional scale of
map projection at data coordinate, respectively. They are optional when (a)
-xarray.DataArray
with latitude/longitude coordinates and MetPy CRS are used as input
+xarray.DataArray
with latitude/longitude coordinates and MetPy CRS are used as input
or (b) longitude, latitude, and crs are given. If otherwise omitted, calculation
will be carried out on a Cartesian, rather than geospatial, grid. Both are keyword-only
arguments.
scalar (pint.Quantity
or xarray.DataArray
) – The quantity (an N-dimensional array) to be advected.
u (pint.Quantity
or xarray.DataArray
or None) – The wind component in the x dimension. An N-dimensional array.
v (pint.Quantity
or xarray.DataArray
or None) – The wind component in the y dimension. An N-dimensional array.
w (pint.Quantity
or xarray.DataArray
or None) – The wind component in the z dimension. An N-dimensional array.
scalar (pint.Quantity
or xarray.DataArray
) – The quantity (an N-dimensional array) to be advected.
u (pint.Quantity
or xarray.DataArray
or None) – The wind component in the x dimension. An N-dimensional array.
v (pint.Quantity
or xarray.DataArray
or None) – The wind component in the y dimension. An N-dimensional array.
w (pint.Quantity
or xarray.DataArray
or None) – The wind component in the z dimension. An N-dimensional array.
dx (pint.Quantity
or None, optional) – Grid spacing in the x dimension.
dy (pint.Quantity
or None, optional) – Grid spacing in the y dimension.
dz (pint.Quantity
or None, optional) – Grid spacing in the z dimension.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate.
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate.
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
+
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
pint.Quantity
or xarray.DataArray
– An N-dimensional array containing the advection at all grid points.
pint.Quantity
or xarray.DataArray
– An N-dimensional array containing the advection at all grid points.
Notes
diff --git a/dev/api/generated/metpy.calc.ageostrophic_wind.html b/dev/api/generated/metpy.calc.ageostrophic_wind.html index a7742b2c847..e904c373a5d 100644 --- a/dev/api/generated/metpy.calc.ageostrophic_wind.html +++ b/dev/api/generated/metpy.calc.ageostrophic_wind.html @@ -75,7 +75,7 @@ - + @@ -745,36 +745,36 @@height ((M, N) xarray.DataArray
or pint.Quantity
) – The height or geopotential field.
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – The u wind field.
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – The u wind field.
height ((M, N) xarray.DataArray
or pint.Quantity
) – The height or geopotential field.
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – The u wind field.
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – The u wind field.
dx (pint.Quantity
, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
dy (pint.Quantity
, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
latitude (xarray.DataArray
or pint.Quantity
) – The latitude, which is used to calculate the Coriolis parameter. Its dimensions must
-be broadcastable with those of height. Optional if xarray.DataArray
with latitude
+
latitude (xarray.DataArray
or pint.Quantity
) – The latitude, which is used to calculate the Coriolis parameter. Its dimensions must
+be broadcastable with those of height. Optional if xarray.DataArray
with latitude
coordinate used as input. Note that an argument without units is treated as
dimensionless, which is equivalent to radians.
x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
xarray.DataArray
.
y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
+parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
+
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
+
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
height (xarray.DataArray
or pint.Quantity
) – Atmospheric (geopotential) height
potential_temperature (xarray.DataArray
or pint.Quantity
) – Atmospheric potential temperature
height (xarray.DataArray
or pint.Quantity
) – Atmospheric (geopotential) height
potential_temperature (xarray.DataArray
or pint.Quantity
) – Atmospheric potential temperature
vertical_dim (int, optional) – The axis corresponding to vertical in the potential temperature array, defaults to 0,
-unless height and potential_temperature
given as xarray.DataArray
, in which case
+unless height and potential_temperature
given as xarray.DataArray
, in which case
it is automatically determined from the coordinate metadata.
pint.Quantity
or xarray.DataArray
– Brunt-Vaisala frequency. Given as pint.Quantity
, unless both
-height and potential_temperature
arguments are given as xarray.DataArray
, in
-which case will be xarray.DataArray
.
pint.Quantity
or xarray.DataArray
– Brunt-Vaisala frequency. Given as pint.Quantity
, unless both
+height and potential_temperature
arguments are given as xarray.DataArray
, in
+which case will be xarray.DataArray
.
height (xarray.DataArray
or pint.Quantity
) – Atmospheric (geopotential) height
potential_temperature (xarray.DataArray
or pint.Quantity
) – Atmospheric potential temperature
height (xarray.DataArray
or pint.Quantity
) – Atmospheric (geopotential) height
potential_temperature (xarray.DataArray
or pint.Quantity
) – Atmospheric potential temperature
vertical_dim (int, optional) – The axis corresponding to vertical in the potential temperature array, defaults to 0,
-unless height and potential_temperature
given as xarray.DataArray
, in which case
+unless height and potential_temperature
given as xarray.DataArray
, in which case
it is automatically determined from the coordinate metadata.
pint.Quantity
or xarray.DataArray
– The square of the Brunt-Vaisala frequency. Given as pint.Quantity
, unless both
-height and potential_temperature
arguments are given as xarray.DataArray
, in
-which case will be xarray.DataArray
.
pint.Quantity
or xarray.DataArray
– The square of the Brunt-Vaisala frequency. Given as pint.Quantity
, unless both
+height and potential_temperature
arguments are given as xarray.DataArray
, in
+which case will be xarray.DataArray
.
height (xarray.DataArray
or pint.Quantity
) – Atmospheric (geopotential) height
potential_temperature (xarray.DataArray
or pint.Quantity
) – Atmospheric potential temperature
height (xarray.DataArray
or pint.Quantity
) – Atmospheric (geopotential) height
potential_temperature (xarray.DataArray
or pint.Quantity
) – Atmospheric potential temperature
vertical_dim (int, optional) – The axis corresponding to vertical in the potential temperature array, defaults to 0,
-unless height and potential_temperature
given as xarray.DataArray
, in which case
+unless height and potential_temperature
given as xarray.DataArray
, in which case
it is automatically determined from the coordinate metadata.
pint.Quantity
or xarray.DataArray
– Brunt-Vaisala period. Given as pint.Quantity
, unless both
-height and potential_temperature
arguments are given as xarray.DataArray
, in
-which case will be xarray.DataArray
.
pint.Quantity
or xarray.DataArray
– Brunt-Vaisala period. Given as pint.Quantity
, unless both
+height and potential_temperature
arguments are given as xarray.DataArray
, in
+which case will be xarray.DataArray
.
data_x (xarray.DataArray
) – The input DataArray of the x-component (in terms of data projection) of the vector
+
data_x (xarray.DataArray
) – The input DataArray of the x-component (in terms of data projection) of the vector
field.
data_y (xarray.DataArray
) – The input DataArray of the y-component (in terms of data projection) of the vector
+
data_y (xarray.DataArray
) – The input DataArray of the y-component (in terms of data projection) of the vector
field.
index (str or int, optional) – Denotes the index coordinate of the cross-section, defaults to ‘index’ as
set by metpy.interpolate.cross_section
component_tangential, component_normal (tuple of xarray.DataArray
) – Components of the vector field in the tangential and normal directions, respectively
component_tangential, component_normal (tuple of xarray.DataArray
) – Components of the vector field in the tangential and normal directions, respectively
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the vector
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the vector
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the vector
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the vector
dx (pint.Quantity
, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input. Keyword-only argument.
dy (pint.Quantity
, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input. Keyword-only argument.
x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
. Keyword-only argument.
xarray.DataArray
. Keyword-only argument.
y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
. Keyword-only argument.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
+parsed from input if using xarray.DataArray
. Keyword-only argument.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
+
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
+
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
(…, M, N) xarray.DataArray
or pint.Quantity
– The horizontal divergence
(…, M, N) xarray.DataArray
or pint.Quantity
– The horizontal divergence
This function implicitly converts xarray.DataArray
to pint.Quantity
, with the results
+
This function implicitly converts xarray.DataArray
to pint.Quantity
, with the results
given as pint.Quantity
.
Calculate the first derivative of a grid of values.
Works for both regularly-spaced data and grids with varying spacing.
-Either x or delta must be specified, or f must be given as an xarray.DataArray
with
-attached coordinate and projection information. If f is an xarray.DataArray
, and x or
+
Either x or delta must be specified, or f must be given as an xarray.DataArray
with
+attached coordinate and projection information. If f is an xarray.DataArray
, and x or
delta are given, f will be converted to a pint.Quantity
and the derivative returned
as a pint.Quantity
, otherwise, if neither x nor delta are given, the attached
coordinate information belonging to axis will be used and the derivative will be returned
-as an xarray.DataArray
.
xarray.DataArray
.
This uses 3 points to calculate the derivative, using forward or backward at the edges of the grid as appropriate, and centered elsewhere. The irregular spacing is handled explicitly, using the formulation as specified by [Bowen2005].
diff --git a/dev/api/generated/metpy.calc.friction_velocity.html b/dev/api/generated/metpy.calc.friction_velocity.html index 827e9bbb0c5..57b6730c7b2 100644 --- a/dev/api/generated/metpy.calc.friction_velocity.html +++ b/dev/api/generated/metpy.calc.friction_velocity.html @@ -76,7 +76,7 @@ - + diff --git a/dev/api/generated/metpy.calc.frontogenesis.html b/dev/api/generated/metpy.calc.frontogenesis.html index 71bb9748e0d..327af21d441 100644 --- a/dev/api/generated/metpy.calc.frontogenesis.html +++ b/dev/api/generated/metpy.calc.frontogenesis.html @@ -76,7 +76,7 @@ - + @@ -757,43 +757,43 @@potential_temperature ((…, M, N) xarray.DataArray
or pint.Quantity
) – Potential temperature
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the wind
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the wind
potential_temperature ((…, M, N) xarray.DataArray
or pint.Quantity
) – Potential temperature
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the wind
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the wind
dx (pint.Quantity
, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
dy (pint.Quantity
, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
xarray.DataArray
.
y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
+parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
+
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
+
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
(…, M, N) xarray.DataArray
or pint.Quantity
– 2D Frontogenesis in [temperature units]/m/s
(…, M, N) xarray.DataArray
or pint.Quantity
– 2D Frontogenesis in [temperature units]/m/s
Notes
diff --git a/dev/api/generated/metpy.calc.geopotential_to_height.html b/dev/api/generated/metpy.calc.geopotential_to_height.html index cfa8dd4f83b..69068128318 100644 --- a/dev/api/generated/metpy.calc.geopotential_to_height.html +++ b/dev/api/generated/metpy.calc.geopotential_to_height.html @@ -76,7 +76,7 @@ - + diff --git a/dev/api/generated/metpy.calc.geospatial_gradient.html b/dev/api/generated/metpy.calc.geospatial_gradient.html index 667b09b7e18..0c27ba66f30 100644 --- a/dev/api/generated/metpy.calc.geospatial_gradient.html +++ b/dev/api/generated/metpy.calc.geospatial_gradient.html @@ -75,7 +75,7 @@ - + @@ -745,41 +745,41 @@f ((…, M, N) xarray.DataArray
or pint.Quantity
) – scalar field for which the horizontal gradient should be calculated
f ((…, M, N) xarray.DataArray
or pint.Quantity
) – scalar field for which the horizontal gradient should be calculated
return_only (str or Sequence[str], optional) – Sequence of which components of the gradient to compute and return. If none, returns the gradient tuple (‘df/dx’, ‘df/dy’). Otherwise, matches the return pattern of the given strings. Only valid strings are ‘df/dx’, ‘df/dy’.
dx (pint.Quantity
, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input. Also optional if one-dimensional
longitude and latitude arguments are given for your data on a non-projected grid.
Keyword-only argument.
dy (pint.Quantity
, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input. Also optional if one-dimensional
longitude and latitude arguments are given for your data on a non-projected grid.
Keyword-only argument.
x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
. Keyword-only argument.
xarray.DataArray
. Keyword-only argument.
y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
. Keyword-only argument.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
+parsed from input if using xarray.DataArray
. Keyword-only argument.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
+
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
+
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
f ((…, M, N) xarray.DataArray
or pint.Quantity
) – scalar field for which the horizontal gradient should be calculated
f ((…, M, N) xarray.DataArray
or pint.Quantity
) – scalar field for which the horizontal gradient should be calculated
return_only (str or Sequence[str], optional) – Sequence of which components of the gradient to compute and return. If none, returns the gradient tuple (‘df/dx’, ‘df/dy’). Otherwise, matches the return pattern of the given strings. Only valid strings are ‘df/dx’, ‘df/dy’.
dx (pint.Quantity
, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input. Also optional if one-dimensional
longitude and latitude arguments are given for your data on a non-projected grid.
Keyword-only argument.
dy (pint.Quantity
, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input. Also optional if one-dimensional
longitude and latitude arguments are given for your data on a non-projected grid.
Keyword-only argument.
x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
. Keyword-only argument.
xarray.DataArray
. Keyword-only argument.
y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
. Keyword-only argument.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
+parsed from input if using xarray.DataArray
. Keyword-only argument.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
+
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
+
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
height ((…, M, N) xarray.DataArray
or pint.Quantity
) – The height or geopotential field.
height ((…, M, N) xarray.DataArray
or pint.Quantity
) – The height or geopotential field.
dx (pint.Quantity
, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
dy (pint.Quantity
, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
latitude (xarray.DataArray
or pint.Quantity
) – The latitude, which is used to calculate the Coriolis parameter. Its dimensions must
-be broadcastable with those of height. Optional if xarray.DataArray
with latitude
+
latitude (xarray.DataArray
or pint.Quantity
) – The latitude, which is used to calculate the Coriolis parameter. Its dimensions must
+be broadcastable with those of height. Optional if xarray.DataArray
with latitude
coordinate used as input. Note that an argument without units is treated as
dimensionless, which is equivalent to radians.
x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
xarray.DataArray
.
y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
+parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
+
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
+
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
Calculate the gradient of a scalar quantity, assuming Cartesian coordinates.
Works for both regularly-spaced data, and grids with varying spacing.
Either coordinates or deltas must be specified, or f must be given as an
-xarray.DataArray
with attached coordinate and projection information. If f is an
-xarray.DataArray
, and coordinates or deltas are given, f will be converted to a
+xarray.DataArray
with attached coordinate and projection information. If f is an
+xarray.DataArray
, and coordinates or deltas are given, f will be converted to a
pint.Quantity
and the gradient returned as a tuple of pint.Quantity
, otherwise, if
neither coordinates nor deltas are given, the attached coordinate information belonging
-to axis will be used and the gradient will be returned as a tuple of xarray.DataArray
.
xarray.DataArray
.
f (array-like) – Array of values of which to calculate the derivative
axes (Sequence[str] or Sequence[int], optional) – Sequence of strings (if f is a xarray.DataArray
and implicit conversion to
+
axes (Sequence[str] or Sequence[int], optional) – Sequence of strings (if f is a xarray.DataArray
and implicit conversion to
pint.Quantity
is not used) or integers that specify the array axes along which to
take the derivatives. Defaults to all axes of f. If given, and used with
coordinates or deltas, its length must be less than or equal to that of the
diff --git a/dev/api/generated/metpy.calc.gradient_richardson_number.html b/dev/api/generated/metpy.calc.gradient_richardson_number.html
index e484f7e609b..87e5845e1f6 100644
--- a/dev/api/generated/metpy.calc.gradient_richardson_number.html
+++ b/dev/api/generated/metpy.calc.gradient_richardson_number.html
@@ -76,7 +76,7 @@
-
+
diff --git a/dev/api/generated/metpy.calc.heat_index.html b/dev/api/generated/metpy.calc.heat_index.html
index 863023c0a3a..46101002216 100644
--- a/dev/api/generated/metpy.calc.heat_index.html
+++ b/dev/api/generated/metpy.calc.heat_index.html
@@ -75,7 +75,7 @@
-
+
diff --git a/dev/api/generated/metpy.calc.height_to_geopotential.html b/dev/api/generated/metpy.calc.height_to_geopotential.html
index b9844870292..d20f7e2f4ef 100644
--- a/dev/api/generated/metpy.calc.height_to_geopotential.html
+++ b/dev/api/generated/metpy.calc.height_to_geopotential.html
@@ -76,7 +76,7 @@
-
+
diff --git a/dev/api/generated/metpy.calc.height_to_pressure_std.html b/dev/api/generated/metpy.calc.height_to_pressure_std.html
index 6426c0940bb..f38d69e9a51 100644
--- a/dev/api/generated/metpy.calc.height_to_pressure_std.html
+++ b/dev/api/generated/metpy.calc.height_to_pressure_std.html
@@ -76,7 +76,7 @@
-
+
diff --git a/dev/api/generated/metpy.calc.html b/dev/api/generated/metpy.calc.html
index 919ebc60cd2..b9c8ec12907 100644
--- a/dev/api/generated/metpy.calc.html
+++ b/dev/api/generated/metpy.calc.html
@@ -75,7 +75,7 @@
-
+
diff --git a/dev/api/generated/metpy.calc.inertial_advective_wind.html b/dev/api/generated/metpy.calc.inertial_advective_wind.html
index 1d8873df753..5f0cb0fb914 100644
--- a/dev/api/generated/metpy.calc.inertial_advective_wind.html
+++ b/dev/api/generated/metpy.calc.inertial_advective_wind.html
@@ -76,7 +76,7 @@
-
+
@@ -758,36 +758,36 @@
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the advecting wind
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the advecting wind
u_geostrophic ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the geostrophic (advected) wind
v_geostrophic ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the geostrophic (advected) wind
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the advecting wind
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the advecting wind
u_geostrophic ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the geostrophic (advected) wind
v_geostrophic ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the geostrophic (advected) wind
dx (pint.Quantity
, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
dy (pint.Quantity
, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
latitude (pint.Quantity
, optional) – Latitude of the wind data. Optional if xarray.DataArray
with latitude/longitude
+
latitude (pint.Quantity
, optional) – Latitude of the wind data. Optional if xarray.DataArray
with latitude/longitude
coordinates used as input. Note that an argument without units is treated as
dimensionless, which translates to radians.
x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
xarray.DataArray
.y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
+parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
+
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
+
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
(…, M, N) xarray.DataArray
or pint.Quantity
– x component of inertial advective wind
(…, M, N) xarray.DataArray
or pint.Quantity
– y component of inertial advective wind
(…, M, N) xarray.DataArray
or pint.Quantity
– x component of inertial advective wind
(…, M, N) xarray.DataArray
or pint.Quantity
– y component of inertial advective wind
levels (pint.Quantity
) – One-dimensional array of desired potential temperature surfaces
temperature (xarray.DataArray
) – Array of temperature
args (xarray.DataArray
, optional) – Any other given variables will be interpolated to each isentropic level. Must have
+
temperature (xarray.DataArray
) – Array of temperature
args (xarray.DataArray
, optional) – Any other given variables will be interpolated to each isentropic level. Must have
names in order to have a well-formed output Dataset.
max_iters (int, optional) – The maximum number of iterations to use in calculation, defaults to 50.
eps (float, optional) – The desired absolute error in the calculated value, defaults to 1e-6.
xarray.DataArray
with attached coordinate and projection information. If f is an
-xarray.DataArray
, and coordinates or deltas are given, f will be converted to a
+xarray.DataArray
with attached coordinate and projection information. If f is an
+xarray.DataArray
, and coordinates or deltas are given, f will be converted to a
pint.Quantity
and the gradient returned as a tuple of pint.Quantity
, otherwise, if
neither coordinates nor deltas are given, the attached coordinate information belonging
-to axis will be used and the gradient will be returned as a tuple of xarray.DataArray
.
+to axis will be used and the gradient will be returned as a tuple of xarray.DataArray
.
f (array-like) – Array of values of which to calculate the derivative
axes (Sequence[str] or Sequence[int], optional) – Sequence of strings (if f is a xarray.DataArray
and implicit conversion to
+
axes (Sequence[str] or Sequence[int], optional) – Sequence of strings (if f is a xarray.DataArray
and implicit conversion to
pint.Quantity
is not used) or integers that specify the array axes along which to
take the derivatives. Defaults to all axes of f. If given, and used with
coordinates or deltas, its length must be less than or equal to that of the
diff --git a/dev/api/generated/metpy.calc.lat_lon_grid_deltas.html b/dev/api/generated/metpy.calc.lat_lon_grid_deltas.html
index a90f72654e4..49fa32f5fd0 100644
--- a/dev/api/generated/metpy.calc.lat_lon_grid_deltas.html
+++ b/dev/api/generated/metpy.calc.lat_lon_grid_deltas.html
@@ -75,7 +75,7 @@
-
+
@@ -764,7 +764,7 @@
This function will only return pint.Quantity
arrays (not xarray.DataArray
or another
+
This function will only return pint.Quantity
arrays (not xarray.DataArray
or another
array-like type). It will also “densify” your data if using Dask or lazy-loading.
Changed in version 1.0: Changed signature from (longitude, latitude, **kwargs)
height (pint.Quantity
or xarray.DataArray
) – Array of geopotential height of isentropic surfaces
temperature (pint.Quantity
or xarray.DataArray
) – Array of temperature on isentropic surfaces
height (pint.Quantity
or xarray.DataArray
) – Array of geopotential height of isentropic surfaces
temperature (pint.Quantity
or xarray.DataArray
) – Array of temperature on isentropic surfaces
stream_func (pint.Quantity
or xarray.DataArray
)
stream_func (pint.Quantity
or xarray.DataArray
)
data_x (xarray.DataArray
) – The input DataArray of the x-component (in terms of data projection) of the vector
+
data_x (xarray.DataArray
) – The input DataArray of the x-component (in terms of data projection) of the vector
field.
data_y (xarray.DataArray
) – The input DataArray of the y-component (in terms of data projection) of the vector
+
data_y (xarray.DataArray
) – The input DataArray of the y-component (in terms of data projection) of the vector
field.
index (str or int, optional) – Denotes the index coordinate of the cross-section, defaults to ‘index’ as
set by metpy.interpolate.cross_section
component_normal (xarray.DataArray
) – Component of the vector field in the normal directions
component_normal (xarray.DataArray
) – Component of the vector field in the normal directions
profile (xarray.Dataset
) – The interpolated profile with three data variables: ambient_temperature,
+
profile (xarray.Dataset
) – The interpolated profile with three data variables: ambient_temperature,
ambient_dew_point, and profile_temperature, all of which are on an isobaric
coordinate.
potential_temperature ((…, P, M, N) xarray.DataArray
or pint.Quantity
) – potential temperature
pressure ((…, P, M, N) xarray.DataArray
or pint.Quantity
) – vertical pressures
u ((…, P, M, N) xarray.DataArray
or pint.Quantity
) – x component of the wind
v ((…, P, M, N) xarray.DataArray
or pint.Quantity
) – y component of the wind
potential_temperature ((…, P, M, N) xarray.DataArray
or pint.Quantity
) – potential temperature
pressure ((…, P, M, N) xarray.DataArray
or pint.Quantity
) – vertical pressures
u ((…, P, M, N) xarray.DataArray
or pint.Quantity
) – x component of the wind
v ((…, P, M, N) xarray.DataArray
or pint.Quantity
) – y component of the wind
dx (pint.Quantity
, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
dy (pint.Quantity
, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
latitude (pint.Quantity
, optional) – Latitude of the wind data. Optional if xarray.DataArray
with latitude/longitude
+
latitude (pint.Quantity
, optional) – Latitude of the wind data. Optional if xarray.DataArray
with latitude/longitude
coordinates used as input. Note that an argument without units is treated as
dimensionless, which translates to radians.
x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Z, Y, X] order).
-Automatically parsed from input if using xarray.DataArray
.
xarray.DataArray
.
y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Z, Y, X] order).
-Automatically parsed from input if using xarray.DataArray
.
xarray.DataArray
.
vertical_dim (int, optional) – Axis number of vertical dimension. Defaults to -3 (implying […, Z, Y, X] order).
-Automatically parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
+Automatically parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
+
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
+
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
(…, P, M, N) xarray.DataArray
or pint.Quantity
– baroclinic potential vorticity
(…, P, M, N) xarray.DataArray
or pint.Quantity
– baroclinic potential vorticity
Notes
@@ -801,7 +801,7 @@xarray.DataArray
, p[:, None, None] can be used to make
+one-dimensional, and not given as xarray.DataArray
, p[:, None, None] can be used to make
it appear multi-dimensional.)
Changed in version 1.0: Changed signature from (potential_temperature, pressure, u, v, dx, dy, lats)
height ((…, M, N) xarray.DataArray
or pint.Quantity
) – atmospheric height
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the wind
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the wind
height ((…, M, N) xarray.DataArray
or pint.Quantity
) – atmospheric height
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the wind
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the wind
dx (pint.Quantity
, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
dy (pint.Quantity
, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
latitude (pint.Quantity
, optional) – Latitude of the wind data. Optional if xarray.DataArray
with latitude/longitude
+
latitude (pint.Quantity
, optional) – Latitude of the wind data. Optional if xarray.DataArray
with latitude/longitude
coordinates used as input. Note that an argument without units is treated as
dimensionless, which translates to radians.
x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
xarray.DataArray
.
y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
+parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
+
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
+
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
(…, M, N) xarray.DataArray
or pint.Quantity
– barotropic potential vorticity
(…, M, N) xarray.DataArray
or pint.Quantity
– barotropic potential vorticity
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the wind (geostrophic in QG-theory)
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the wind (geostrophic in QG-theory)
temperature ((…, M, N) xarray.DataArray
or pint.Quantity
) – Array of temperature at pressure level
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the wind (geostrophic in QG-theory)
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the wind (geostrophic in QG-theory)
temperature ((…, M, N) xarray.DataArray
or pint.Quantity
) – Array of temperature at pressure level
pressure (pint.Quantity
) – Pressure at level
dx (pint.Quantity
, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
dy (pint.Quantity
, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
static_stability (pint.Quantity
, optional) – The static stability at the pressure level. Defaults to 1 if not given to calculate
the Q-vector without factoring in static stability.
x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
xarray.DataArray
.
y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
+parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
+
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
+
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
tuple of (…, M, N) xarray.DataArray
or pint.Quantity
– The components of the Q-vector in the u- and v-directions respectively
tuple of (…, M, N) xarray.DataArray
or pint.Quantity
– The components of the Q-vector in the u- and v-directions respectively
Calculate the second derivative of a grid of values.
Works for both regularly-spaced data and grids with varying spacing.
-Either x or delta must be specified, or f must be given as an xarray.DataArray
with
-attached coordinate and projection information. If f is an xarray.DataArray
, and x or
+
Either x or delta must be specified, or f must be given as an xarray.DataArray
with
+attached coordinate and projection information. If f is an xarray.DataArray
, and x or
delta are given, f will be converted to a pint.Quantity
and the derivative returned
as a pint.Quantity
, otherwise, if neither x nor delta are given, the attached
coordinate information belonging to axis will be used and the derivative will be returned
-as an xarray.DataArray
xarray.DataArray
This uses 3 points to calculate the derivative, using forward or backward at the edges of the grid as appropriate, and centered elsewhere. The irregular spacing is handled explicitly, using the formulation as specified by [Bowen2005].
diff --git a/dev/api/generated/metpy.calc.shearing_deformation.html b/dev/api/generated/metpy.calc.shearing_deformation.html index 6f54f962eb3..7c0d8ee0320 100644 --- a/dev/api/generated/metpy.calc.shearing_deformation.html +++ b/dev/api/generated/metpy.calc.shearing_deformation.html @@ -75,7 +75,7 @@ - + @@ -745,42 +745,42 @@u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the wind
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the wind
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the wind
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the wind
dx (pint.Quantity
, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
dy (pint.Quantity
, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
xarray.DataArray
.
y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
+parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
+
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
+
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
(…, M, N) xarray.DataArray
or pint.Quantity
– Shearing Deformation
(…, M, N) xarray.DataArray
or pint.Quantity
– Shearing Deformation
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the wind
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the wind
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the wind
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the wind
dx (pint.Quantity
, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
dy (pint.Quantity
, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
xarray.DataArray
.
y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
+parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
+
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
+
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
(…, M, N) xarray.DataArray
or pint.Quantity
– Stretching Deformation
(…, M, N) xarray.DataArray
or pint.Quantity
– Stretching Deformation
data_x (xarray.DataArray
) – The input DataArray of the x-component (in terms of data projection) of the vector
+
data_x (xarray.DataArray
) – The input DataArray of the x-component (in terms of data projection) of the vector
field
data_y (xarray.DataArray
) – The input DataArray of the y-component (in terms of data projection) of the vector
+
data_y (xarray.DataArray
) – The input DataArray of the y-component (in terms of data projection) of the vector
field
index (str or int, optional) – Denotes the index coordinate of the cross-section, defaults to ‘index’ as
set by metpy.interpolate.cross_section
component_tangential (xarray.DataArray
) – Component of the vector field in the tangential directions
component_tangential (xarray.DataArray
) – Component of the vector field in the tangential directions
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the wind
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the wind
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the wind
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the wind
dx (pint.Quantity
, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
dy (pint.Quantity
, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input.
x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
xarray.DataArray
.
y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
+parsed from input if using xarray.DataArray
.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
+
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
+
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
(…, M, N) xarray.DataArray
or pint.Quantity
– Total Deformation
(…, M, N) xarray.DataArray
or pint.Quantity
– Total Deformation
cross (xarray.DataArray
) – The input DataArray of a cross-section from which to obtain latitudes
cross (xarray.DataArray
) – The input DataArray of a cross-section from which to obtain latitudes
index (str or int, optional) – Denotes the index coordinate of the cross-section, defaults to ‘index’ as
set by metpy.interpolate.cross_section
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the vector
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the vector
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the vector
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the vector
return_only (str or Sequence[str], optional) – Sequence of which components of the derivative matrix to compute and return. If none, returns the full matrix as a tuple of tuples ((‘du/dx’, ‘du/dy’), (‘dv/dx’, ‘dv/dy’)). Otherwise, matches the return pattern of the given strings. Only valid strings are ‘du/dx’, ‘du/dy’, ‘dv/dx’, and ‘dv/dy’.
dx (pint.Quantity
, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input. Also optional if one-dimensional
longitude and latitude arguments are given for your data on a non-projected grid.
Keyword-only argument.
dy (pint.Quantity
, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input. Also optional if one-dimensional
longitude and latitude arguments are given for your data on a non-projected grid.
Keyword-only argument.
x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
. Keyword-only argument.
xarray.DataArray
. Keyword-only argument.
y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
. Keyword-only argument.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
+parsed from input if using xarray.DataArray
. Keyword-only argument.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
+
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
+
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the wind
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the wind
u ((…, M, N) xarray.DataArray
or pint.Quantity
) – x component of the wind
v ((…, M, N) xarray.DataArray
or pint.Quantity
) – y component of the wind
dx (pint.Quantity
, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input. Also optional if one-dimensional
longitude and latitude arguments are given for your data on a non-projected grid.
Keyword-only argument.
dy (pint.Quantity
, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than
-the size of u along the applicable axis. Optional if xarray.DataArray
with
+the size of u along the applicable axis. Optional if xarray.DataArray
with
latitude/longitude coordinates used as input. Also optional if one-dimensional
longitude and latitude arguments are given for your data on a non-projected grid.
Keyword-only argument.
x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
. Keyword-only argument.
xarray.DataArray
. Keyword-only argument.
y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically
-parsed from input if using xarray.DataArray
. Keyword-only argument.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
+parsed from input if using xarray.DataArray
. Keyword-only argument.
parallel_scale (pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
+
meridional_scale (pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional if xarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if
longitude, latitude, and crs are given. If otherwise omitted, calculation will be
carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
latitude (pint.Quantity
, optional) – Latitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
+
longitude (pint.Quantity
, optional) – Longitude of data. Optional if xarray.DataArray
with latitude/longitude coordinates
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
+
crs (pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional if xarray.DataArray
with MetPy CRS
used as input. Also optional if parallel_scale and meridional_scale are given. If
otherwise omitted, calculation will be carried out on a Cartesian, rather than
geospatial, grid. Keyword-only argument.
(…, M, N) xarray.DataArray
or pint.Quantity
– vertical vorticity
(…, M, N) xarray.DataArray
or pint.Quantity
– vertical vorticity
input_field (xarray.DataArray
) – The 2D data array to be interpolated.
input_field (xarray.DataArray
) – The 2D data array to be interpolated.
zoom (float or Sequence[float]) – The zoom factor along the axes. If a float, zoom is the same for each axis. If a sequence, zoom should contain one value for each axis.
order (int, optional) – The order of the spline interpolation, default is 3. The order has to be in the @@ -759,7 +759,7 @@
zoomed_data (xarray.DataArray
) – The zoomed input with its associated coordinates and coordinate reference system, if
+
zoomed_data (xarray.DataArray
) – The zoomed input with its associated coordinates and coordinate reference system, if
available.
xarray.DataArray
so that we can utilize its coordinate and projection
+given as an xarray.DataArray
so that we can utilize its coordinate and projection
metadata.
data (xarray.DataArray
or xarray.Dataset
) – Three- (or higher) dimensional field(s) to interpolate. The DataArray (or each
+
data (xarray.DataArray
or xarray.Dataset
) – Three- (or higher) dimensional field(s) to interpolate. The DataArray (or each
DataArray in the Dataset) must have been parsed by MetPy and include both an x and
y coordinate dimension and the added crs coordinate.
start ((2, ) array-like) – A latitude-longitude pair designating the start point of the cross section (units are @@ -763,7 +763,7 @@
xarray.DataArray
or xarray.Dataset
– The interpolated cross section, with new index dimension along the cross-section.
xarray.DataArray
or xarray.Dataset
– The interpolated cross section, with new index dimension along the cross-section.
Obtain an interpolated slice through data using xarray.
Utilizing the interpolation functionality in xarray, this function
takes a slice of the given data (currently only regular grids are supported), which is
-given as an xarray.DataArray
so that we can utilize its coordinate metadata.
xarray.DataArray
so that we can utilize its coordinate metadata.
data (xarray.DataArray
or xarray.Dataset
) – Three- (or higher) dimensional field(s) to interpolate. The DataArray (or each
+
data (xarray.DataArray
or xarray.Dataset
) – Three- (or higher) dimensional field(s) to interpolate. The DataArray (or each
DataArray in the Dataset) must have been parsed by MetPy and include both an x and
y coordinate dimension.
points ((N, 2) array-like) – A list of x, y points in the data projection at which to interpolate the data
xarray.DataArray
or xarray.Dataset
– The interpolated slice of data, with new index dimension of size N.
xarray.DataArray
or xarray.Dataset
– The interpolated slice of data, with new index dimension of size N.
list – List of xarray.DataArray
objects for each grid.
list – List of xarray.DataArray
objects for each grid.
list[xarray.Dataset] – List of xarray.Dataset
objects for each sounding.
list[xarray.Dataset] – List of xarray.Dataset
objects for each sounding.
Get the global attributes.
-This is used by xarray.open_dataset
.
This is used by xarray.open_dataset
.
Get all variables in the file.
-This is used by xarray.open_dataset
.
This is used by xarray.open_dataset
.
f (xarray.DataArray
) – Parsed DataArray (metpy_crs
coordinate must be available for kind=”actual”)
f (xarray.DataArray
) – Parsed DataArray (metpy_crs
coordinate must be available for kind=”actual”)
kind (str) – Type of grid delta to calculate. “actual” returns true distances as calculated from longitude and latitude via lat_lon_grid_deltas. “nominal” returns horizontal differences in the data’s coordinate space, either in degrees (for lat/lon CRS) or diff --git a/dev/api/generated/metpy.xarray.html b/dev/api/generated/metpy.xarray.html index fb82c79ee4e..7c65a55e3ec 100644 --- a/dev/api/generated/metpy.xarray.html +++ b/dev/api/generated/metpy.xarray.html @@ -75,7 +75,7 @@ - + @@ -799,7 +799,7 @@
xarray.DataArray
– New xarray DataArray with CRS coordinate assigned
xarray.DataArray
– New xarray DataArray with CRS coordinate assigned
Notes
@@ -817,7 +817,7 @@xarray.DataArray
– New xarray DataArray with latitude and longtiude auxiliary coordinates assigned.
xarray.DataArray
– New xarray DataArray with latitude and longtiude auxiliary coordinates assigned.
Notes
@@ -839,7 +839,7 @@xarray.DataArray
– New xarray DataArray with y and x dimension coordinates assigned.
xarray.DataArray
– New xarray DataArray with y and x dimension coordinates assigned.
Notes
@@ -1107,7 +1107,7 @@xarray.Dataset
– New xarray Dataset with CRS coordinate assigned
xarray.Dataset
– New xarray Dataset with CRS coordinate assigned
xarray.Dataset
– New xarray Dataset with latitude and longitude coordinates assigned to all
+
xarray.Dataset
– New xarray Dataset with latitude and longitude coordinates assigned to all
variables with y and x coordinates.
xarray.Dataset
– New xarray Dataset with y and x dimension coordinates assigned to all variables
+
xarray.Dataset
– New xarray Dataset with y and x dimension coordinates assigned to all variables
with valid latitude and longitude coordinates.
xarray.DataArray
or xarray.Dataset
– Parsed DataArray (if varname is a string) or Dataset
xarray.DataArray
or xarray.Dataset
– Parsed DataArray (if varname is a string) or Dataset
xarray.Dataset
– New Dataset with attribute updated
xarray.Dataset
– New Dataset with attribute updated
Total running time of the script: (0 minutes 0.218 seconds)
+Total running time of the script: (0 minutes 0.217 seconds)
-[<matplotlib.lines.Line2D object at 0x7fb140eb7ed0>]
+[<matplotlib.lines.Line2D object at 0x7fd9cedce8d0>]
This layout isn’t bad, especially for how little code it required,
@@ -710,7 +710,7 @@
skew.shade_cape(p, T, prof, alpha=0.2, label='SBCAPE')
<matplotlib.collections.PolyCollection object at 0x7fb14320b350>
+<matplotlib.collections.PolyCollection object at 0x7fd9b9e813d0>
STEP 3: CREATE THE HODOGRAPH INSET. TAKE A FEW EXTRA STEPS TO
@@ -760,7 +760,7 @@
length_includes_head=True, head_width=2)
<matplotlib.patches.FancyArrow object at 0x7fb141731e90>
+<matplotlib.patches.FancyArrow object at 0x7fd9ba4c9810>
STEP 4: ADD A FEW EXTRA ELEMENTS TO REALLY MAKE A NEAT PLOT
@@ -915,7 +915,7 @@
plt.figtext(0.83, 0.05, f'{int(super_comp.m)}', weight='bold', fontsize=15,
Total running time of the script: (0 minutes 0.814 seconds)
+Total running time of the script: (0 minutes 0.784 seconds)
-Total running time of the script: (0 minutes 11.300 seconds)
+Total running time of the script: (0 minutes 11.203 seconds)
-Total running time of the script: (0 minutes 12.037 seconds)
+Total running time of the script: (0 minutes 11.998 seconds)
-Total running time of the script: (0 minutes 0.227 seconds)
+Total running time of the script: (0 minutes 0.228 seconds)
-Total running time of the script: (0 minutes 0.147 seconds)
+Total running time of the script: (0 minutes 0.146 seconds)