| | |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Testing** | [](https://github.com/tektronix/tm_data_types/actions/workflows/test-code.yml) [](https://github.com/tektronix/tm_data_types/actions/workflows/test-docs.yml) [](https://codecov.io/gh/tektronix/tm_data_types) |
| **Code Quality** | [](https://github.com/tektronix/tm_data_types/actions/workflows/codeql-analysis.yml) [](https://www.codefactor.io/repository/github/tektronix/tm_data_types) [](https://results.pre-commit.ci/latest/github/tektronix/tm_data_types/main) |
| **Package** | [](https://pypi.org/project/tm_data_types/) [](https://pypi.org/project/tm_data_types/) [](https://pypi.org/project/tm_data_types/) [](https://pepy.tech/project/tm_data_types) [](https://github.com/tektronix/tm_data_types/blob/main/LICENSE.md) [](https://github.com/tektronix/tm_data_types/actions/workflows/package-build.yml) [](https://github.com/tektronix/tm_data_types/actions/workflows/package-release.yml) |
| **Documentation** | [](https://tm-data-types.readthedocs.io) |
| **Code Style** | [](https://github.com/pytest-dev/pytest) [](https://docs.astral.sh/ruff/formatter/) [](https://google.github.io/styleguide/pyguide.html) |
| **Linting** | [](https://github.com/pre-commit/pre-commit) [](https://github.com/PyCQA/docformatter)[](https://github.com/pylint-dev/pylint) |
tm_data_types: Test & Measurement Data Types
tm_data_types provides tools to convert, edit, and write waveform data from Test & Measurement devices.
It simplifies handling waveform formats like CSV, WFM, and BIN in Python.
tm_data_types can be used to:
- Convert CSV, WFM, and BIN format into a waveform object,
- Add or edit waveform metadata,
- Write a valid waveform object to a file.
Supported File Formats
| Interface | File formats |
| --------- | ------------------ |
| Reader | **.csv, .wfm[^1]** |
| Writer | **.csv, .wfm[^1]** |
Installation
pip install tm_data_types
Basic Usage
Write File
from tm_data_types import AnalogWaveform, write_file
waveform = AnalogWaveform()
file_path = "waveform_1.wfm"
write_file(file_path, waveform)
Read File
from tm_data_types import read_file
file_path = "waveform_1.wfm"
waveform = read_file(file_path)
Documentation
See the full documentation at https://tm-data-types.readthedocs.io
Maintainers
Before reaching out to any maintainers directly, please first check if
your issue or question is already covered by any open
issues. If the issue or
question you have is not already covered, please file a new
issue or
start a
discussion and
the maintainers will review and respond there.
Contributing
Interested in contributing? Check out the contributing guidelines. Please
note that this project is released with a Code of Conduct. By
contributing to this project, you agree to abide by its terms.
License
tm_data_types was created by Tektronix. It is licensed under the terms of
the Apache License 2.0.
Security
The signatures of the files uploaded to PyPI and each
GitHub Release can be verified using
the GitHub CLI attestation verify command.
The artifact attestations can also be directly downloaded from the
GitHub repo attestations page if desired.
gh attestation verify --owner tektronix <file>
[^1]: Currently, tm_data_types only supports the Tektronix proprietary .wfm format. Support for other formats is planned for future releases.