API changes in version 3.14.0

[davidhassell]

Version 3.14.0 is the first version to use Dask for all of it's data manipulations.

Every effort to leave the API unchanged relative to version 3.13.1, but there are a few cases for which small backwards incompatible API changes were necessary to fit in with the Dask functionality. In all cases, an informative error message is returned when the attempting to use the old API.

Further API changes are expected in the upcoming version 4.0.0 which will, for example, move cf close to the Python array API.

The backwards incompatible API changes introduced at version 3.14.0 are (the links will resolve once 3.14.0 is released):

Method	API change
cf.Field.close	Method incompatible with Dask and no longer available
cf.Field.cumsum	The coordinate keyword parameter is no longer available; the masked_as_zero keyword parameter is no longer available.
cf.Field.halo	The size keyword parameter has been replaced by the depth keyword parameter
cf.Field.mask_invalid	Use the masked_invalid method instead.
cf.Field.percentile	The interpolation keyword parameter has been replaced by the method keyword parameter

Attribute	API change
cf.Field.varray	Attribute incompatible with Dask and no longer available
cf.Field.cumsum	The masked_as_zero keyword parameter is no longer available
cf.Field.halo	The size keyword parameter has been replaced by the depth keyword parameter
cf.Field.percentile	The interpolation keyword parameter has been replaced by the method keyword parameter

Data Method	API change
cf.Data.cumsum	The masked_as_zero keyword parameter is no longer available
cf.Data.percentile	The interpolation keyword parameter has been replaced by the method keyword parameter
cf.Data.fits_in_one_chunk_in_memory	Method incompatible with Dask and no longer available
cf.Data.close	Method incompatible with Dask and no longer available
cf.Data.concatenate_data	Use the concatenate method instead.
cf.Data.chunk	Use the rechunk method instead
cf.Data.dumpd	Method incompatible with Dask and no longer available
cf.Data.dumps	Method incompatible with Dask and no longer available
cf.Data.HDF_chunks	Use the nc_clear_hdf5_chunksizes, nc_hdf5_chunksizes, and nc_set_hdf5_chunksizes methods instead.
cf.Data.loadd	Method incompatible with Dask and no longer available
cf.Data.loads	Method incompatible with Dask and no longer available
cf.Data.add_partitions	Use the rechunk method instead.
cf.Data.mask_fpe	Method incompatible with Dask and no longer available
cf.Data.mask_invalid	Use the masked_invalid method instead.
cf.Data.partition_boundaries	Method incompatible with Dask and no longer available. Consider using the chunks attribute instead.
cf.Data.seterr	Method incompatible with Dask and no longer available.
cf.Data.todisk.	Method incompatible with Dask and no longer available.
cf.Data.reconstruct_sectioned_data	Method incompatible with Dask and no longer available.

Data Attribute	API change
cf.Data.in_memory	Attribute incompatible with Dask and no longer available
cf.Data.is_masked	Use the ismasked attribute instead
cf.Data.isscalar	Use d.ndim == 0 instead.
cf.Data.ispartitioned	Attribute incompatible with Dask and no longer available
cf.Data.varray	Attribute incompatible with Dask and no longer available

Function	API change
cf.of_fraction	Function incompatible with Dask and no longer available
cf.OF_FRACTION	Function incompatible with Dask and no longer available
cf.collapse_parallel_mode	Function incompatible with Dask and no longer available
cf.COLLAPSE_PARALLEL_MODE	Function incompatible with Dask and no longer available
cf.free_memory_factor	Function incompatible with Dask and no longer available
cf.FREE_MEMORY_FACTOR	Function incompatible with Dask and no longer available
cf.fm_threshold	Function incompatible with Dask and no longer available
cf.FM_THRESHOLD	Function incompatible with Dask and no longer available
cf.set_performance	Function incompatible with Dask and no longer available
cf.SET_PERFORMANCE	Function incompatible with Dask and no longer available
cf.min_total_memory	Function incompatible with Dask and no longer available
cf.MIN_TOTAL_MEMORY	Function incompatible with Dask and no longer available
cf.open_files_threshold_exceeded	Function incompatible with Dask and no longer available
cf.close_files	Function incompatible with Dask and no longer available
cf.close_one_file	Function incompatible with Dask and no longer available
cf.open_files	Function incompatible with Dask and no longer available