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 will be available in an upcoming 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:

$ multinmrfit

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

In preparation, 2024, doi: xxx.xxxx

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.2.tar.gz (39.0 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.2-py3-none-any.whl (45.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: multinmrfit-2.1.2.tar.gz
  • Upload date:
  • Size: 39.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for multinmrfit-2.1.2.tar.gz
Algorithm Hash digest
SHA256 52514c9a6f1a78883152c218e13faee9f98ef50f2ddbd7e760eab20489a5b3c5
MD5 ce9cf592293d6c1e537803095356b066
BLAKE2b-256 7d9bf4cd9a9d169765ec2340a5f76f0ac0895d898eadca9e004b962b3511154e

See more details on using hashes here.

Provenance

The following attestation bundles were made for multinmrfit-2.1.2.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.2-py3-none-any.whl.

File metadata

  • Download URL: multinmrfit-2.1.2-py3-none-any.whl
  • Upload date:
  • Size: 45.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for multinmrfit-2.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 789ac4064ba7b676df865520692aaf5c894498fb28e0e8149ff3ae67845de581
MD5 ff607c492b77d19212dbb34ab00d9a97
BLAKE2b-256 3be298dc4888bc849a5bbfd5b53cf6e4a6b0731df780eca19eeb32ac853018c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for multinmrfit-2.1.2-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