This release is a pre-release and may not be stable for production use.
FINCHnmr : [FI]tti[N]g 13[C] 1[H] HSQC [NMR]
FINCHnmr is lightweight toolkit for fitting 2D heteronuclear single-quantum coherence nuclear magnetic resonance (HSQC NMR) data to a known library of substances. This predicts the presence and relative concentration of these compounds, and the residual (error) can be interpreted as the sum of the remaining unknown compounds present. For a live demonstration, visit our HuggingFace space or try it out on streamlit's community cloud. Although originally designed to work with (1H-13C) data, FINCHnmr will work with any 2D NMR as long as the library used matches the sample being predicted / analyzed.
There are two approaches to generating the spectral libraries. Both methods are demonstrated in the documentation.
- Library spectra are taken directly from the Biological Magnetic Resonance Bank (BMRB). These spectra are automatically padded and resized so that they match the extent (2D grid) and resolution of the wild spectra being fit.
- Library spectra are reconstructed from a feature list of peak locations by placing bivariate Gaussians at these locations; assumptions must be made about the spread of these distributions in both dimentions of frequency shift space.
Installation
We recommend creating a virtual environment or, e.g., a conda environment then installing finchnmr with pip:
$ pip install finchnmr
You can also install from this GitHub repo source:
$ git clone git@github.com:mahynski/finchnmr.git
$ cd finchnmr
$ pip install .
$ python -m pytest # Optional unittests
Documentation
Documentation is hosted at https://finchnmr.readthedocs.io/ via readthedocs.
The logo was generated using Google Gemini with the prompt "Design a logo involving a finch and NMR" on Nov. 9, 2024.
License Information
- See LICENSE.md for more information.
- Any mention of commercial products is for information only; it does not imply recommendation or endorsement by NIST.
Metadata
Release files for finchnmr 0.0.0b1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| finchnmr-0.0.0b1.tar.gz | 20.6 kB | Without provenance | Details for finchnmr-0.0.0b1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| finchnmr-0.0.0b1-py3-none-any.whl | Python 3 | none | any | Details for finchnmr-0.0.0b1-py3-none-any.whl |
Total release size: 40.4 kB
Release files / finchnmr-0.0.0b1.tar.gz
| Download URL | finchnmr-0.0.0b1.tar.gz |
|---|---|
| Size | 20.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d68b670fb4b6f07b22a2f17eb97d06f76b9e4eb72bcfd0dfa0a243dcac52037c
|
|
BLAKE2b-256 checksum How to use checksums |
9cb320911d7d5cc0d5e8e327cab9856cb1c65495da797298ed6847c4b3f3628a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.10.15
|
Release files / finchnmr-0.0.0b1-py3-none-any.whl
| Download URL | finchnmr-0.0.0b1-py3-none-any.whl |
|---|---|
| Size | 19.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
97ec1b480165445780eef1a0f6a7001db9fd4dda5f2a6201cb755cea1b315cce
|
|
BLAKE2b-256 checksum How to use checksums |
800aa2d39d70042f180e4d1193b5b9eee4bfb7d47a01c1f0c4924d19feed991d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.10.15
|
Security for finchnmr 0.0.0b1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.