Qt application for constrained vibEELS peak fitting.
Project description
vibfit
vibfit is a Qt desktop application for constrained vibEELS peak fitting using lmfit. It is particularly useful for vibrational spectra with broad peaks.
Current release: 0.5.1
Install
Install the current release from PyPI:
pip install vibfit
For development from a local checkout:
python -m pip install -e .
Run
vibfit
How to use
- Launch the app with
vibfit. - In the
Filetab, clickLoad spectrum (vxy)and open a supported spectrum file.vibfitcurrently supports*.vxy. Support for additional formats is planned; contactshdshimif you need another file type. - Use the toolbar to zoom to the spectral range you want to analyze.
- In the
Backgroundtab, clickSelect areaand mark one or more background-only regions on the top plot. ClickFit backgroundwhen you are done. To add another region, clickSelect areaagain. - In the
PeakFittab, clickSet fit range, then drag across the bottom plot to define the fitting window. UseClear fit rangeto restore the full spectrum. - In the
PeakFittab, clickPick peaksand add peaks within the active fit range in the bottom panel. To add a peak, holdShift, click near the left side of the peak FWHM, drag to the right side, and release. Repeat for each peak. To remove a peak, right-click near it. - Edit peak names and parameter bounds in the table as needed, then click
Fit region. - Review the fit results table and report. Use
Save to sectionto store the current fitted region in the session and clear the active fit before continuing to the next region. - Use
Save XLSin theSectionstab to export all saved sections as.jsonand.xlsxfiles, with one Excel sheet per section. UseExport NPY, PDF, and PNGto export plot arrays together with a reproduction Python script and rendered figures. - Click
Savein the toolbar to create a session backup. Backups are stored next to the source spectrum in a*-vibfitdirectory and can be restored from theFiletab.
Useful controls:
Zoom infocuses the view on the active fit region.Zoom outreturns the view to the full spectrum.Yspecrescales the plots based on the current spectrum view.Yadjautomatically adjusts the visible y-range.- The
Plottab lets you enter exact top and bottom y-axis limits. - To review a previously saved section, open the
Sectionstab, select a section, and clickSet current. The saved fit results will be plotted again.
Development build
python -m build
Citation
Citation metadata is provided in CITATION.cff.
- Latest-release DOI badge:
10.5281/zenodo.20018217 - Version
0.5.0DOI:10.5281/zenodo.20018218
License
vibfit is distributed under the BSD 3-Clause License. See LICENSE.
Notes
- fitting is performed in
cm^-1 - vibrational background fitting uses a
PowerLawmodel - peak names are editable and are used as
lmfitprefixes
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vibfit-0.5.1.tar.gz.
File metadata
- Download URL: vibfit-0.5.1.tar.gz
- Upload date:
- Size: 2.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
393fa5551b27eca7f58feb467c67a1ffa845daffe0ae3e54831de00eca779757
|
|
| MD5 |
1912566d1c6ea2f4891add2e68216df4
|
|
| BLAKE2b-256 |
f5fc053b0ca3647428cf1c1003c58d40841286514203782a15e0b8a002087bd7
|
File details
Details for the file vibfit-0.5.1-py3-none-any.whl.
File metadata
- Download URL: vibfit-0.5.1-py3-none-any.whl
- Upload date:
- Size: 2.9 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
280b8ba56b72f4e19a21f082086a0021530846ac7ef8e7b551533eae802a6227
|
|
| MD5 |
5b8a689d99557a92a8cc07d11ecd6d1d
|
|
| BLAKE2b-256 |
f45b00b5717a5e4885ea85af133c45ee928201e1ce27cca01f5f07437d416905
|