diff --git a/docs/2_to_3_changes.html b/docs/2_to_3_changes.html index 08a92f6f89..a5d744b9e0 100644 --- a/docs/2_to_3_changes.html +++ b/docs/2_to_3_changes.html @@ -44,7 +44,7 @@ -

cf 3.16.1

+

cf 3.16.2

@@ -491,7 +491,7 @@

Changes to the API of existing methods +
open_lower: bool, optional

Only applicable to the 'wi' operator. +If True, open the interval at the lower +bound so that value0 is excluded from the +range. By default the interval is closed +so that value0 is included.

+
+

New in version 3.16.2.

+
+
+
open_upper: bool, optional

Only applicable to the 'wi' operator. +If True, open the interval at the upper +bound so that value1 is excluded from the +range. By default the interval is closed +so that value1 is included.

+
+

New in version 3.16.2.

+
+
exact: deprecated at version 3.0.0.

Use re.compile objects in value instead.

@@ -401,7 +419,7 @@

Methods

addattr

-

Return a Query object with a new left hand side operand attribute to be used during evaluation.

+

Redefine the query to be on an object’s attribute.

copy

Return a deep copy.

@@ -465,6 +483,12 @@

Attributes

rtol

The tolerance on relative numerical differences.

+

open_upper

+

True if the interval is open at the (excludes the) upper bound.

+ +

open_lower

+

True if the interval is open at the (excludes the) lower bound.

+ @@ -520,7 +544,7 @@

Attributes

Initialisation

Parameters
@@ -195,6 +198,10 @@

cf.RegridOperatorint, optional

Specify whether the row and col parameters use 0- or 1-based indexing. By default 0-based indexing is used.

+

If row and col are to be read from a weights file +and their netCDF variables have start_index +attributes, then these will be used in preference to +start_index.

parameters: Deprecated at version 3.14.0

Use keyword parameters instead.

@@ -212,12 +219,57 @@

cf.RegridOperatorstr, optional

The UGRID mesh element of the source grid -(e.g. 'face'). An empty string should be used for -a non-UGRID source grid.

+(e.g. 'face').

New in version 3.16.0.

+
dst_mesh_location: str, optional

The UGRID mesh element of the destination grid +(e.g. 'face').

+
+

New in version 3.16.2.

+
+
+
src_featureType: str, optional

The discrete sampling geometry (DSG) featureType of +the source grid (e.g. 'trajectory').

+
+

New in version 3.16.2.

+
+
+
dst_featureType: str, optional

The DSG featureType of the destination grid +(e.g. 'trajectory').

+
+

New in version 3.16.2.

+
+
+
src_z: optional

The identity of the source grid vertical coordinates +used to calculate the weights. If None then no +source grid vertical axis is identified.

+
+

New in version 3.16.2.

+
+
+
dst_z: optional

The identity of the destination grid vertical +coordinates used to calculate the weights. If None +then no destination grid vertical axis is identified.

+
+

New in version 3.16.2.

+
+
+
ln_z: bool, optional

Whether or not the weights were calculated with the +natural logarithm of vertical coordinates.

+
+

New in version 3.16.2.

+
+
+
dimensionality: int, optional

The number of physical regridding dimensions. This may +differ from the corresponding number of storage +dimensions in the source or destination grids, if +either has an unstructured mesh or a DSG featureType.

+
+

New in version 3.16.2.

+
+

@@ -237,7 +289,7 @@

cf.RegridOperator

tosparse

-

Convert the weights to scipy sparse array format in-place.

+

Convert the weights to scipy sparse array format in-place.

@@ -254,42 +306,60 @@

cf.RegridOperator

coord_sys

The name of the regridding coordinate system.

-

dst

+

dimensionality

+

The number of physical regridding dimensions.

+ +

dst

The definition of the destination grid.

-

dst_axes

+

dst_axes

The destination grid axes to be regridded.

-

dst_cyclic

+

dst_cyclic

Whether or not the destination grid longitude axis is cyclic.

+

dst_featureType

+

The DSG featureType of the destination grid.

+

dst_mask

A destination grid mask to be applied to the weights matrix.

-

dst_shape

+

dst_mesh_location

+

The UGRID mesh element of the destination grid.

+ +

dst_shape

The shape of the destination grid.

-

method

+

dst_z

+

The identity of the destination grid vertical coordinates.

+ +

ln_z

+

Whether or not vertical weights are based on ln(z).

+ +

method

The name of the regridding method.

-

name

+

name

The name of the regridding method.

-

row

+

row

The 1-d array of the row indices of the regridding weights.

-

src_axes

+

src_axes

The source grid axes to be regridded.

-

src_bounds

+

src_bounds

The bounds of the source grid cells.

-

src_coords

+

src_coords

The coordinates of the source grid cells.

-

src_cyclic

+

src_cyclic

Whether or not the source grid longitude axis is cyclic.

+

src_featureType

+

The DSG featureType of the source grid.

+

src_mask

The source grid mask that was applied during the weights creation.

@@ -299,13 +369,16 @@

cf.RegridOperator

src_mesh_location

The UGRID mesh element of the source grid.

-

start_index

+

src_z

+

The identity of the source grid vertical coordinates.

+ +

start_index

The start index of the row and column indices.

-

weights

+

weights

The 1-d array of the regridding weights, or None.

-

weights_file

+

weights_file

The file which contains the weights, or None.

@@ -353,7 +426,7 @@

Special