From 4aae55d1d6fef0948931e88d03d5f7b733ad311a Mon Sep 17 00:00:00 2001 From: Fabian Joswig Date: Tue, 31 May 2022 11:51:59 +0100 Subject: [PATCH] docs: Docstring for fits.least_square extended. --- .gitignore | 3 +++ pyerrors/fits.py | 3 ++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index fdaac56f..2701c491 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,9 @@ __pycache__ .cache examples/B1k2_pcac_plateau.p examples/Untitled.* +examples/pcac_plateau_test_ensemble.json.gz core.* *.swp htmlcov +build +pyerrors.egg-info diff --git a/pyerrors/fits.py b/pyerrors/fits.py index 3af1f96e..ebe24df5 100644 --- a/pyerrors/fits.py +++ b/pyerrors/fits.py @@ -95,7 +95,8 @@ def least_squares(x, y, func, priors=None, silent=False, **kwargs): If true all output to the console is omitted (default False). initial_guess : list can provide an initial guess for the input parameters. Relevant for - non-linear fits with many parameters. + non-linear fits with many parameters. In case of correlated fits the guess is used to perform + an uncorrelated fit which then serves as guess for the correlated fit. method : str, optional can be used to choose an alternative method for the minimization of chisquare. The possible methods are the ones which can be used for scipy.optimize.minimize and