Skip to content

Basic line/gaussian fit tutorial using breads#58

Merged
jruffio merged 3 commits into
mainfrom
simple_fitting_dev
Apr 24, 2026
Merged

Basic line/gaussian fit tutorial using breads#58
jruffio merged 3 commits into
mainfrom
simple_fitting_dev

Conversation

@KHorstman

Copy link
Copy Markdown
Collaborator

This notebook has examples of how to create and use forward model functions compatible with breads based on the example data (line or gaussian)

@mperrin mperrin left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As suggested in the call, I think we should relocate this into the docs folder

  • Move file to docs/source/tutorials/
  • Edit text file docs/source/tutorials.rst to include a link to this file.

Some other small suggestions

  • Typo "guassian" in the first top header ;-)
  • Add a succinct high-level summary paragraph at the start of the page. "This tutorial will teach you how to [big picture idea in a couple sentences]"
  • There are a couple places where it looks like entire paragraphs are formatted as headers. Is that intentional? e.g. the entire paragraph shows up bold as a header for "First, we need to define the function for a line. Since the function for a line only contains linear parameters, no non-linear parameters are included. However, the fitfm function requires non-linear parameters, so we must include them in the definition of our line."
  • It looks like you have a top-level header with one #, then a bunch of third-level headers with ###, but no second-level headers? Consider if it would help to add some intermediate headers, for instance ## Fitting a model with only linear parameters and ## Fitting a model also with nonlinear parameters

@jruffio

jruffio commented Apr 21, 2026

Copy link
Copy Markdown
Owner

Check on this Katelyn, what is the current status?

Fixed typo, added high level paragraph, re-formatted, added breads instrument class, added MCMC simulations
@jruffio
jruffio force-pushed the simple_fitting_dev branch from 99afac3 to ff3cbde Compare April 24, 2026 17:09
@jruffio

jruffio commented Apr 24, 2026

Copy link
Copy Markdown
Owner

The maths examples look great Katelyn.
I have done some quick refactoring too to include this in the doc.

FYI, the error message above was simply because the Simbad server was down.

@jruffio
jruffio merged commit 6b969a4 into main Apr 24, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants