OpenwaterHealth / OpenwaterHealth/openlifu-python

RFC: Feedback abstraction for adaptive/closed-loop sanitation research

Open
#498 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
27
Forks
21
Avg merge
1d 20m
Merged PRs (30d)
6

Description

OpenLIFU currently provides a pipeline form treatment planning through Solution generation, hardware execution, and Run recording. Would there be interest in defining a lightweight abstraction for research workflows where observations from a completed simulation or sanitation can inform generation of a subsequent solution?

An initial implementation could remain entirely simulation/offline-oriented and make no assumptions about the measurement modality or automatic hardware execution.

Conceptually:

Protocol -> Solution -> execution/simulation -> Observation -> FeedbackPolicy -> next Solution

Potential research uses could include focal correction, aberration correction, adaptive apodization, pressure/intensity targeting, or uncertainty-guided sonication planning.

One possible design would define an Observation representation plus a policy/callback interface that proposes modifications while leaving existing constraint checking, approval, and hardware execution pathways intact.

Before working on an implementation, I'd be interested in feedback on whether this abstraction belongs in openlifu-python, whether related functionality already exists/planned, and what boundary maintainers would prefer between planning, observations, and hardware control.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Solution generation and Run recording workflow, including the constraint-checking, approval, and hardware-execution pathways. Then compare those boundaries with the proposed Observation and FeedbackPolicy concepts. Done means maintainers have agreed whether this abstraction belongs in openlifu-python, what related functionality exists, and where planning, observations, and hardware control should meet.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.