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.1.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: flintpy_nmr-0.1.1.tar.gz
  • Upload date:
  • Size: 10.5 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.1.tar.gz
Algorithm Hash digest
SHA256 366c0dbe9d677bc5af6521a137c9d8777ca214788898cce23b40e749cd74e249
MD5 4201396270ad197d4add09ba0ddc777f
BLAKE2b-256 26720323c59a83b4a8f49419ee52c8c1f08a6b6b5fa3cd0364dcc6adc66f2dde

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flintpy_nmr-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 36aea70dac11a04a4d9b5cf9b498dae0a140d73dc54e857acd69de9c9187a54b
MD5 b41321de02e3e6e17994e7e0a09658c0
BLAKE2b-256 b6d1734179be7ab7764fde77fa3a92a679add25cc7866df1fd63818952b54e90

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