pencil.read.pstalk
==================

.. py:module:: pencil.read.pstalk


Classes
-------

.. autoapisummary::

   pencil.read.pstalk.ParticleStalkData


Functions
---------

.. autoapisummary::

   pencil.read.pstalk.pstalk


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

.. py:class:: ParticleStalkData(datadir=False, sim=False, tmin=0, tmax=-1, noutmax='-1', swap_endian=False, quiet=False, use_existing_pstalk_sav=False)

   Bases: :py:obj:`object`


   ParticleStalkData -- holds Pencil Code PSTALK file data.

   Read PSTALK files from Pencil Code using IDL.
   Uses IDL<->Python Bridge, this must be activated manually!

   :param - datadir      specify datadir:
   :param default False:
   :param - sim           specify simulation from which you want to read:
   :param - swap_endian   change if needed to True:
   :param default False:
   :param - quiet         verbosity:
   :param default False:
   :param - use_existing_pstalk_sav: use existing <sim.datadir>/data/pc/tmp/pstalk.sav for speed up


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

   Wrapper for :py:class:`ParticleStalkData`