pencil.read.indices
===================

.. py:module:: pencil.read.indices

.. autoapi-nested-parse::

   Contains the index information.



Classes
-------

.. autoapisummary::

   pencil.read.indices.Index


Functions
---------

.. autoapisummary::

   pencil.read.indices.index


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

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

   index(datadir='data', param=None, dim=None)

   Read Pencil Code index data from index.pro.

   :param datadir: Directory where the data is stored.
   :type datadir: string
   :param param: Parameter object.
   :type param: obj
   :param dim: Dimension object.
   :type dim: obj

   :rtype: Class containing the index information.


.. py:class:: Index

   Bases: :py:obj:`object`


   Index -- holds pencil code index data.

   Fill members with default values.


   .. py:method:: keys()


   .. py:method:: read(datadir='data', filename=None, param=None, dim=None)

      read(datadir='data', param=None, dim=None)

      Read Pencil Code index data from index.pro or other filename.

      :param datadir: Directory where the data is stored.
      :type datadir: string
      :param filename: If present replace "index.pro"
      :type filename: bool
      :param param: Parameter object.
      :type param: obj
      :param dim: Dimension object.
      :type dim: obj

      :rtype: Class containing the index information.