From 8de62d2b7d345f25727e29a928bc5bea5c69f41e Mon Sep 17 00:00:00 2001 From: Roy Smart Date: Mon, 19 Oct 2026 15:21:16 -0600 Subject: [PATCH] List the binned Gaussian among the models in the README and documentation. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01PZRXiFhGzzrF87vsFg73B9 --- README.md | 4 ++-- docs/index.rst | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ede654f..50d6068 100644 --- a/README.md +++ b/README.md @@ -159,8 +159,8 @@ def exponential( ``` [`ndoptimize.models`](https://ndoptimize.readthedocs.io/en/latest/_autosummary/ndoptimize.models.html) -has some common models: a Gaussian, a Gaussian plus a straight line, and two -Gaussians plus a straight line. +has some common models: a Gaussian, a Gaussian averaged over each bin, a +Gaussian plus a straight line, and two Gaussians plus a straight line. ## Citation diff --git a/docs/index.rst b/docs/index.rst index 824b7dc..fd621da 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -36,8 +36,9 @@ The package provides: parameters at once, such as the best-fit ones. - :func:`ndoptimize.model`, a decorator which compiles a function as a model, an :class:`ndoptimize.Model`, and names its parameters. -- :mod:`ndoptimize.models`, some common models: a Gaussian, a Gaussian plus a - straight line, and two Gaussians plus a straight line. +- :mod:`ndoptimize.models`, some common models: a Gaussian, a Gaussian + averaged over each bin, a Gaussian plus a straight line, and two Gaussians + plus a straight line. Differences from :func:`scipy.optimize.least_squares`