OpenwaterHealth / OpenwaterHealth/openlifu-python
harmonize transducer tracking and virtual fit result formats in Session
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 27
- Forks
- 21
- Avg merge
- 1d 20m
- Merged PRs (30d)
- 6
Description
Due to the parallel work by different devs, transducer tracking results and virtual fit results are very differently organized.
One is based on dataclasses (TransducerTrackingResult) and the other is based on python collections like lists and tuples and such.
It would be nice to harmonize them into a more uniform approach. I think the dataclasses approach is better since it is a bit more self-documenting.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting Session, the TransducerTrackingResult dataclass, and the virtual fit result representations. Trace how both result formats are created and consumed, then define what a uniform dataclass-based interface should contain. Done means transducer tracking and virtual fit results follow the same documented organization without leaving incompatible collection-based formats.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100