Skip to content

biomarkersParkinson/tsdf

Repository files navigation

tsdf

Badges
Packages and Releases Latest release PyPI Static Badge
Build Status Python package
DOI DOI
License GitHub license
Fairness fair-software.eu OpenSSF Best Practices

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

Installation

Using pip

The package is available in PyPi and requires Python 3.10 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.