pencil.read.timeseries
======================

.. py:module:: pencil.read.timeseries

.. autoapi-nested-parse::

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



Classes
-------

.. autoapisummary::

   pencil.read.timeseries.TimeSeries


Functions
---------

.. autoapisummary::

   pencil.read.timeseries.ts


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

.. py:class:: TimeSeries

   Bases: :py:obj:`object`


   TimeSeries -- holds Pencil Code time series data.

   Fill members with default values.


   .. py:attribute:: t
      :value: []



   .. py:attribute:: keys
      :value: []



   .. py:method:: read(file_name='time_series.dat', datadir='data', quiet=False, comment_char='#', sim=None, unique_clean=False, time_range=None, precision='f')

      read(file_name='time_series.dat', datadir='data',
           quiet=False, comment_char='#', sim=None, unique_clean=False)

      Read Pencil Code time series data.

      :param file_name: Name of the time series file.
                        For supernova data change file_name to 'sn_series.dat'.
      :type file_name: string
      :param datadir: Directory where the data is stored.
      :type datadir: string
      :param quiet: Flag for switching off output.
      :type quiet: bool
      :param comment_char: Comment character in the time series file.
      :type comment_char: string
      :param sim: Simulation object from which to take the datadir.
      :type sim: obj
      :param unique_clean: Set True, np.unique is used to clean up the ts, e.g. remove errors
                           at the end of crashed runs.
      :type unique_clean: bool
      :param time_range: List of length 2, start and end time, of float with end time.
      :type time_range: bool
      :param precision: "f" (single,default) or "d" (double) or "h" (half).
      :type precision: str



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

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