Metadata-Version: 2.1
Name: tsdf
Version: 0.4.0
Summary: A Python library that provides methods for encoding and decoding TSDF (Time Series Data Format) data, which allows you to easily create, manipulate and serialize TSDF files in your Python code.
Home-page: https://github.com/biomarkersParkinson/tsdf
License: Apache-2.0
Keywords: Time Series Data Format (TSDF),binary data,digital sensors
Author: Peter Kok
Author-email: p.kok@esciencecenter.nl
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: flatten-json (>=0.1.13,<0.2.0)
Requires-Dist: mkdocs (>=1.4.2,<2.0.0)
Requires-Dist: mkdocs-jupyter (>=0.22.0,<0.23.0)
Requires-Dist: mypy (>=1.0.1,<2.0.0)
Requires-Dist: numpy (>=1.24.1,<2.0.0)
Project-URL: Repository, https://github.com/biomarkersParkinson/tsdf
Description-Content-Type: text/markdown


![Python package](https://github.com/biomarkersparkinson/tsdf/workflows/Python%20package/badge.svg)
[![PyPI](https://img.shields.io/pypi/v/tsdf.svg)](https://pypi.python.org/pypi/tsdf/)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7867900.svg)](https://doi.org/10.5281/zenodo.7867900)

# tsdf

A package to load [TSDF data](https://arxiv.org/abs/2211.11294) into Python

## Installation

### Using `pip`

The package is available in PyPi. It can be installed using:

```bash
$ pip install tsdf
```

## Usage

See our [extended tutorials](https://biomarkersparkinson.github.io/tsdf/).

## Development

### Running tests

```bash
poetry install
poetry run pytest
```

### Building the documentation

We use [mkdocs](https://www.mkdocs.org/) to build the documentation. If you want to build the documentation locally, the following commands will prove useful:

```bash
mkdocs build       # build the documentation
mkdocs serve       # serve the documentation on a local server
mkdocs gh-deploy   # deploy the documentation to GitHub pages
```

## 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

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](https://arxiv.org/abs/2211.11294) 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`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).

