dpest.utils.nrelpar#

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

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

NRELPAR specifies the number of successive iterations over which the RELPARSTP criterion must be met for optimization termination. This function allows you to set NRELPAR 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 NRELPAR (must be an integer > 0)

Returns:#

None

Example:#

Set NRELPAR to 3:

from dpest.utils import nrelpar

nrelpar("PEST_CONTROL.pst", 3)