From f24599cef5ebafd33cd7192125fb3f60495338dd Mon Sep 17 00:00:00 2001 From: Syed Hussain Ather Date: Tue, 21 Jul 2026 19:08:19 -0400 Subject: [PATCH 1/2] Improve README onboarding section --- README.md | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9bfe63f1..490c81ba 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,28 @@ -# openlifu +# Open-LIFU -[![Actions Status](https://github.com/OpenwaterHealth/OpenLIFU-python/workflows/CI/badge.svg)](https://github.com/OpenwaterHealth/OpenLIFU-python/actions) -[![Documentation Status](https://readthedocs.org/projects/openlifu/badge/?version=latest)](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. -[![PyPI version](https://img.shields.io/pypi/v/openlifu)](https://pypi.org/project/openlifu/) -[![PyPI platforms](https://img.shields.io/pypi/pyversions/openlifu)](https://pypi.org/project/openlifu/) +## Who is Open-LIFU for? -[![GitHub Discussion](https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github)](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. - +**Researchers** can build reproducible planning, simulation, and experimental workflows using an open-source Python ecosystem. -`openlifu` is a toolbox for planning and controlling focused ultrasound -treatments. It generally replicates the functionality developed in the MATLAB -[open-TFUS toolbox](https://github.com/OpenwaterHealth/opw_neuromod_sw). +**Clinicians** can explore the project's research software and follow its progress, although it is intended for research rather than clinical use. + +## Project status + +Open-LIFU 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.** Open-LIFU 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. + +## Where to go next + +- 🌐 **Community Hub** – +- 💬 **Discord** – +- 🚀 **Good First Issues** – + +--- ## Installation From 3a5f69dc4c1dc6aa27d066e6730c5d4871d50213 Mon Sep 17 00:00:00 2001 From: Syed Hussain Ather Date: Tue, 21 Jul 2026 21:31:20 -0400 Subject: [PATCH 2/2] Preserve README badges and Sphinx marker --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 490c81ba..4bce0c30 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,18 @@ -# Open-LIFU +# openlifu -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. +[![Actions Status](https://github.com/OpenwaterHealth/OpenLIFU-python/workflows/CI/badge.svg)](https://github.com/OpenwaterHealth/OpenLIFU-python/actions) +[![Documentation Status](https://readthedocs.org/projects/openlifu/badge/?version=latest)](https://openlifu.readthedocs.io/en/latest/?badge=latest) -## Who is Open-LIFU for? +[![PyPI version](https://img.shields.io/pypi/v/openlifu)](https://pypi.org/project/openlifu/) +[![PyPI platforms](https://img.shields.io/pypi/pyversions/openlifu)](https://pypi.org/project/openlifu/) + +[![GitHub Discussion](https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github)](https://github.com/OpenwaterHealth/OpenLIFU-python/discussions) + + + +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. @@ -12,9 +22,9 @@ Open-LIFU is an open-source Python platform for planning, simulating, and contro ## Project status -Open-LIFU 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. +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.** Open-LIFU 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. +> **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. ## Where to go next