From 7d61b55ffee2e6de2f46400aee03ae32c4db05ad Mon Sep 17 00:00:00 2001 From: Erik Post <57133568+Erikpostt@users.noreply.github.com> Date: Tue, 21 Jan 2025 16:22:26 +0100 Subject: [PATCH] Bump for pypi versioning (#124) * Bump for pypi versioning * Change authors * Update abstract readme and authorship * Update badge to general DOI --- CITATION.cff | 71 ++++++++++++++++++++++++-------------------------- README.md | 30 ++++++++++++++------- docs/conf.py | 4 +-- poetry.lock | 18 ++++++------- pyproject.toml | 15 ++++++----- 5 files changed, 73 insertions(+), 65 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index 864b4079..e449ade9 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -3,31 +3,13 @@ cff-version: 1.2.0 title: >- - Paradigma: Toolbox for Digital Biomarkers in Parkinson's - Disease + ParaDigMa: Parkinson's Disease Digital Markers Toolbox message: >- If you use this software, please cite it using the metadata from this file. type: software authors: - - given-names: Peter - family-names: Kok - email: p.kok@esciencecenter.nl - affiliation: Netherlands eScience Center - orcid: 'https://orcid.org/0000-0002-6630-7326' - - given-names: Vedran - family-names: Kasalica - email: v.kasalica@esciencecenter.nl - affiliation: Netherlands eScience Center - orcid: 'https://orcid.org/0000-0002-0097-1056' - - given-names: Luc J.W. - family-names: Evers - email: luc.evers@radboudumc.nl - affiliation: >- - Radboud University, Nijmegen, Netherlands; Radboud - University Medical Center, Nijmegen, Netherlands - orcid: 'https://orcid.org/0000-0002-8241-5087' - - given-names: Erik +- given-names: Erik family-names: Post email: erik.post@radboudumc.nl affiliation: >- @@ -53,26 +35,41 @@ authors: Center for Engineering, Modeling and Applied Social Sciences (CECS), Federal University of ABC (UFABC), Brazil + - given-names: Vedran + family-names: Kasalica + email: v.kasalica@esciencecenter.nl + affiliation: Netherlands eScience Center + orcid: 'https://orcid.org/0000-0002-0097-1056' + - given-names: Peter + family-names: Kok + email: p.kok@esciencecenter.nl + affiliation: Netherlands eScience Center + orcid: 'https://orcid.org/0000-0002-6630-7326' + - given-names: Luc J.W. + family-names: Evers + email: luc.evers@radboudumc.nl + affiliation: >- + Radboud University, Nijmegen, Netherlands; Radboud + University Medical Center, Nijmegen, Netherlands + orcid: 'https://orcid.org/0000-0002-8241-5087' repository-code: 'https://github.com/biomarkersParkinson/paradigma' url: 'https://biomarkersparkinson.github.io/paradigma/' abstract: >- - Paradigma: Digital Biomarkers for Parkinson's Disease - Toolbox is a Python software package designed for - processing wearable sensor data to identify digital - biomarkers associated with Parkinson’s disease (PD). The - toolbox facilitates the detection and analysis of sensor - data, focusing on key gait and photoplethysmography (PPG) - features that are critical for PD research. By leveraging - the Time Series Data Format (TSDF), a unified and - user-friendly format for handling both numerical data and - metadata, Paradigma simplifies the process of working with - raw binary sensor measurements alongside JSON-based - metadata. The toolbox enables researchers to efficiently - extract PD biomarkers, aiding in early diagnosis and - monitoring. Future updates will introduce tremor detection - and expanded feature extraction capabilities, further - enhancing its utility for PD research and clinical - applications. + The Parkinsons Disease Digital Markers (ParaDigMa) toolbox is a Python + software package designed for processing passively collected wrist + sensor data to extract digital measures of motor and non-motor signs + of Parkinson's disease (PD). + + Specifically, the toolbox contains three data processing pipelines: + (1) arm swing during gait, (2) tremor, and (3) heart rate analysis. + Furthermore, the toolbox contains general functionalities for signal + processing and feature extraction, such as filtering, peak detection, + and spectral analysis. The toolbox is designed to be user-friendly and + modular, enabling researchers to easily extend the toolbox with new + algorithms and functionalities. The toolbox is accompanied by a set of + example scripts and notebooks for each domain that demonstrate how to use + the toolbox for processing sensor data and extracting digital measures. + keywords: - parkinson's disease - digital biomarkers diff --git a/README.md b/README.md index 7b6a8c0e..2b28e1e9 100644 --- a/README.md +++ b/README.md @@ -5,22 +5,31 @@ | Badges | | |:----:|----| | **Packages and Releases** | [![Latest release](https://img.shields.io/github/release/biomarkersparkinson/paradigma.svg)](https://github.com/biomarkersparkinson/paradigma/releases/latest) [![PyPI](https://img.shields.io/pypi/v/paradigma.svg)](https://pypi.python.org/pypi/paradigma/) [![Static Badge](https://img.shields.io/badge/RSD-paradigma-lib)](https://research-software-directory.org/software/paradigma) | -| **DOI** | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13838393.svg)](https://doi.org/10.5281/zenodo.13838393) | +| **DOI** | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13838392.svg)](https://doi.org/10.5281/zenodo.13838392) | | **Build Status** | [![](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/) [![Build and test](https://github.com/biomarkersParkinson/paradigma/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/biomarkersParkinson/paradigma/actions/workflows/build-and-test.yml) [![pages-build-deployment](https://github.com/biomarkersParkinson/paradigma/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/biomarkersParkinson/paradigma/actions/workflows/pages/pages-build-deployment) | | **License** | [![GitHub license](https://img.shields.io/github/license/biomarkersParkinson/paradigma)](https://github.com/biomarkersparkinson/paradigma/blob/main/LICENSE) | ## Introduction -ParaDigMa is a Python package for processing time series data of wrist-worn sensors to quantify signs of Parkinson’s disease (PD). It contains functionalities for processing the following sensor types: +The Parkinsons Disease Digital Markers (ParaDigMa) toolbox is a Python +software package designed for processing passively collected wrist +sensor data to extract digital measures of motor and non-motor signs +of Parkinson's disease (PD). + +Specifically, the toolbox contains three data processing pipelines: +(1) arm swing during gait, (2) tremor, and (3) heart rate analysis. +Furthermore, the toolbox contains general functionalities for signal +processing and feature extraction, such as filtering, peak detection, +and spectral analysis. The toolbox is designed to be user-friendly and +modular, enabling researchers to easily extend the toolbox with new +algorithms and functionalities. The toolbox is accompanied by a set of +example scripts and notebooks for each domain that demonstrate how to use +the toolbox for processing sensor data and extracting digital measures. + +It contains functionalities for processing the following sensor types: - Inertial Measurement Units (accelerometer, gyroscope) -- Photoplethysmogram (PPG) - -And analyses of the following motor and non-motor domains: - -- Gait -- Tremor -- Heart Rate +- Photoplethysmogram (PPG) ## More about ParaDigMa The components of ParaDigMa are visually shown in the diagram below. @@ -97,7 +106,8 @@ Interested in contributing? Check out the contributing guidelines. Please note t ## License -ParaDigMa was created by Peter Kok, Vedran Kasalica, Erik Post, Kars Veldkamp, Nienke Timmermans, Diogo Coutinho Soriano, Luc Evers. It is licensed under the terms of the Apache License 2.0 license. +The core team of ParaDigMa consists of Erik Post, Kars Veldkamp, Nienke Timmermans, Diogo Coutinho Soriano, Luc Evers, +Peter Kok and Vedran Kasalica. Advisors to the project are Max Little, Jordan Raykov, Twan van Laarhoven, Hayriye Cagnan, and Bas Bloem. It is licensed under the terms of the Apache License 2.0 license. ## Credits diff --git a/docs/conf.py b/docs/conf.py index 6dc10011..ccfac6b0 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -7,9 +7,9 @@ # -- Project information ----------------------------------------------------- project = "paradigma" -copyright = "2023, Erik Post, Kars Veldkamp, Nienke Timmermans, Peter Kok, Vedran Kasalica, Diogo Coutinho Soriano, Luc Evers" +copyright = "2025, Erik Post, Kars Veldkamp, Nienke Timmermans, Diogo Coutinho Soriano, Vedran Kasalica, Peter Kok, and Luc Evers" author = ( - "Erik Post, Kars Veldkamp, Nienke Timmermans, Peter Kok, Vedran Kasalica, Diogo Coutinho Soriano, Luc Evers" + "Erik Post, Kars Veldkamp, Nienke Timmermans, Diogo Coutinho Soriano, Vedran Kasalica, Peter Kok, and Luc Evers" ) # -- General configuration --------------------------------------------------- diff --git a/poetry.lock b/poetry.lock index c42ca426..1810be3b 100644 --- a/poetry.lock +++ b/poetry.lock @@ -906,13 +906,13 @@ networkx = ">=2" [[package]] name = "importlib-metadata" -version = "8.5.0" +version = "8.6.1" description = "Read metadata from Python packages" optional = false -python-versions = ">=3.8" +python-versions = ">=3.9" files = [ - {file = "importlib_metadata-8.5.0-py3-none-any.whl", hash = "sha256:45e54197d28b7a7f1559e60b95e7c567032b602131fbd588f1497f47880aa68b"}, - {file = "importlib_metadata-8.5.0.tar.gz", hash = "sha256:71522656f0abace1d072b9e5481a48f07c138e00f079c38c8f883823f9c26bd7"}, + {file = "importlib_metadata-8.6.1-py3-none-any.whl", hash = "sha256:02a89390c1e15fdfdc0d7c6b25cb3e62650d0494005c97d6f148bf5b9787525e"}, + {file = "importlib_metadata-8.6.1.tar.gz", hash = "sha256:310b41d755445d74569f993ccfc22838295d9fe005425094fad953d7f15c8580"}, ] [package.dependencies] @@ -924,7 +924,7 @@ cover = ["pytest-cov"] doc = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"] enabler = ["pytest-enabler (>=2.2)"] perf = ["ipython"] -test = ["flufl.flake8", "importlib-resources (>=1.3)", "jaraco.test (>=5.4)", "packaging", "pyfakefs", "pytest (>=6,!=8.1.*)", "pytest-perf (>=0.9.2)"] +test = ["flufl.flake8", "importlib_resources (>=1.3)", "jaraco.test (>=5.4)", "packaging", "pyfakefs", "pytest (>=6,!=8.1.*)", "pytest-perf (>=0.9.2)"] type = ["pytest-mypy"] [[package]] @@ -1983,13 +1983,13 @@ testing = ["pytest", "pytest-benchmark"] [[package]] name = "prompt-toolkit" -version = "3.0.48" +version = "3.0.50" description = "Library for building powerful interactive command lines in Python" optional = false -python-versions = ">=3.7.0" +python-versions = ">=3.8.0" files = [ - {file = "prompt_toolkit-3.0.48-py3-none-any.whl", hash = "sha256:f49a827f90062e411f1ce1f854f2aedb3c23353244f8108b89283587397ac10e"}, - {file = "prompt_toolkit-3.0.48.tar.gz", hash = "sha256:d6623ab0477a80df74e646bdbc93621143f5caf104206aa29294d53de1a03d90"}, + {file = "prompt_toolkit-3.0.50-py3-none-any.whl", hash = "sha256:9b6427eb19e479d98acff65196a307c555eb567989e6d88ebbb1b509d9779198"}, + {file = "prompt_toolkit-3.0.50.tar.gz", hash = "sha256:544748f3860a2623ca5cd6d2795e7a14f3d0e1c3c9728359013f79877fc89bab"}, ] [package.dependencies] diff --git a/pyproject.toml b/pyproject.toml index b5fa7bdd..07fd90fc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,14 +1,15 @@ [tool.poetry] name = "paradigma" -version = "0.4.0" +version = "0.4.1" description = "Paradigma - a toolbox for Digital Biomarkers for Parkinson's Disease" -authors = [ "Peter Kok ", +authors = [ "Erik Post ", + "Kars Veldkamp ", + "Nienke Timmermans ", + "Diogo Soriano", "Vedran Kasalica ", - "Erik Post", - "Kars Veldkamp", - "Nienke Timmermans", - "Diogo Coutinho Soriano", - "Luc Evers" ] + "Peter Kok ", + "Luc Evers ", + ] license = "Apache License 2.0" readme = "README.md"