Skip to content

Latest commit

 

History

History
117 lines (83 loc) · 3.48 KB

README.md

File metadata and controls

117 lines (83 loc) · 3.48 KB

taffmat

PyPi Version Build Status Coverage Status License Badge

A Python 3.4+ module for reading and writing Teac TAFFmat files.

About the TAFFmat file format

TAFFmat is Teac's proprietary file format used to store data from their LX series and other data recorders.

According to the Teac "LX Series Recording Unit Instruction Manual":

TAFFmat (an acronym for Teac Data Acquisition File Format) is a file format composed of the following:

  • a data file containing A/D (analog to digital) converted data. The file is binary format with the extension dat.
  • a header file containing information such as recording conditions. The file is in text format with the extension hdr.

TAFFmat is a trademark of Teac Corporation.

Data Recorders Using TAFFmat

The following data recorders store their data in the TAFFmat file format:

Installation

You can install taffmat either via the Python Package Index (PyPI) or from source.

To install using pip:

$ pip install taffmat

Source: https://github.com/questrail/taffmat

Requirements

taffmat requires the following Python packages:

Public API

The following functions are provided:

  • change_slope(data_array, series, gain)
  • read_taffmat(input_file)
  • write_taffmat(data_array, header_data, output_base_filename)
  • write_taffmat_slice(data_array, header_data, output_base_filename, starting_data_index, ending_data_index

Contributing

Contributions are welcome! To contribute please:

  1. Fork the repository
  2. Create a feature branch
  3. Add code and tests
  4. Pass lint and tests
  5. Submit a pull request

Development Setup

Development Setup Using pyenv

Use the following commands to create a Python 3.9.9 virtualenv using pyenv and pyenv-virtualenv, install the requirements in the virtualenv named taffmat, and list the available Invoke tasks.

$ pyenv virtualenv 3.9.9 taffmat
$ pyenv activate taffmat
$ pip install -r requirements.txt
$ inv -l

License

taffmat is released under the MIT license. Please see the LICENSE.txt file for more information.