Improve Documentation for "OSIPI"

OSIPI / osipi

Python package for perfusion MRI analysis

https://osipi.github.io/osipi/

Apache License 2.0

4 stars 8 forks source link

Improve Documentation for "OSIPI" #11

Open MohamedNasser8 opened 8 months ago

MohamedNasser8 commented 8 months ago

I think the current documentation for "OSIPI" lacks a clear explanation of what they are doing. This makes it difficult for users to understand how to effectively use the library.

Improvements:

Provide a comprehensive overview of OSIPI functionalities:Clearly explain the core functionalities offered by OSIPI in the context of perfusion MRI analysis.
Briefly describe the types of data OSIPI can handle and the analysis it supports.

LucyKershaw commented 8 months ago

Hi Mohamed, as you can see this project is still a work in progress, we're slowly adding functionality and documentation as we go along. The functions added so far on the dev branch have examples and documentation. The new osipi website is under construction. We are getting there with your suggestions, just.... slowly