Skip to main content

Processing of NMR data

Project description

MultiNMRFit

Documentation Status Python 3.6+

What is MultiNMRFit?

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

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),
  • 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:

$ python -m pip install git+https://github.com/NMRTeamTBI/MultiNMRFit

Note: Git must be installed on your computer. Have a look to the detailed documentation for help on installing Git in an Anaconda environment.

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

Uploaded Source

Built Distribution

multinmrfit-2.0.1-py3-none-any.whl (42.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: multinmrfit-2.0.1.tar.gz
  • Upload date:
  • Size: 37.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for multinmrfit-2.0.1.tar.gz
Algorithm Hash digest
SHA256 f33bfd849784f92566a03731a8fb175074fe677835d8f4201d168e74bc8aa899
MD5 4e4c7827bec4679c3bc1019abb1ec93a
BLAKE2b-256 84e5194340ed6a06ddb747d12235ee6892b75e07d15c2c29ddda3afdfc4ed729

See more details on using hashes here.

File details

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

File metadata

  • Download URL: multinmrfit-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 42.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for multinmrfit-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2bdf7aff0bb5278949260b055997ddd1e3b30e361d39518bba5a95aa3434e8d9
MD5 ba028d4f68cd3f9237d60d911a075f65
BLAKE2b-256 360435312a8e41455caed318eab1a15d4d521053535320bab847cb568eed61ad

See more details on using hashes here.

Supported by

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