diff --git a/README.md b/README.md index c7b961c..dacb26b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,14 @@ A python library for finding, fitting to, and tracking Lorentzian peaks from RUS or other measurements. Usage and documentation can be found in the [wiki](https://github.com/GabePoel/ML-Peak-Tracker/wiki). +Note that throughout the library, the definition of Lorentzians used is the following. + +![eq1](https://raw.githubusercontent.com/GabePoel/ML-Peak-Tracker/master/images/equation_1.png) + +Where the individual terms are as below. + +![eq2](https://raw.githubusercontent.com/GabePoel/ML-Peak-Tracker/master/images/equation_2.png) + ## Installing Just run the following to install directly from this repository.