Skip to main content

Python based statistical learning of NMR tensor and relaxation parameters distribution.

Project description

Mrinversion

Deployment PyPI version PyPI - Python Version
Build Status GitHub Workflow Status Read the Docs
License License
Metrics codecov

The mrinversion python package is based on the statistical learning technique for determining the underlying distribution of the magnetic resonance (NMR) parameters.

The library utilizes the mrsimulator package for generating solid-state NMR spectra and scikit-learn package for statistical learning.


Features

The mrinversion package includes

  • Spectral Inversion: Two-dimensional solid-state NMR spectrum of dilute spin-systems correlating the isotropic to anisotropic frequencies to a three-dimensional distribution of NMR tensor parameters. Presently, we support the inversion of

    • Magic angle turning (MAT), Phase adjusted spinning sidebands (PASS), and similar spectra correlating the isotropic chemical shift resonances to pure anisotropic spinning sideband resonances into a three-dimensional distribution of nuclear shielding tensor parameters---isotropic chemical shift, shielding anisotropy and asymmetry parameters---defined using the Haeberlen convention.

    • Magic angle flipping (MAF) spectra correlating the isotropic chemical shift resonances to pure anisotropic resonances into a three-dimensional distribution of nuclear shielding tensor parameters---isotropic chemical shift, shielding anisotropy and asymmetry parameters---defined using the Haeberlen convention.

  • Relaxometry Inversion: Inversion of NMR relaxometry measurements to the distribution of relaxation parameters (T1, T2).

For more information, refer to the documentation.

View our example gallery

Installation

$ pip install mrinversion

Please read our installation document for details.

How to cite

If you use this work in your publication, please cite the following.

  • Srivastava, D. J.; Grandinetti P. J., Statistical learning of NMR tensors from 2D isotropic/anisotropic correlation nuclear magnetic resonance spectra, J. Chem. Phys. 153, 134201 (2020). DOI:10.1063/5.0023345.

  • Deepansh J. Srivastava, Maxwell Venetos, Philip J. Grandinetti, Shyam Dwaraknath, & Alexis McCarthy. (2021, May 26). mrsimulator: v0.6.0 (Version v0.6.0). Zenodo. http://doi.org/10.5281/zenodo.4814638

Additionally, if you use the CSDM data model, please consider citing

  • Srivastava DJ, Vosegaard T, Massiot D, Grandinetti PJ (2020) Core Scientific Dataset Model: A lightweight and portable model and file format for multi-dimensional scientific data. PLOS ONE 15(1): e0225953. https://doi.org/10.1371/journal.pone.0225953

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

mrinversion-0.3.1.tar.gz (28.2 kB view details)

Uploaded Source

Built Distribution

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

mrinversion-0.3.1-py3-none-any.whl (33.0 kB view details)

Uploaded Python 3

File details

Details for the file mrinversion-0.3.1.tar.gz.

File metadata

  • Download URL: mrinversion-0.3.1.tar.gz
  • Upload date:
  • Size: 28.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for mrinversion-0.3.1.tar.gz
Algorithm Hash digest
SHA256 c4efe3b73331ebb011920cd8f6f82bc9efe0182794a74e2bd974516d76f08799
MD5 c08cb989689b766e04e78fece3875edf
BLAKE2b-256 75859d680d2dee255d9aa2b29e80dd5b0bc5f3b7e8850f78c7d4b24ddb1ce00d

See more details on using hashes here.

File details

Details for the file mrinversion-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: mrinversion-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 33.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for mrinversion-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f6b85c2c42e3bf310b5b8b14cf5f8ab2f92b3e1eadce34b9857da4eb61cec2a7
MD5 570638820681092bb7e54a15092aaa02
BLAKE2b-256 586da1dc170f7848890f61f5b2f683529ee60f138a4fe161ba4def3b27880ab1

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