Skip to main content

Python implementation of FLINT algorithm for NMR relaxation data.

Project description

Flintpy-NMR

PyPI - Version PyPI - Python Version Tests Codecov Read the Docs PyPI - License

Black pre-commit Contributor Covenant

Python implementation of FLINT algorithm for NMR relaxation data.

This module provides a Python implementation of FLINT, a fast algorithm for estimating 1D/2D NMR relaxation distributions. The algorithm is based on the work of Paul Teal and C. Eccles, who developed an adaptive truncation method for matrix decompositions to efficiently estimate NMR relaxation distributions.

For more information on the FLINT algorithm, refer to the official FLINT repository (Matlab) and the paper by P.D. Teal and C. Eccles titled "Adaptive truncation of matrix decompositions and efficient estimation of NMR relaxation distributions" published in Inverse Problems (April 2015).

Features

flintpy is built around the Flint class, which provides a simple approach to perform an inverse Laplace transform for 1D and 2D relaxation NMR data. Key features include:

  • T2: T2 relaxation
  • T1IR: T1 relaxation for inversion recovery experiments
  • T1SR: T1 relaxation for saturation recovery experiments
  • T1IRT2/T1SRT2: T1-T2 2D relaxation maps for inversion/saturation recovery-T2 experiments
  • T2T2: T2-T2 2D relaxation maps T2-T2 experiments

Quickstart

Check out the notebooks directory for Jupyter notebooks demonstrating how to use this library.

Installation

pip install flintpy-nmr

Credits

This package was created with Cookiecutter and the fedejaure/cookiecutter-modern-pypackage project template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flintpy_nmr-0.1.0.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

flintpy_nmr-0.1.0-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file flintpy_nmr-0.1.0.tar.gz.

File metadata

  • Download URL: flintpy_nmr-0.1.0.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for flintpy_nmr-0.1.0.tar.gz
Algorithm Hash digest
SHA256 bb2e7df902cde6e73a6c43ce94d68afa3710f3005333ad766760c718f573f233
MD5 b7d8f3eab2ecb3055f553eafcf047f62
BLAKE2b-256 62bd80c543d21988692534aaca677854b220ae70131a835f5b57a7e91bfde9f9

See more details on using hashes here.

File details

Details for the file flintpy_nmr-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: flintpy_nmr-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for flintpy_nmr-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 652a5aec023a4701d0779889a29fb6f765ff62f53c8ceda70e51da5c596bc1ce
MD5 94fe7832c51b10be8354ee9c71f012d4
BLAKE2b-256 64f1543bec3275a08871733dfceee600b71e786e3bea22044f69ec6ec334a806

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page