pencil.read.phiaverages
=======================

.. py:module:: pencil.read.phiaverages

.. autoapi-nested-parse::

   Contains the classes and methods to read phi-averaged files.



Classes
-------

.. autoapisummary::

   pencil.read.phiaverages.Averages


Functions
---------

.. autoapisummary::

   pencil.read.phiaverages.phiaver


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

.. py:class:: Averages

   Bases: :py:obj:`object`


   Averages -- holds Pencil Code averages data and methods.

   Fill members with default values.


   .. py:attribute:: t


   .. py:method:: keys()


   .. py:method:: read(datadir='data', avg_file=None, var_index=-1, iter_list=None, precision='f', param=None)

       read(datadir="data", avg_file="1", var_index=-1, iter_list=None, precision="f", param=None)

       Read Pencil Code phi-averaged data.


       Keyword arguments:

      datadir : string
          Directory where the data is stored.

      avg_file : int
          Number of average file to be read.

      var_index : int
          Index of single variable taken from among the 'phi' averages.
          Takes an integer value < len(phiaver.in).

      iter_list : list of int
          Iteration indices for which to sample the slices.

      precision : string
          Float (f), double (d) or half (half).

      param     : Param object
          Param object belonging to the simulation.



.. py:function:: phiaver(*args, **kwargs)

   Wrapper for :py:meth:`Averages.read`