Skip to content
This repository has been archived by the owner on Aug 11, 2024. It is now read-only.
/ pyflint Public archive

Python implementation of FLINT algorithm for NMR relaxation data.

License

Notifications You must be signed in to change notification settings

rserial/pyflint

Repository files navigation

Pyflint

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

pyflint 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 git+https://github.com/rserial/pyflint.git

Credits

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

License

Free software: GNU General Public License v3

About

Python implementation of FLINT algorithm for NMR relaxation data.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published