Improve README onboarding section #489
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,9 +10,29 @@ | |
|
|
||
| <!-- SPHINX-START --> | ||
|
|
||
| OpenLIFU is an open-source Python platform for planning, simulating, and controlling low-intensity focused ultrasound (LIFU) experiments. It helps researchers and developers build reproducible focused ultrasound workflows for planning, medical imaging, acoustic simulation, hardware communication, and experimental research while continuing the capabilities of the original MATLAB open-TFUS toolbox. | ||
|
|
||
| ## Who is OpenLIFU for? | ||
|
|
||
| **Developers** can contribute to an actively evolving scientific software platform for focused ultrasound research, medical imaging, and hardware integration. | ||
|
|
||
| **Researchers** can build reproducible planning, simulation, and experimental workflows using an open-source Python ecosystem. | ||
|
|
||
| **Clinicians** can explore the project's research software and follow its progress, although it is intended for research rather than clinical use. | ||
|
Comment on lines
+13
to
+21
Collaborator
There was a problem hiding this comment. Here instead of talking about the OpenLIFU platform in general we want to introduce this repo. What is this repo and how would you know if you're in the right place here or operating at the software layer you want. Openwater's quickstart is good for understanding this: https://openwaterhealth.github.io/openwater-community/quickstart-open-lifu.html We don't need to bin people into clinicians and researchers and so on. Just say what this python library is in a brief way that makes it immediately clear for someone if they should read on and keep digging into this. |
||
|
|
||
| ## Project status | ||
|
|
||
| OpenLIFU is actively developed as the Python successor to the MATLAB open-TFUS toolbox. The migration from MATLAB to Python is ongoing, with regular releases and active contributions from researchers and software developers. | ||
|
Collaborator
There was a problem hiding this comment. I don't think the matlab toolbox should be mentioned anymore at this point but @peterhollender can comment |
||
|
|
||
| > **Research Use Only.** OpenLIFU is investigational software. It has **not** been evaluated or cleared by the U.S. Food and Drug Administration (FDA) and is **not** intended for the diagnosis or treatment of any disease. | ||
|
Collaborator
There was a problem hiding this comment. This disclaimer is already at the bottom |
||
|
|
||
| ## Where to go next | ||
|
|
||
| - 🌐 **Community Hub** – <https://openwaterhealth.github.io/openwater-community/> | ||
| - 💬 **Discord** – <https://discord.gg/openwater> | ||
| - 🚀 **Good First Issues** – <https://github.com/OpenwaterHealth/OpenLIFU-python/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22> | ||
|
Comment on lines
+31
to
+33
Collaborator
There was a problem hiding this comment. There is also a never-used https://github.com/OpenwaterHealth/openlifu-python/discussions ... IDK if we want to condone its use or keep that sort of thing on discord. There's the API docs https://openlifu.readthedocs.io/en/latest/ There's the general openwater onboarding guide for openlifu: https://openwaterhealth.github.io/openwater-community/quickstart-open-lifu.html Would be good to hear from Openwater folks on what exactly they'd want to link in this list. |
||
|
|
||
| --- | ||
|
|
||
| ## Installation | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This tells the documentation's home page where to start: https://openlifu.readthedocs.io/en/latest/includeme.html