Metadata-Version: 2.1
Name: npTDMS
Version: 0.23.0
Summary: Cross-platform, NumPy based module for reading TDMS files produced by LabView.
Home-page: https://github.com/adamreeve/npTDMS
Author: Adam Reeve
Author-email: adreeve@gmail.com
License: LGPL
Description: npTDMS
        ======
        
        .. image:: https://travis-ci.com/adamreeve/npTDMS.svg?branch=master
            :alt: Build status
            :target: https://travis-ci.com/adamreeve/npTDMS
        .. image:: https://readthedocs.org/projects/nptdms/badge/?version=latest
            :target: https://nptdms.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        .. image:: https://codecov.io/gh/adamreeve/npTDMS/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/adamreeve/npTDMS
            :alt: Code coverage
        
        
        npTDMS is a cross-platform Python package for reading and writing TDMS files as produced by LabVIEW,
        and is built on top of the `numpy <http://www.numpy.org/>`__ package.
        Data read from a TDMS file is stored in numpy arrays,
        and numpy arrays are also used when writing TDMS file.
        
        TDMS files can contain multiple data channels organised intro groups.
        Typical usage when reading a TDMS file might look like::
        
            from nptdms import TdmsFile
        
            tdms_file = TdmsFile.read("path_to_file.tdms")
            channel = tdms_file['Group']['Channel1']
            data = channel.data
            time = channel.time_track()
            # do stuff with data
        
        And to write a file::
        
            from nptdms import TdmsWriter, ChannelObject
            import numpy
        
            with TdmsWriter("path_to_file.tdms") as tdms_writer:
                data_array = numpy.linspace(0, 1, 10)
                channel = ChannelObject('Group', 'Channel1', data_array)
                tdms_writer.write_segment([channel])
        
        For more information, see the `npTDMS documentation <http://nptdms.readthedocs.io>`__.
        
        Installation
        ------------
        
        npTDMS is available from the Python Package Index, so the easiest way to
        install it is by running::
        
            pip install npTDMS
        
        There are optional features available that require additional dependencies.
        These are `hdf` for hdf export, `pandas` for pandas DataFrame export, and
        `thermocouple_scaling` for using thermocouple scalings. You can specify these
        extra features when installing npTDMS to also install the dependencies they
        require::
        
            pip install npTDMS[hdf,pandas,thermocouple_scaling]
        
        Alternatively, after downloading the source code you can extract it and
        change into the new directory, then run::
        
            python setup.py install
        
        Links
        -----
        
        Source code lives at https://github.com/adamreeve/npTDMS and any issues can be
        reported at https://github.com/adamreeve/npTDMS/issues.
        Documentation is available at http://nptdms.readthedocs.io.
        
        Limitations
        -----------
        
        This module doesn't support TDMS files with XML headers or with
        extended floating point data.
        
        TDMS files support timestamps with a resolution of 2^-64 seconds but these
        are read as numpy datetime64 values with microsecond resolution.
        
        Contributors/Thanks
        -------------------
        
        Thanks to Floris van Vugt who wrote the pyTDMS module,
        which helped when writing this module.
        
        Thanks to Tony Perkins, Ruben De Smet, Martin Hochwallner and Peter Duncan
        for contributing support for converting to Pandas DataFrames.
        
        Thanks to nmgeek and jshridha for implementing support for DAQmx raw data
        files.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Provides-Extra: test
Provides-Extra: pandas
Provides-Extra: hdf
Provides-Extra: thermocouple_scaling
