crunchflow.output.timeseries
============================

.. py:module:: crunchflow.output.timeseries

.. autoapi-nested-parse::

   A module for loading and plotting CrunchFlow time series output files.

   ..
       !! processed by numpydoc !!


Classes
-------

.. toctree::
   :hidden:

   /autoapi/crunchflow/output/timeseries/TimeSeries

.. autoapisummary::

   crunchflow.output.timeseries.TimeSeries


Functions
---------

.. autoapisummary::

   crunchflow.output.timeseries.get_ts_coords
   crunchflow.output.timeseries.get_ts_duplicates


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

.. py:function:: get_ts_coords(tsfile)

   
   Given a CrunchFlow time series ouput file, return the coordinate
   at which that time series was output.


   :Parameters:

       **tsfile** : str
           filename containing timeseries output



   :Returns:

       **coords** : tuple of int
           Coordinates of the form (x, y, z)











   ..
       !! processed by numpydoc !!

.. py:function:: get_ts_duplicates(tsfile)

   
   Find duplicate columns in a time series file. Useful when a user
   specifies `time_series_print all` in CrunchFlow; the time series file
   includes primary species printed twice.


   :Parameters:

       **tsfile** : str
           path to the time series file



   :Returns:

       **columns** : list
           list of column headings without duplicates

       **nondup_indices** : list
           list of column indices without duplicates











   ..
       !! processed by numpydoc !!