UI for ramanbiolib. Biomolecules identification search using Raman spectra.
Project description
RamanBiolib UI:
A standalone UI for Biomolecule Identifiaction by means of Raman Spectroscopy using RamanBiolib
Getting started
Python package
Installation:
pip install ramanbiolib-ui
Run:
ramanbiolib-ui
Windows executable file
You can download the Windows executable (.exe file) from the Releases section of this repository:
- Go to the Releases page.
- Find the latest release (or the version you want).
- Under the Assets section, click on the
ramanbiolib-ui.exefile to download it. - Run the downloaded file to start the application.
Note: This executable file is self-signed, so Windows and/or antivirus software may flag it as potentially unsafe. However, the file is secure — it is simply a packaged version of this open-source code created using PyInstaller. If you have any concerns about running the executable, you can always install and run the Python version instead.
How to use this tool
Spectral Linear Kernel (SLK) similarity search
This uses the full spectra plot to rank the database components by its SLK similarity to the unknown specturm.
Parameters:
- Raman spectrum file: the unnknown spectrum file containing the wavenumbers and intensity.
- Window size: the value of the window (W) parameter in SLK.
- Top N table: the number of components to show in the result table.
- Top N plot: the number of components to show in the result plot.
The search results display the ranked table of the most similar biomolecules in the RamanBiolib database:
and the spectra comparison plot:
Peak matching search
This matching calculate the matching between the specturm extracted peak positions and each database component peak positions.
Parameters:
- Source:
- spectrum: the source is a spectrum file (as in SLK similarity search)
- Raman spectrum file: the unnknown spectrum file containing the wavenumbers and intensity.
- Peak detection prominence: the min prominence threshold for peak detection of the uploaded spectrum once the specturm is min-max normalized. The peak detection is done using scipy find_peaks function.
- peaks list:
- Peaks wavenumbers: the source is a comma-separated list of peaks wavenumbers positions (cm⁻¹). Example: 100,500,652,1205,1652 (step=1cm⁻¹, min=450, max=1800)
- spectrum: the source is a spectrum file (as in SLK similarity search)
- Tolerance size: the simmetrical maximum distance tolerance for peak matching.
- Penalty type: the penalty function for PIUR calculation. Linear or Inverse power (1/x).
- Sorted by: the metric used to sort the results (IUR, MR, RMR, PIUR). Default IUR.
- Considering query spectrum peaks Pa and DB spectrum peaks Pb:
- MR (Matching Ratio) = intersection(Pa, Pb)/len(Pa)
- RMR (Reverse Matching Ratio) = intersection(Pa, Pb)/len(Pb)
- IUR (Intersection Union Ratio) = intersection(Pa, Pb)/union(Pa, Pb)
- PIUR (Penalized Intersection Union Ratio) = penalized_intersection(Pa, Pb)/union(Pa, Pb)
- Considering query spectrum peaks Pa and DB spectrum peaks Pb:
- Top N table: the number of components to show in the result table.
- Top N plot: the number of components to show in the result plot.
The search results display the ranked table of the most similar biomolecules in the RamanBiolib database:
and the spectra comparison plot:
How to cite this tool
If you use this tool for research, please cite us:
Terán, M and Ruiz, JJ and Loza-Álvarez, P and Masip, D and Merino, D, Open Raman Spectral Library for Biomolecule Identification. Available at SSRN: https://ssrn.com/abstract=5185686 or http://dx.doi.org/10.2139/ssrn.5185686
License
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 ramanbiolib-ui-1.0.0rc1.tar.gz.
File metadata
- Download URL: ramanbiolib-ui-1.0.0rc1.tar.gz
- Upload date:
- Size: 826.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a9139ee316f1d8295cb42a551350d473924bb5d6f7f2a7a4b44b8f8426f4cf3e
|
|
| MD5 |
43e6d99f1d37ab8985e3b157f66a022d
|
|
| BLAKE2b-256 |
e9c6984a9e1c342f46020c3eb4704fbbdd2b0bb78c8dea515cdf2569f2b6c43b
|
File details
Details for the file ramanbiolib_ui-1.0.0rc1-py3-none-any.whl.
File metadata
- Download URL: ramanbiolib_ui-1.0.0rc1-py3-none-any.whl
- Upload date:
- Size: 164.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c181aa0a9f93adb93acb1d757a2ff903c05ce0a7746d20274804f7c1836aa0ad
|
|
| MD5 |
01f88e7e5080b48ff30e0163261eaac1
|
|
| BLAKE2b-256 |
e938adb04b38772ee2a19012200fa3be8e90958b9d8e986ad8e798654c9983c7
|