dpest.utils.phiredlam#

dpest.utils.phiredlam.phiredlam(pst_path, new_value)[source]#

Updates the PHIREDLAM parameter in a PEST control (.pst) file.

PHIREDLAM is the relative objective function reduction threshold for trying a new Marquardt lambda. This function allows you to set PHIREDLAM to any float value between 0.0 and 1.0 (e.g., 0.03, 0.01).

Required Arguments:#

pst_path (str):
Path to the .pst PEST control file whose PHIREDLAM value you wish to update.

new_value (float):
The new value for the PHIREDLAM parameter (must be between 0.0 and 1.0).

Returns:#

None

Example:#

Set PHIREDLAM to 0.03:

from dpest.utils import phiredlam

pst_file_path = 'PEST_CONTROL.pst'
phiredlam(pst_file_path, 0.03)