pencil_ccyang.animate

Functions

avg2d(name, direction[, datadir, save])

Animates the time sequence of a line average.

slices(field[, datadir, tmin])

Dispatches to the respective animator of video slices.

Module Contents

pencil_ccyang.animate.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 Arguments:
  • datadir – Path to the data directory.

  • save – If True, save the animation.

  • **kwarg – Keyword arguments passed to _get_range().

pencil_ccyang.animate.slices(field, datadir='./data', tmin=None, **kwarg)

Dispatches to the respective animator of video slices.

Positional Argument:
field

Field name.

Keyword Arguments:
  • datadir – Path to the data directory.

  • tmin – If not None, the slices with time earlier than tmin are truncated.

  • **kwarg – Keyword arguments passed to _get_range().