dpest.utils.nphistp#

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

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

NPHISTP specifies the number of successive iterations over which the PHIREDSTP criterion must be met for optimization termination. This function allows you to set NPHISTP to any integer value greater than zero.

Required Arguments:#

pst_path (str):
Path to the .pst file to modify

new_value (int):
New value for NPHISTP (must be an integer > 0)

Returns:#

None

Example:#

Set NPHISTP to 3:

from dpest.utils import nphistp

nphistp("PEST_CONTROL.pst", 3)