Skip to content

List the binned Gaussian among the models in the README and documentation. #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
roytsmart merged 1 commit into from
Oct 19, 2026
Merged

List the binned Gaussian among the models in the README and documentation. #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 3 additions & 2 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
Loading