I added some documentation for the tomo_preprocessing module in the form of better docstrings (tried to have numpy docstring style for all functions), and a Readme file for this module. Also, I used the teamtomo docs structure, where I have an overview page and the preprocessing one so far.
(I guess it should all be prettier in the end with some images & more examples on how to use)
I also tried to implement the Typer CLI (thanks for the suggestion, Alister), which seems really nice to use.
By adding it also to pyproject.toml file, preprocessing methods can now be accessed using
"tomo_preprocessing NAME_OF_PREPROCESSING".
Let me know if this is going in the right direction. If not, I'm happy to adjust -- if yes, I'll extend the documentations and Typer CLIs also to the other functionalities (i.e. training and prediction).
I added some documentation for the tomo_preprocessing module in the form of better docstrings (tried to have numpy docstring style for all functions), and a Readme file for this module. Also, I used the teamtomo docs structure, where I have an overview page and the preprocessing one so far. (I guess it should all be prettier in the end with some images & more examples on how to use)
I also tried to implement the Typer CLI (thanks for the suggestion, Alister), which seems really nice to use.
By adding it also to pyproject.toml file, preprocessing methods can now be accessed using "tomo_preprocessing NAME_OF_PREPROCESSING".
Let me know if this is going in the right direction. If not, I'm happy to adjust -- if yes, I'll extend the documentations and Typer CLIs also to the other functionalities (i.e. training and prediction).