diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-exp-ff.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-exp-ff.txt index 736a952986..9e6da8ac27 100644 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-exp-ff.txt +++ b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-exp-ff.txt @@ -1 +1,8 @@ -* Removed deprecated module ```iris.experimental.fieldsfile```. \ No newline at end of file +* Removed deprecated module ```iris.experimental.fieldsfile```. + Note that there is no direct replacment for + ```:meth:iris.experimental.fieldsfile.load```, which specifically performed + fast loading from _either_ PP or FF files. + Instead, please enable `:meth:iris.fileformats.um.structured_um_loading` and + within that context call `:meth:iris.load`, or the format-specific + `:meth:iris.fileformats.pp.load_cubes` or + `:meth:iris.fileformats.um.load_cubes`. diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-ff.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-ff.txt index 2257f9d840..d140686f61 100644 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-ff.txt +++ b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-ff.txt @@ -1 +1,2 @@ -* Removed deprecated module ```iris.fileformats.ff```. \ No newline at end of file +* Removed deprecated module ```iris.fileformats.ff```. + Please use facilities in `:mod:iris.fileformats.um` instead. \ No newline at end of file diff --git a/lib/iris/fileformats/um/__init__.py b/lib/iris/fileformats/um/__init__.py index 3625f79a62..72169bc276 100644 --- a/lib/iris/fileformats/um/__init__.py +++ b/lib/iris/fileformats/um/__init__.py @@ -15,7 +15,10 @@ # You should have received a copy of the GNU Lesser General Public License # along with Iris. If not, see . """ -Provides iris loading support for UM file types, FieldsFile and PP. +Provides iris loading support for UM Fieldsfile-like file types, and PP. + +At present, the only UM file types supported are true FieldsFiles and LBCs. +Other types of UM file may fail to load correctly (or at all). """ diff --git a/lib/iris/fileformats/um/_ff_replacement.py b/lib/iris/fileformats/um/_ff_replacement.py index 843c777f4a..835c0cd936 100644 --- a/lib/iris/fileformats/um/_ff_replacement.py +++ b/lib/iris/fileformats/um/_ff_replacement.py @@ -15,9 +15,9 @@ # You should have received a copy of the GNU Lesser General Public License # along with Iris. If not, see . """ -Support for UM file types. +Support for UM "fieldsfile-like" files. -At present, only FieldsFiles and LBCs are supported. +At present, the only UM file types supported are true FieldsFiles and LBCs. Other types of UM file may fail to load correctly (or at all). """ @@ -32,7 +32,7 @@ def um_to_pp(filename, read_data=False, word_depth=None): """ - Extract the individual PPFields from within a UM file. + Extract individual PPFields from within a UM Fieldsfile-like file. Returns an iterator over the fields contained within the FieldsFile, returned as :class:`iris.fileformats.pp.PPField` instances. @@ -71,7 +71,7 @@ def um_to_pp(filename, read_data=False, word_depth=None): def load_cubes(filenames, callback, constraints=None, _loader_kwargs=None): """ - Loads cubes from a list of UM files filenames. + Loads cubes from filenames of UM fieldsfile-like files. Args: @@ -96,7 +96,8 @@ def load_cubes(filenames, callback, constraints=None, def load_cubes_32bit_ieee(filenames, callback, constraints=None): """ - Loads cubes from a list of 32bit ieee converted UM files filenames. + Loads cubes from filenames of 32bit ieee converted UM fieldsfile-like + files. .. seealso::