https://github.com/l-johnston/nitdms

A pythonic reader for TDMS files generated by National Instrument's LabVIEW
https://github.com/l-johnston/nitdms

labview python tdms

Last synced: 4 months ago
JSON representation

A pythonic reader for TDMS files generated by National Instrument's LabVIEW

• Host: GitHub
• URL: https://github.com/l-johnston/nitdms
• Owner: l-johnston
• License: mit
• Created: 2019-10-13T05:01:51.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-02-05T17:46:36.000Z (over 4 years ago)
• Last Synced: 2025-03-26T11:03:49.013Z (about 1 year ago)
• Topics: labview, python, tdms
• Language: Python
• Homepage: https://l-johnston.github.io/nitdms/
• Size: 1.55 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://dev.azure.com/l-johnston/nitdms/_apis/build/status/l-johnston.nitdms?branchName=master)](https://img.shields.io/azure-devops/build/l-johnston/nitdms/14) ![Azure DevOps coverage](https://img.shields.io/azure-devops/coverage/l-johnston/nitdms/14) ![PyPI version](https://img.shields.io/pypi/v/nitdms)

# `nitdms` - A pythonic TDMS file reader

The main export from the `nitdms` package is the TdmsFile class. Upon instantiation,

the reader loads the file into memory and discovers all of the file, group and channel

objects and respective properties. These objects and properties are dynamically 

instantiated as attributes allowing easy access from within an interactive session

with tab completion such as Jupyter or bash.

Channel data is returned as a numpy ndarray, or WaveformDT if data in the file is from

LabVIEW's waveform data type. WaveformDT is a subclass of ndarray that mimics

the waveform data type.

LabVIEW's timestamp is stored as UTC in the TDMS file. `nitdms` returns the timestamp

in the machine's local time zone consistent with LabVIEW and aligns with WaveformDT.

## Installing

```bash

$ pip install nitdms

```

## Usage

Within an interactive session with tab completion:

```python

>>> from nitdms import TdmsFile

>>> tf = TdmsFile()

>>> data = tf...data

>>> t0 = tf...wf_start_time

>>> dt = tf...wf_increment

>>> group_property = tf..

```

## Documentation

https://l-johnston.github.io/nitdms/