pencil_ccyang.plot
==================

.. py:module:: pencil_ccyang.plot


Functions
---------

.. autoapisummary::

   pencil_ccyang.plot.avg1d
   pencil_ccyang.plot.time_series


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

.. py:function:: avg1d(name, datadir='./data', logscale=False, plane='xy', tsize=None, **kwargs)

   Plots the space-time diagram of a 1D average.

   Positional Arguments:
       name
           Name of the average to be plotted.

   :keyword datadir: Name of the data directory.
   :keyword logscale: Take logarithm or not.
   :keyword plane: Plane of the average.
   :keyword tsize: Number of regular time intervals; if None, it is
                   automatically determined.
   :keyword \*\*kwargs: Sent to matplotlib.pyplot.imshow.


.. py:function:: time_series(diagnostics, datadir='./data', trange=None, xlog=False, ylog=False)

   Plots diagnostic variable(s) as a function of time.

   Positional Arguments:
       diagnostics
           (A list of) diagnostic variable(s).

   :keyword datadir: Name of the data directory.
   :keyword trange: A tuple of (tmin, tmax) for the time range to be shown; if
                    None, all time is shown.
   :keyword xlog: A boolean value for turning on or off logarithmic scale in
                  x axis.
   :keyword ylog: A boolean value for turning on or off logarithmic scale in
                  y axis.