Skip to content

Iris animate docs #2731

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 1 commit into from
Oct 16, 2017
Merged

Iris animate docs #2731

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 7 additions & 3 deletions lib/iris/experimental/animate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# (C) British Crown Copyright 2013 - 2015, Met Office
# (C) British Crown Copyright 2013 - 2017, Met Office
#
# This file is part of Iris.
#
Expand Down Expand Up @@ -40,8 +40,12 @@ def animate(cube_iterator, plot_func, fig=None, **kwargs):
Each animation frame corresponds to each :class:`iris.cube.Cube`
object. See :meth:`iris.cube.Cube.slices`.

* plot_func (:mod:`~iris.plot` or :mod:`~iris.quickplot` plot):
Plotting function used to animate.
* plot_func (:mod:`iris.plot` or :mod:`iris.quickplot` plotting function):
Plotting function used to animate. Must accept the signature
``plot_func(cube, vmin=vmin, vmax=vmax, coords=coords)``.
:func:`~iris.plot.contourf`, :func:`~iris.plot.contour`,
:func:`~iris.plot.pcolor` and :func:`~iris.plot.pcolormesh`
all conform to this signature.

Kwargs:

Expand Down