pastas.solver.EmceeSolve.set_parameter#

pastas.solver.EmceeSolve.set_parameter(name: str, initial: float | None = None, vary: bool | None = None, pmin: float | None = None, pmax: float | None = None, optimal: float | None = None, dist: str | None = None) → None#

Method to change the parameter properties.

Parameters:

  • name (str) – name of the parameter to update. This has to be a single variable.

  • initial (float, optional) – parameters value to use as initial estimate.

  • vary (bool, optional) – boolean to vary a parameter (True) or not (False).

  • pmin (float, optional) – minimum value for the parameter.

  • pmax (float, optional) – maximum value for the parameter.

  • optimal (float, optional) – optimal value for the parameter.

  • dist (str, optional) – Distribution of the parameters. Must be a scipy.stats distribution.

Examples

>>> s = ps.EmceeSolve()
>>> s.set_parameter(name="ln_sigma", initial=0.1, vary=True, pmin=0.01, pmax=1)

Notes

It is highly recommended to use this method to set parameter properties. Changing the parameter properties directly in the parameter DataFrame may not work as expected.