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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: flintpy_nmr-0.1.2.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for flintpy_nmr-0.1.2.tar.gz
Algorithm Hash digest
SHA256 ec50f05c59493582c8e2a8ea36da60a7c910c99a7ce665c77ada77f778411a0a
MD5 4b9aefa192d67615b9f180799b90c3fc
BLAKE2b-256 cbdff729928edbd9a2fdc89faa1171d83717dd8cec33b6cc99a0b9641c4bdfbd

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for flintpy_nmr-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b45e858885d1891a3315d97e5a738d097db3dc0fa6c1be1033656bb94034a1b4
MD5 71d03ea63ac5368c04388d0817a55123
BLAKE2b-256 938ed5ba9c8490fc0341daf1cbacaa23e677c6c003200b1bb26c50278cedf433

See more details on using hashes here.

Supported by

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