Merge pull request #48 from biomarkersParkinson/main

Make  a new release

.github/workflows/build-and-test.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.9']
+        python-version: ['3.10']
     outputs:
       version: ${{ steps.get_version.outputs.version }}
 
@@ -54,9 +54,9 @@ jobs:
     - name: Test with pytest
       run: |
         poetry run pytest
-    # - name: Type check
-    #   run: |
-    #     poetry run pytype .
+    - name: Type check
+      run: |
+        poetry run pytype .
 
     # Build the package
     - name: Build the package

.readthedocs.yml

@@ -7,7 +7,7 @@ build:
 
 # Configuration
 python:
-  version: 3.9
+  version: 3.10
   install:
     - requirements: docs/requirements.txt
     - method: pip

CITATION.cff

@@ -0,0 +1,54 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: paradigma
+abstract: 'Digital Biomarkers for Parkinson's Disease 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: [email protected]
+    affiliation: Netherlands eScience Center
+    orcid: 'https://orcid.org/0000-0002-6630-7326'
+  - given-names: Vedran
+    family-names: Kasalica
+    email: [email protected]
+    affiliation: Netherlands eScience Center
+    orcid: 'https://orcid.org/0000-0002-0097-1056'
+  - given-names: Luc J.W.
+    family-names: Evers
+    email: [email protected]
+    affiliation: 
+      - Radboud University, Institute for Computing and Information Sciences, Department of Data Science, Nijmegen, Netherlands
+      - Radboud University Medical Center, Donders Institute for Brain, Cognition and Behaviour, Department of Neurology, Center of Expertise for Parkinson and Movement Disorders, Nijmegen, Netherlands
+    orcid: 'https://orcid.org/0000-0002-8241-5087'
+    corresponding: false
+  - given-names: Erik
+    family-names: Post
+    email: [email protected]
+    affiliation: 
+      - Radboud University, Institute for Computing and Information Sciences, Department of Data Science, Nijmegen, Netherlands
+      - Radboud University Medical Center, Donders Institute for Brain, Cognition and Behaviour, Department of Neurology, Center of Expertise for Parkinson and Movement Disorders, Nijmegen, Netherlands
+    orcid: 'https://orcid.org/0000-0002-1937-9976'
+  - given-names: Kars
+    family-names: Veldkamp
+    email: [email protected]
+    affiliation: Radboud University Medical Center, Nijmegen, Netherlands
+  - given-names: Nienke
+    family-names: Timmermans
+    email: [email protected]
+    affiliation: Radboud University Medical Center, Nijmegen, Netherlands
+  - given-names: Diogo
+    family-names: Soriano
+    email: [email protected]
+    affiliation: Center for Engineering, Modeling and Applied Social Sciences (CECS), Federal University of ABC (UFABC), Brazil
+identifiers:
+  - type: doi
+    value: 10.5281/zenodo.7867900
+repository-code: 'https://github.com/biomarkersParkinson/tsdf'
+url: 'https://biomarkersparkinson.github.io/tsdf/'
+license: Apache-2.0

README.md

@@ -1,24 +1,45 @@
 # paradigma
 
-Digital Biomarkers for Parkinson's Disease Toolbox
+| 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) |
+| **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) |
+<!-- | **DOI** | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7867899.svg)](https://doi.org/10.5281/zenodo.7867899) | -->
+<!-- | **Fairness** |  [![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F-green)](https://fair-software.eu) [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/8083/badge)](https://www.bestpractices.dev/projects/8083) | -->
 
-## Implementation progress
+Digital Biomarkers for Parkinson's Disease Toolbox
 
-See [here](https://docs.google.com/spreadsheets/d/19AZZ44cOJeHonGaSpAPh0eMXW2ix5JHz9L9zYTNnH6g/edit?usp=sharing).
+A package ([documentation](https://biomarkersparkinson.github.io/paradigma/)) to process wearable sensor data for Parkinson's disease.
 
 ## Installation
-The package requires Python 3.9 or higher. It can be installed using [Poetry](https://python-poetry.org/docs/#installation):
+
+The package is available in PyPi and requires [Python 3.10](https://www.python.org/downloads/) or higher. It can be installed using:
 
 ```bash
-$ poetry install
+pip install paradigma
 ```
 
 ## Usage
 
-- TODO
+See our [extended documentation](https://biomarkersparkinson.github.io/paradigma/).
+
 
 ## Development
 
+### Installation
+The package requires Python 3.10 or higher. Use [Poetry](https://python-poetry.org/docs/#installation) to set up the environment and install the dependencies:
+
+```bash
+poetry install
+```
+
+### Testing
+
+```bash
+poetry run pytest
+```
+
 ### Building documentation
 
 ```bash