Skip to content

Commit 19a3d26

Browse files
fix stale docstrings (#423)
1 parent fcc0328 commit 19a3d26

2 files changed

Lines changed: 5 additions & 2 deletions

File tree

src/openlifu/plan/protocol.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -289,8 +289,10 @@ def calc_solution(
289289
on_pulse_mismatch: plan.protocol.OnPulseMismatchAction
290290
An action to take if the number of pulses in the sequence does not match
291291
the number of foci (Default: OnPulseMismatchAction.ERROR).
292-
use_gpu: Whether to use GPU in the simulation. If not provided then a GPU will be used
293-
if available, with CPU as a fallback.
292+
voltage: float
293+
The voltage to use for the simulation (Default: 1.0).
294+
_force_cpu: bool
295+
If True, force the simulation to run on CPU even if GPU is available (Default: False).
294296
295297
Returns:
296298
solution: Solution

src/openlifu/plan/solution.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,7 @@ def analyze(self,
197197
"""Analyzes the treatment solution.
198198
199199
Args:
200+
simulation_result: The simulation result dataset to analyze. If None, uses self.simulation_result.
200201
options: A struct for solution analysis options.
201202
param_constraints: A dictionary of parameter constraints to apply to the analysis.
202203
The keys are the parameter names and the values are the ParameterConstraint objects.

0 commit comments

Comments
 (0)