Skip to content

Document replacement of "iris.fileformats.ff" and "iris.experimental.fieldsfile". #2850

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.

Sign up for GitHub

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

Merged
pelson merged 2 commits into from
Oct 26, 2017
Merged

Document replacement of "iris.fileformats.ff" and "iris.experimental.fieldsfile". #2850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b97f0a3
Code conversion notes for lost experimental function.
pp-mo Oct 24, 2017
91dac95
Also improve docs for fileformats.um and whatsnew for removal of expe…
pp-mo Oct 24, 2017
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
9 changes: 8 additions & 1 deletion docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-exp-ff.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,8 @@
* Removed deprecated module ```iris.experimental.fieldsfile```.
* 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
Copy link
Member

@ajdawson ajdawson Oct 24, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not make it clear what the replacement is, it needs to be explained in more detail, an example may be useful.

Copy link
Member

@pelson pelson Oct 24, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this will cross reference the docs at http://scitools.org.uk/iris/docs/latest/iris/iris/fileformats/um.html#iris.fileformats.um.structured_um_loading

Copy link
Member Author

@pp-mo pp-mo Oct 25, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will cross reference the docs at ... iris.fileformats.um.structured_um_loading

Yes, I thought that would be good enough : as it's only a whatsnew item, I think it can be a pointer rather than full info, no ?

within that context call `:meth:iris.load`, or the format-specific
`:meth:iris.fileformats.pp.load_cubes` or
`:meth:iris.fileformats.um.load_cubes`.
3 changes: 2 additions & 1 deletion docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-ff.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
* Removed deprecated module ```iris.fileformats.ff```.
* Removed deprecated module ```iris.fileformats.ff```.
Please use facilities in `:mod:iris.fileformats.um` instead.
5 changes: 4 additions & 1 deletion lib/iris/fileformats/um/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@
# You should have received a copy of the GNU Lesser General Public License
# along with Iris. If not, see <http://www.gnu.org/licenses/>.
"""
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).

"""

Expand Down
11 changes: 6 additions & 5 deletions lib/iris/fileformats/um/_ff_replacement.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
# You should have received a copy of the GNU Lesser General Public License
# along with Iris. If not, see <http://www.gnu.org/licenses/>.
"""
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).

"""
Expand 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.
Expand Down Expand Up @@ -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:

Expand All @@ -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::

Expand Down