Improve README onboarding section#489
Conversation
| @@ -1,18 +1,28 @@ | |||
| # openlifu | |||
| # Open-LIFU | |||
There was a problem hiding this comment.
The python library is called openlifu
| [](https://github.com/OpenwaterHealth/OpenLIFU-python/actions) | ||
| [](https://openlifu.readthedocs.io/en/latest/?badge=latest) | ||
| Open-LIFU 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. | ||
|
|
||
| [](https://pypi.org/project/openlifu/) | ||
| [](https://pypi.org/project/openlifu/) | ||
| ## Who is Open-LIFU for? | ||
|
|
||
| [](https://github.com/OpenwaterHealth/OpenLIFU-python/discussions) |
There was a problem hiding this comment.
Why remove badges?
| [](https://github.com/OpenwaterHealth/OpenLIFU-python/discussions) | ||
| **Developers** can contribute to an actively evolving scientific software platform for focused ultrasound research, medical imaging, and hardware integration. | ||
|
|
||
| <!-- SPHINX-START --> |
There was a problem hiding this comment.
This tells the documentation's home page where to start: https://openlifu.readthedocs.io/en/latest/includeme.html
|
ty for catching these. restored the openlifu heading, all existing badges, and the SPHINX-START marker, and moved the new onboarding content below them. |
ebrahimebrahim
left a comment
ebrahimebrahim
left a comment
There was a problem hiding this comment.
Thanks for fixing! Added more comments
|
|
||
| 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. | ||
|
|
||
| > **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. |
There was a problem hiding this comment.
This disclaimer is already at the bottom
| - 🌐 **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> |
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.
|
|
||
| ## 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. |
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
| 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. |
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.
2 participants
Closes #461
Summary
This PR improves the onboarding section at the top of the README to help first-time visitors quickly understand the project before reaching the installation instructions.
The new introduction:
The existing installation instructions and technical setup documentation below the onboarding section are left unchanged.
Motivation
The README is the first entry point for many potential users and contributors. This update provides context about the project, its intended audiences, its current development status, and where new contributors can get involved before diving into installation and technical documentation.
Testing