Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated CF saver version in User Guide and docstring #3925

Merged
merged 4 commits into from
Nov 24, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/iris/src/userguide/saving_iris_cubes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Saving Iris cubes

Iris supports the saving of cubes and cube lists to:

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

Expand Down
2 changes: 2 additions & 0 deletions docs/iris/src/whatsnew/3.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,8 @@ This document explains the changes made to Iris for this release
included documentation for :ref:`metadata`, :ref:`lenient metadata`, and
:ref:`lenient maths`. (:pull:`3890`)

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

💼 Internal
===========
Expand Down
2 changes: 1 addition & 1 deletion lib/iris/fileformats/cf.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

References:

[CF] NetCDF Climate and Forecast (CF) Metadata conventions, Version 1.5, October, 2010.
[CF] NetCDF Climate and Forecast (CF) Metadata conventions.
[NUG] NetCDF User's Guide, https://www.unidata.ucar.edu/software/netcdf/documentation/NUG/

"""
Expand Down
5 changes: 2 additions & 3 deletions lib/iris/fileformats/netcdf.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@

See also: `netCDF4 python <http://code.google.com/p/netcdf4-python/>`_.

Also refer to document 'NetCDF Climate and Forecast (CF) Metadata Conventions',
Version 1.4, 27 February 2009.
Also refer to document 'NetCDF Climate and Forecast (CF) Metadata Conventions'.

"""

Expand Down Expand Up @@ -2490,7 +2489,7 @@ def save(
"""
Save cube(s) to a netCDF file, given the cube and the filename.

* Iris will write CF 1.5 compliant NetCDF files.
* Iris will write CF 1.7 compliant NetCDF files.
* The attributes dictionaries on each cube in the saved cube list
will be compared and common attributes saved as NetCDF global
attributes where appropriate.
Expand Down
2 changes: 1 addition & 1 deletion requirements/ci/py36.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ dependencies:
# Core dependencies.
- cartopy>=0.18
- cf-units>=2
- cftime
- cftime<1.3.0
- dask>=2
- matplotlib
- netcdf4
Expand Down
2 changes: 1 addition & 1 deletion requirements/ci/py37.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ dependencies:
# Core dependencies.
- cartopy>=0.18
- cf-units>=2
- cftime
- cftime<1.3.0
- dask>=2
- matplotlib
- netcdf4
Expand Down