pencil_ccyang.animate
=====================

.. py:module:: pencil_ccyang.animate


Functions
---------

.. autoapisummary::

   pencil_ccyang.animate.avg2d
   pencil_ccyang.animate.slices


Module Contents
---------------

.. py:function:: avg2d(name, direction, datadir='./data', save=False, **kwarg)

   Animates the time sequence of a line average.

   Positional Argument:
       name
           Name of the average.
       direction
           Direction of the average: 'x', 'y', or 'z'.

   :keyword datadir: Path to the data directory.
   :keyword save: If True, save the animation.
   :keyword \*\*kwarg: Keyword arguments passed to _get_range().


.. py:function:: slices(field, datadir='./data', tmin=None, **kwarg)

   Dispatches to the respective animator of video slices.

   Positional Argument:
       field
           Field name.

   :keyword datadir: Path to the data directory.
   :keyword tmin: If not None, the slices with time earlier than tmin are
                  truncated.
   :keyword \*\*kwarg: Keyword arguments passed to _get_range().