Skip to content

Commit 3d3d8d0

Browse files
committed
tidying for v3.16.3
1 parent 9e29106 commit 3d3d8d0

30 files changed

+87
-86
lines changed

Changelog.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
version NEXTVERSION
2-
-------------------
1+
version 3.16.3
2+
--------------
33

4-
**2024-12-??**
4+
**2025-01-28**
55

66
* Allow ``'nearest_dtos'`` 2-d regridding to work with discrete
77
sampling geometry source grids

README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,8 @@ The `cf` package uses
8484
[Dask](https://ncas-cms.github.io/cf-python/performance.html) for all
8585
of its array manipulation and can:
8686

87-
* read field constructs from netCDF, CDL, PP and UM datasets,
87+
* read field constructs from netCDF, CDL, PP and UM datasets with a
88+
choice of netCDF backends,and in local, http, and s3 locations,
8889
* create new field constructs in memory,
8990
* write and append field and domain constructs to netCDF datasets on disk,
9091
* read, create, and manipulate UGRID mesh topologies,

cf/__init__.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@
8181
"""
8282

8383
__Conventions__ = "CF-1.11"
84-
__date__ = "2024-??-??"
85-
__version__ = "3.17.0"
84+
__date__ = "2025-01-28"
85+
__version__ = "3.16.3"
8686

8787
_requires = (
8888
"numpy",

cf/cfimplementation.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ def initialise_CFANetCDF4Array(self, **kwargs):
133133
def initialise_CFAH5netcdfArray(self, **kwargs):
134134
"""Return a `CFAH5netcdfArray` instance.
135135
136-
.. versionadded:: NEXTVERSION
136+
.. versionadded:: 1.11.2.0
137137
138138
:Parameters:
139139

cf/data/array/cfah5netcdfarray.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
class CFAH5netcdfArray(CFAMixin, H5netcdfArray):
66
"""A CFA-netCDF array accessed with `h5netcdf`
77
8-
.. versionadded:: NEXTVERSION
8+
.. versionadded:: 1.11.2.0
99
1010
"""

cf/data/array/cfanetcdf4array.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
class CFANetCDF4Array(CFAMixin, NetCDF4Array):
66
"""A CFA-netCDF array accessed with `netCDF4`.
77
8-
.. versionadded:: NEXTVERSION
8+
.. versionadded:: 1.11.2.0
99
1010
"""

cf/data/array/fullarray.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -41,18 +41,18 @@ def __init__(
4141
4242
{{init attributes: `dict` or `None`, optional}}
4343
44-
.. versionadded:: NEXTVERSION
44+
.. versionadded:: 1.11.2.0
4545
4646
{{init source: optional}}
4747
4848
{{init copy: `bool`, optional}}
4949
5050
units: `str` or `None`, optional
51-
Deprecated at version NEXTVERSION. Use the
51+
Deprecated at version 1.11.2.0. Use the
5252
*attributes* parameter instead.
5353
5454
calendar: `str` or `None`, optional
55-
Deprecated at version NEXTVERSION. Use the
55+
Deprecated at version 1.11.2.0. Use the
5656
*attributes* parameter instead.
5757
5858
"""
@@ -123,7 +123,7 @@ def __str__(self):
123123
def _get_array(self, index=None):
124124
"""Returns the full array.
125125
126-
.. versionadded:: NEXTVERSION
126+
.. versionadded:: 1.11.2.0
127127
128128
.. seealso:: `__array__`, `index`
129129
@@ -158,7 +158,7 @@ def _get_array(self, index=None):
158158
def array(self):
159159
"""Return an independent numpy array containing the data.
160160
161-
.. versionadded:: NEXTVERSION
161+
.. versionadded:: 1.11.2.0
162162
163163
:Returns:
164164

cf/data/array/h5netcdfarray.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ class H5netcdfArray(
1818
An active storage reduction may be enabled with the `actify`
1919
method. See `cf.data.collapse.Collapse` for details.
2020
21-
.. versionadded:: NEXTVERSION
21+
.. versionadded:: 1.11.2.0
2222
2323
"""

cf/data/array/mixin/activestoragemixin.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
class ActiveStorageMixin:
22
"""Mixin class for enabling active storage operations.
33
4-
.. versionadded:: NEXTVERSION
4+
.. versionadded:: 1.11.2.0
55
66
"""
77

@@ -12,7 +12,7 @@ def active_storage(self):
1212
Currently, active storage operations are allowed unless the
1313
data are numerically packed.
1414
15-
.. versionadded:: NEXTVERSION
15+
.. versionadded:: 1.11.2.0
1616
1717
:Returns:
1818

cf/data/array/mixin/arraymixin.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ def _meta(self):
2727
the actual metadata from the values. It does not force the
2828
output to have the structure or dtype of the specified meta.
2929
30-
.. versionadded:: NEXTVERSION
30+
.. versionadded:: 1.11.2.0
3131
3232
.. seealso:: `dask.utils.meta_from_array`
3333

cf/data/array/mixin/cfamixin.py

+9-9
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@
99
class CFAMixin:
1010
"""Mixin class for a CFA array.
1111
12-
.. versionadded:: NEXTVERSION
12+
.. versionadded:: 1.11.2.0
1313
1414
"""
1515

1616
def __new__(cls, *args, **kwargs):
1717
"""Store fragment array classes.
1818
19-
.. versionadded:: NEXTVERSION
19+
.. versionadded:: 1.11.2.0
2020
2121
"""
2222
# Import fragment array classes. Do this here (as opposed to
@@ -78,7 +78,7 @@ def __init__(
7878
7979
{{init unpack: `bool`, optional}}
8080
81-
.. versionadded:: NEXTVERSION
81+
.. versionadded:: 1.11.2.0
8282
8383
instructions: `str`, optional
8484
The ``aggregated_data`` attribute value as found on
@@ -134,26 +134,26 @@ def __init__(
134134
'https://s3.fr-par.scw.cloud', 'client_kwargs':
135135
{'region_name': 'fr-par'}}``
136136
137-
.. versionadded:: NEXTVERSION
137+
.. versionadded:: 1.11.2.0
138138
139139
{{init attributes: `dict` or `None`, optional}}
140140
141141
If *attributes* is `None`, the default, then the
142142
attributes will be set from the netCDF variable during
143143
the first `__getitem__` call.
144144
145-
.. versionaddedd:: NEXTVERSION
145+
.. versionaddedd:: 1.11.2.0
146146
147147
{{init source: optional}}
148148
149149
{{init copy: `bool`, optional}}
150150
151151
units: `str` or `None`, optional
152-
Deprecated at version NEXTVERSION. Use the
152+
Deprecated at version 1.11.2.0. Use the
153153
*attributes* parameter instead.
154154
155155
calendar: `str` or `None`, optional
156-
Deprecated at version NEXTVERSION. Use the
156+
Deprecated at version 1.11.2.0. Use the
157157
*attributes* parameter instead.
158158
159159
"""
@@ -226,7 +226,7 @@ def __init__(
226226
def _parse_cfa(self, x, term, substitutions):
227227
"""Parse the CFA aggregation instructions.
228228
229-
.. versionadded:: NEXTVERSION
229+
.. versionadded:: 1.11.2.0
230230
231231
:Parameters:
232232
@@ -466,7 +466,7 @@ def get_fragment_shape(self):
466466
def get_storage_options(self):
467467
"""Return `s3fs.S3FileSystem` options for accessing S3 fragment files.
468468
469-
.. versionadded:: NEXTVERSION
469+
.. versionadded:: 1.11.2.0
470470
471471
:Returns:
472472

cf/data/array/netcdfarray.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
class NetCDFArray:
22
"""A netCDF array accessed with `netCDF4`.
33
4-
Deprecated at version NEXTVERSION and is no longer available. Use
4+
Deprecated at version 1.11.2.0 and is no longer available. Use
55
`cf.NetCDF4Array` instead.
66
77
"""
@@ -11,6 +11,6 @@ def __init__(self, *args, **kwargs):
1111
from ...functions import DeprecationError
1212

1313
raise DeprecationError(
14-
f"{self.__class__.__name__} was deprecated at version NEXTVERSION "
14+
f"{self.__class__.__name__} was deprecated at version 1.11.2.0 "
1515
"and is no longer available. Use cf.NetCDF4Array instead."
1616
)

cf/data/array/umarray.py

+7-7
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ def __init__(
6767
already been set will be inferred from the lookup
6868
header and cached for future use.
6969
70-
.. versionadded:: NEXTVERSION
70+
.. versionadded:: 1.11.2.0
7171
7272
{{init source: optional}}
7373
@@ -90,11 +90,11 @@ def __init__(
9090
Deprecated at version 3.15.0.
9191
9292
units: `str` or `None`, optional
93-
Deprecated at version NEXTVERSION. Use the
93+
Deprecated at version 1.11.2.0. Use the
9494
*attributes* parameter instead.
9595
9696
calendar: `str` or `None`, optional
97-
Deprecated at version NEXTVERSION. Use the
97+
Deprecated at version 1.11.2.0. Use the
9898
*attributes* parameter instead.
9999
100100
"""
@@ -176,7 +176,7 @@ def __init__(
176176
def _get_array(self, index=None):
177177
"""Returns a subspace of the dataset variable.
178178
179-
.. versionadded:: NEXTVERSION
179+
.. versionadded:: 1.11.2.0
180180
181181
.. seealso:: `__array__`, `index`
182182
@@ -276,7 +276,7 @@ def _get_rec(self, f, header_offset):
276276
def _set_FillValue(self, int_hdr, real_hdr, attributes):
277277
"""Set the ``_FillValue`` attribute.
278278
279-
.. versionadded:: NEXTVERSION
279+
.. versionadded:: 1.11.2.0
280280
281281
:Parameters:
282282
@@ -314,7 +314,7 @@ def _set_units(self, int_hdr, attributes):
314314
315315
.. versionadded:: 3.14.0
316316
317-
.. versionadded:: NEXTVERSION
317+
.. versionadded:: 1.11.2.0
318318
319319
:Parameters:
320320
@@ -372,7 +372,7 @@ def _set_units(self, int_hdr, attributes):
372372
def _set_unpack(self, int_hdr, real_hdr, attributes):
373373
"""Set the ``add_offset`` and ``scale_factor`` attributes.
374374
375-
.. versionadded:: NEXTVERSION
375+
.. versionadded:: 1.11.2.0
376376
377377
:Parameters:
378378

cf/data/collapse/collapse_active.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ def actify(method):
4040
can be done in active storage, or the active storage reduction
4141
failed) then the computations will be done locally "as usual".
4242
43-
.. versionadded:: NEXTVERSION
43+
.. versionadded:: 1.11.2.0
4444
4545
.. seealso:: `active_chunk_function`
4646
@@ -92,7 +92,7 @@ def active_chunk_function(method, *args, **kwargs):
9292
reduction components, similar to that returned by a ``cf_*_chunk``
9393
method, is returned.
9494
95-
.. versionadded:: NEXTVERSION
95+
.. versionadded:: 1.11.2.0
9696
9797
.. seealso:: `actify`
9898

cf/data/collapse/dask_collapse.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1133,7 +1133,7 @@ def cf_sum_of_weights2_chunk(
11331133
This function is passed to `dask.array.reduction` as its *chunk*
11341134
parameter.
11351135
1136-
.. versionadded:: NEXTVERSION
1136+
.. versionadded:: 1.11.2.0
11371137
11381138
:Parameters:
11391139

cf/data/dask_utils.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ def cf_units(a, from_units, to_units):
413413
def cf_is_masked(a):
414414
"""Determine whether an array has masked values.
415415
416-
.. versionadded:: NEXTVERSION
416+
.. versionadded:: 1.11.2.0
417417
418418
:Parameters:
419419
@@ -436,7 +436,7 @@ def cf_is_masked(a):
436436
def cf_filled(a, fill_value=None):
437437
"""Replace masked elements with a fill value.
438438
439-
.. versionadded:: NEXTVERSION
439+
.. versionadded:: 1.11.2.0
440440
441441
:Parameters:
442442

cf/data/data.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1948,7 +1948,7 @@ def _clear_after_dask_update(self, clear=None):
19481948
consistent with an updated `dask` array. See the *clear*
19491949
parameter for details.
19501950
1951-
.. versionadded:: NEXTVERSION
1951+
.. versionadded:: 1.11.2.0
19521952
19531953
.. seealso:: `_del_Array`, `_del_cached_elements`,
19541954
`_set_dask`, `_cfa_del_write`
@@ -4068,7 +4068,7 @@ def masked_where(self, condition, inplace=False):
40684068
40694069
`masked_where` causes all delayed operations to be executed.
40704070
4071-
.. versionadded:: NEXTVERSION
4071+
.. versionadded:: 1.11.2.0
40724072
40734073
.. seealso:: `mask`, `masked_values`, `where`
40744074

cf/data/fragment/fullfragmentarray.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ def __init__(
4242
4343
{{init attributes: `dict` or `None`, optional}}
4444
45-
.. versionadded:: NEXTVERSION
45+
.. versionadded:: 1.11.2.0
4646
4747
{{aggregated_units: `str` or `None`, optional}}
4848
@@ -53,11 +53,11 @@ def __init__(
5353
{{init copy: `bool`, optional}}
5454
5555
units: `str` or `None`, optional
56-
Deprecated at version NEXTVERSION. Use the
56+
Deprecated at version 1.11.2.0. Use the
5757
*attributes* parameter instead.
5858
5959
calendar: `str` or `None`, optional
60-
Deprecated at version NEXTVERSION. Use the
60+
Deprecated at version 1.11.2.0. Use the
6161
*attributes* parameter instead.
6262
6363
"""

cf/data/fragment/h5netcdffragmentarray.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
class H5netcdfFragmentArray(FragmentArrayMixin, H5netcdfArray):
66
"""A netCDF fragment array accessed with `h5netcdf`.
77
8-
.. versionadded:: NEXTVERSION
8+
.. versionadded:: 1.11.2.0
99
1010
"""
1111

cf/data/fragment/mixin/fragmentarraymixin.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ class FragmentArrayMixin:
1515
def _get_array(self, index=None):
1616
"""Returns a subspace of the dataset variable.
1717
18-
.. versionadded:: NEXTVERSION
18+
.. versionadded:: 1.11.2.0
1919
2020
.. seealso:: `__array__`, `index`
2121

cf/data/fragment/netcdf4fragmentarray.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
class NetCDF4FragmentArray(FragmentArrayMixin, NetCDF4Array):
66
"""A netCDF fragment array accessed with `netCDF4`.
77
8-
.. versionadded:: NEXTVERSION
8+
.. versionadded:: 1.11.2.0
99
1010
"""
1111

0 commit comments

Comments
 (0)