tsdf

Badges
Packages and Releases
Build Status
DOI
License
Fairness

A package (documentation) to load TSDF data (specification) into Python.

Overview

The tsdf package is a comprehensively documented reference implementation of the Time Series Data Format (TSDF) standard [1]. TSDF simplifies data storage and exchange of multi-channel digital sensor data, thereby promoting interpretability and reproducibility of scientific results. Sensor measurements and timestamps are stored as raw tabular binary array files. To ensure unambiguous reconstruction, binary array files are accompanied by human-readable JavaScript Object Notation (JSON) metadata files, which contain a set of mandatory fields limited to essential sensor measurement information.

The tsdf Python package implements functions for reading and writing TSDF files. It guarantees formatting and metadata consistency. It enforces usage of the essential metadata such as study identification, time frame, data channel descriptions and data attributes corresponding to the binary data.

Installation

Using `pip`

The package is available in PyPi and requires Python 3.11 or higher. It can be installed using:

$ pip install tsdf

Usage

See our extended tutorials.

Development

Running tests

poetry install
poetry run pytest

Building the documentation

We use Sphinx to build the documentation. Use this command to build the documentation locally:

poetry run make html --directory docs

Contributing

We welcome contributions! Please see our Contributing Guidelines for more details on coding standards, how to get started, and the submission process.

Code of Conduct

To ensure a welcoming and respectful community, all contributors and participants are expected to adhere to our Code of Conduct. By participating in this project, you agree to abide by its terms.

License

This package was created by Pablo Rodríguez, Peter Kok and Vedran Kasalica. It is licensed under the terms of the Apache License 2.0 license.

Credits

The TSDF data format was created by Kasper Claes, Valentina Ticcinelli, Reham Badawy, Yordan P. Raykov, Luc J.W. Evers, Max A. Little.
This package was created with cookiecutter and the py-pkgs-cookiecutter template.