Skip to content

Commit 5da592f

Browse files
authored
Updated CF saver version in User Guide and docstring (#3925)
* Updated CF saver version in User Guide and docstring * Remove references to CF version of the loader in docstrings * Added whatsnew * Pin cftime<1.3.0
1 parent 2e6aa01 commit 5da592f

File tree

6 files changed

+8
-7
lines changed

6 files changed

+8
-7
lines changed

docs/iris/src/userguide/saving_iris_cubes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Saving Iris cubes
66

77
Iris supports the saving of cubes and cube lists to:
88

9-
* CF netCDF (version 1.6)
9+
* CF netCDF (version 1.7)
1010
* GRIB edition 2 (if `iris-grib <https://github.com/SciTools/iris-grib>`_ is installed)
1111
* Met Office PP
1212

docs/iris/src/whatsnew/3.0.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -351,6 +351,8 @@ This document explains the changes made to Iris for this release
351351
included documentation for :ref:`metadata`, :ref:`lenient metadata`, and
352352
:ref:`lenient maths`. (:pull:`3890`)
353353

354+
* `@jonseddon`_ updated the CF version of the netCDF saver in the
355+
:ref:`saving_iris_cubes` section and in the equivalent function docstring.
354356

355357
💼 Internal
356358
===========

lib/iris/fileformats/cf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
1010
References:
1111
12-
[CF] NetCDF Climate and Forecast (CF) Metadata conventions, Version 1.5, October, 2010.
12+
[CF] NetCDF Climate and Forecast (CF) Metadata conventions.
1313
[NUG] NetCDF User's Guide, https://www.unidata.ucar.edu/software/netcdf/documentation/NUG/
1414
1515
"""

lib/iris/fileformats/netcdf.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
99
See also: `netCDF4 python <http://code.google.com/p/netcdf4-python/>`_.
1010
11-
Also refer to document 'NetCDF Climate and Forecast (CF) Metadata Conventions',
12-
Version 1.4, 27 February 2009.
11+
Also refer to document 'NetCDF Climate and Forecast (CF) Metadata Conventions'.
1312
1413
"""
1514

@@ -2490,7 +2489,7 @@ def save(
24902489
"""
24912490
Save cube(s) to a netCDF file, given the cube and the filename.
24922491
2493-
* Iris will write CF 1.5 compliant NetCDF files.
2492+
* Iris will write CF 1.7 compliant NetCDF files.
24942493
* The attributes dictionaries on each cube in the saved cube list
24952494
will be compared and common attributes saved as NetCDF global
24962495
attributes where appropriate.

requirements/ci/py36.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ dependencies:
1313
# Core dependencies.
1414
- cartopy>=0.18
1515
- cf-units>=2
16-
- cftime
16+
- cftime<1.3.0
1717
- dask>=2
1818
- matplotlib
1919
- netcdf4

requirements/ci/py37.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ dependencies:
1313
# Core dependencies.
1414
- cartopy>=0.18
1515
- cf-units>=2
16-
- cftime
16+
- cftime<1.3.0
1717
- dask>=2
1818
- matplotlib
1919
- netcdf4

0 commit comments

Comments
 (0)