Skip to content

Improve README onboarding section #489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
HussainAther wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve README onboarding section #489

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 26 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,32 @@

<!-- SPHINX-START -->

@ebrahimebrahim ebrahimebrahim Jul 22, 2026

Copy link
Copy Markdown
Collaborator

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


`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).
The `openlifu` repository contains the core Python library for Open-LIFU.

It provides the software components used to build focused ultrasound research
applications, including treatment planning, simulation, hardware communication,
data models, and supporting utilities.

If you're looking to develop with the `openlifu` Python package, contribute to
the codebase, or build research workflows using the library, you're in the
right place.

## What you'll find here

- The core `openlifu` Python package
- APIs for treatment planning, simulation, and hardware communication
- Developer documentation and examples
- Installation instructions
- Guidance for contributing to the project

## Learn more

- 📖 **Quickstart Guide** – <https://openwaterhealth.github.io/openwater-community/quickstart-open-lifu.html>
- 📚 **API Documentation** – <https://openlifu.readthedocs.io/en/latest/>
- 🌐 **Openwater Community Hub** – <https://openwaterhealth.github.io/openwater-community/>
- 🚀 **Good First Issues** – <https://github.com/OpenwaterHealth/OpenLIFU-python/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22>

---

## Installation

Expand Down