Skip to main content

Fitting 1D NMR spectra

Project description

MultiNMRFit

Documentation Status Python 3.8+

What is MultiNMRFit?

MultiNMRFit is a scientific tool designed to extract quantitative information (chemical shifts, signal intensity, coupling constants, etc) by fitting a serie of 1D spectra (acquired individually or as pseudo 2D spectra).

It is one of the routine tools that we use for NMR studies of metabolic systems at the NMR and MetaSys teams of the Toulouse Biotechnology Institute.

The code is open-source, and available under a GPLv3 license. Additional information can be found in MultiNMRFit publication.

Detailed documentation can be found online at Read the Docs (https://multinmrfit.readthedocs.io/).

Key features

  • fit series of 1D spectra (acquired as individual 1D spectra, as a pseudo 2D spectrum, or provided as tabulated text files),
  • can be used with all nuclei (1H, 13C, 15N, 31P, etc),
  • estimation of several parameters for each signal of interest (intensity, area, chemical shift, linewidth, coupling constant(s), etc),
  • several signal models are provided, and users can add their own models
  • semi-automated analysis for peak picking and definition of multiplicity for each signal,
  • account for overlaps between peaks and zero-order baseline correction,
  • visual inspection of the fitted curves,
  • estimation of uncertainty on estimated parameters (standard deviation),
  • shipped as a library with a graphical user interface,
  • open-source, free and easy to install everywhere where Python 3 and pip run,
  • biologist-friendly.

Quick-start

MultiNMRFit requires Python 3.8 or higher and run on all platforms (Windows, MacOS and Unix). Please check the documentation for complete installation and usage instructions.

Use pip to install PhysioFit from GitHub:

$ pip install multinmrfit

Then, start the graphical interface with:

$ nmrfit

MultiNMRFit is also available as a Python library.

Bug and feature requests

If you have an idea on how we could improve MultiNMRFit please submit a new issue to our GitHub issue tracker.

Developers guide

Contributions

Contributions are very welcome! :heart:

Local install with pip

In development mode, do a pip install -e /path/to/MultiNMRFit to install locally the development version.

Build the documentation locally

Build the HTML documentation with:

$ cd doc
$ make html

The PDF documentation can be built locally by replacing html by latexpdf in the command above. You will need a recent latex installation.

How to cite

MultiNMRFit: A software to fit 1D and pseudo-2D NMR spectra. Pierre Millard, Loïc Le Grégam, Svetlana Dubiley, Thomas Gosselin-Monplaisir, Guy Lippens, Cyril Charlier, bioRxiv preprint, 2024, doi: 10.1101/2024.12.19.629408.

Authors

Pierre Millard, Cyril Charlier

Contact

:email: charlier@insa-toulouse.fr :email: millard@insa-toulouse.fr

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

multinmrfit-2.1.5.tar.gz (40.7 kB view details)

Uploaded Source

Built Distribution

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

multinmrfit-2.1.5-py3-none-any.whl (47.4 kB view details)

Uploaded Python 3

File details

Details for the file multinmrfit-2.1.5.tar.gz.

File metadata

  • Download URL: multinmrfit-2.1.5.tar.gz
  • Upload date:
  • Size: 40.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for multinmrfit-2.1.5.tar.gz
Algorithm Hash digest
SHA256 e29ce5b67e35452f4e9eb96bea3341f689c1bfdc7fc34b47b5515eaf0eb617df
MD5 ca748c6a3eca1844fdb8c4a2ab05f6ed
BLAKE2b-256 81a088591090e9d71780bb1c62a675f7235527cd85e7e8d3fe522d730365869c

See more details on using hashes here.

Provenance

The following attestation bundles were made for multinmrfit-2.1.5.tar.gz:

Publisher: pypi_deployment.yml on NMRTeamTBI/MultiNMRFit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file multinmrfit-2.1.5-py3-none-any.whl.

File metadata

  • Download URL: multinmrfit-2.1.5-py3-none-any.whl
  • Upload date:
  • Size: 47.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for multinmrfit-2.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 3b39c6926262071007e4cab95a8f21022b30c2b17d7c0dbe251e437970dfdf7a
MD5 bf13f057c91c26948f19a999fc8ffe60
BLAKE2b-256 932b6b83f7acc0cc269038de22bcaf444f23ba1eec370d078bb320a4fc675a5a

See more details on using hashes here.

Provenance

The following attestation bundles were made for multinmrfit-2.1.5-py3-none-any.whl:

Publisher: pypi_deployment.yml on NMRTeamTBI/MultiNMRFit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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