dpest.utils.parg_inctyp#

dpest.utils.parg_inctyp.parg_inctyp(pst_path, updates)[source]#

Updates INCTYP values for one or more parameter groups in a PEST control (.pst) file.

The INCTYP field specifies the increment type used by PEST for derivative calculations in the * parameter groups section. Typical values are relative and absolute. This function modifies the * parameter groups section of an existing .pst file in place.

Required Arguments:#

  • pst_path (str):

    Path to the .pst PEST control file to modify.

  • updates (dict):

    Dictionary mapping parameter group names to new INCTYP values.

    Example:

    {
        "PART_SEED": "relative",
        "SEED_COMP": "absolute"
    }
    

Returns:#

  • None

The function updates the * parameter groups section in place.

Examples:#

  1. Update INCTYP for two parameter groups:

    from dpest.utils import parg_inctyp
    
    parg_inctyp(
        pst_path = "A-1_input/PEST_CONTROL.pst",
        updates = {
            "PART_SEED": "relative",
            "SEED_COMP": "relative"
        }
    )
    
  2. Set one parameter group to absolute increments:

    from dpest.utils import parg_inctyp
    
    parg_inctyp(
        pst_path = "PEST_CONTROL.pst",
        updates = {
            "SEED_COMP": "absolute"
        }
    )