Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history 
Former-commit-id: 70a1c2764fd8027baf151ff4d4dcbeb883a49d54 [formerly 7ec32bb27fb1fbe2ad93fa8d3ac59aa117b02cfa] [formerly a5272ea6f8c86e0d9424559b809808dd3a457d86 [formerly 307f990]]
Former-commit-id: 83b047c98c4849f8d4cf577c068174e2a86e6514 [formerly 99a3d8dc43c09942ca710048eaa96c1aa0c52911]
Former-commit-id: 4de9c284c3bb8f9906288353b1716da0ef4db720
  • Loading branch information
@GabePoel
GabePoel committed Jan 23, 2021
1 parent 42dc002 commit 317959a
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 317959a

Please sign in to comment.