neurogeriatricskiel / KielMAT

Python based toolbox for processing motion data

https://neurogeriatricskiel.github.io/KielMAT/

Other

6 stars 1 forks source link

Brush up documentation #12

Closed rmndrs89 closed 9 months ago

rmndrs89 commented 1 year ago

Hi @JuliusWelzel and @masoudabedinifar ,

let us keep in mind that we need to start writing documentation for the code as well, and preferably one that visually depicts the dataset, algorithms, and pipelines, and where they live,

Best regards, Robbin

JuliusWelzel commented 1 year ago

Hello,

is @hansencl taking care of this?

JuliusWelzel commented 1 year ago

Should we set a deadline for a first version of the Docs to be released? I would propose the 11th of November.

For this we should have:

[ ] Example notebook for single dataset with GSD algorithm
[ ] Visualisation of raw data and events
[ ] Draft of full documentation of all functions
[ ] Draft of install instruction

Anything I forgot?

JuliusWelzel commented 1 year ago

Automatic gh-actions is implemented sucessfully. To view the docs, we would have to make the repo public. Should we wait for this a little longer?

JuliusWelzel commented 1 year ago

Discuss solution as implemented in https://github.com/neurogeriatricskiel/NGMT/issues/17.

JuliusWelzel commented 1 year ago

improve documentation

For this we should have:

[x] Example notebook for a single dataset with GSD algorithm
[x] Visualisation of raw data and events
[x] Draft of full documentation of all functions
[x] Draft of install instruction
[ ] Implement test on poetry
[ ] Implement test for dataclasses
[x] Set up pyproject

rmndrs89 commented 11 months ago

For testing a new branch test-dev will be opened by @masoudabedinifar

masoudabedinifar commented 11 months ago

Hi @rmndrs89 and @JuliusWelzel,

I just updated tests for the low-level functions of the GSD algorithm in a new branch (test-dev) and I am sharing it with you. It's a first draft and I will update it based on your feedback. You may also change the location and name of the test if needed.

https://github.com/neurogeriatricskiel/NGMT/blob/test-dev/ngmt/test/test_calc.py

Best, Masoud.

JuliusWelzel commented 9 months ago

Hi, I added automatic testing on GH actions as well as the code coverage