OpenwaterHealth / OpenwaterHealth/openlifu-python

Source of truth on parameter constraints unclear

Open
#293 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

Parameter constraints are defined both in Protocol and in SolutionAnalysisOptions.
But it's not clear which is going to end up being used.
Currently it appears to be the one in protocol.
And as far as I can see the one in SolutionAnalysisOptions is not used, unless one manually calls solution.analyze and passes something different.

The issue is that when one creates a protocol it's not clear whether the place to define parameter constraints is here or here.

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 comparing the parameter constraints at src/openlifu/plan/protocol.py lines 68 and 74, then trace the protocol path and SolutionAnalysisOptions usage described in the issue. Confirm which constraints are applied during analysis and clarify or consolidate the source of truth so protocol creators have one unambiguous place to define them.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.