search

GabePoel / ML-Peak-Tracker

Library for finding Lorentzian distributions using machine learning.
2 stars 0 forks source link
elasticity machine-learning resonant-ultrasound-spectroscopy rus symmetry-measurements

readme

Lorentzian Peak Finder (now with MaChInE lEaRnInG!)

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. Tutorials and demo data is available in releases.

Note that throughout the library, the definition of Lorentzians used is the following.

eq1

Where the individual terms are as below.

eq2

Installing

Note that none of the installation methods download nor install the pre-made Lorentzian models. You need to get those separately. Please see Lorentzian Models for more information.

The recommended installation method is from pypi.

pip install peak-finder

But, you can also install directly from this git repository. These releases might not always be stable.

pip3 install git+https://github.com/GabePoel/ML-Peak-Tracker#egg=peak_finder --user

Or, if you only want to install the deltas, you can also clone this repository locally and then install using the included local_install.sh script. Navigate into the cloned repository and then run the following command.

sh ./peak_finder/local_install.sh