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.
Project description
tsdf
| Badges | |
|---|---|
| Packages and Releases |    |
| Build Status |   |
| DOI |  |
| License |  |
| Fairness |   |
A package (documentation) to load TSDF data (specification) into Python.
Installation
Using pip
The package is available in PyPi and requires Python 3.9 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 mkdocs to build the documentation. If you want to build the documentation locally, the following commands will prove useful:
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 was created by Kasper Claes, Valentina Ticcinelli, Reham Badawy, Yordan P. Raykov, Luc J.W. Evers, Max A. Little.
- This package was created with
cookiecutterand thepy-pkgs-cookiecuttertemplate.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
