pencil.read.zprof
=================

.. py:module:: pencil.read.zprof

.. autoapi-nested-parse::

   Contains the classes and methods to read the time series file.



Classes
-------

.. autoapisummary::

   pencil.read.zprof.ZProfile


Functions
---------

.. autoapisummary::

   pencil.read.zprof.zprof


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

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

   zprof(var_name, datadir='data', dim=None, nfield=1)

   Read vertical profiles written in data/proc*/zprof_varname.dat.
   Returns a ZProfile object with z and profiles(z).

   :param var_name: Name of the zprof var file.
   :type var_name: string
   :param datadir: Directory where the data is stored.
   :type datadir: string
   :param dim: Dimension object.
   :type dim: obj
   :param nfield: Number of fields to be read.
   :type nfield: int


.. py:class:: ZProfile

   Bases: :py:obj:`object`


   ZProfile -- holds the zprofile data.

   Fill members with default values.


   .. py:attribute:: prof
      :value: 0



   .. py:attribute:: z
      :value: 0



   .. py:method:: keys()


   .. py:method:: read(var_name, datadir='data', dim=None, nfield=1)

      read(var_name, datadir='data', dim=None, nfield=1)

      Read vertical profiles written in data/proc*/zprof_varname.dat.
      Returns a ZProfile object with z and profiles(z).

      :param var_name: Name of the zprof var file.
      :type var_name: string
      :param datadir: Directory where the data is stored.
      :type datadir: string
      :param dim: Dimension object.
      :type dim: obj
      :param nfield: Number of fields to be read.
      :type nfield: int