dpest.utils.rlamfac#

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

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

The RLAMFAC parameter is the factor by which the Marquardt lambda is adjusted during optimization. This function allows you to set RLAMFAC to any float value (positive or negative, but not zero).

Required Arguments:#

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

new_value (float):
The new value for the RLAMFAC parameter.

Returns:#

None

Example:#

Set RLAMFAC to 2.0:

from dpest.utils import rlamfac

pst_file_path = 'PEST_CONTROL.pst'
rlamfac(pst_file_path, 2.0)