Skip to content

Commit

Permalink
pointed to object-oriented implementation
Browse files Browse the repository at this point in the history
  • Loading branch information
Guenter Quast committed May 19, 2024
1 parent b831e73 commit 3ffe247
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions examples/001_line_fit/README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
Performe fits using the methods kafe2.xy_fit and kafe2.plot (so-called "wrapper functions").
These methods providepre-configured pipelines for fitting models to xy data and plotting
the results.

* **line_fit.py**: Simple example of fitting a line to data with both *x* and *y* errors.

Other relevant examples:
Internally, the wrapper functions use objects (in the programming sense), i.e. instances
of Python classes. An implementation with the more general, but also much more flexible
and powerful object-oriented interface of the same problem as above is shown in the example

* **003_profiling/03_x_errors.py**: How to check if the fit results are meaningful.
* **003_profiling/00_object_oriented_programming.py**

0 comments on commit 3ffe247

Please sign in to comment.