Skip to main content

Processing of NMR data

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) 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),
  • 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.1.tar.gz (38.7 kB view details)

Uploaded Source

Built Distribution

multinmrfit-2.1.1-py3-none-any.whl (45.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: multinmrfit-2.1.1.tar.gz
  • Upload date:
  • Size: 38.7 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.1.tar.gz
Algorithm Hash digest
SHA256 12dd3b38868b4cc7ace16ed49e7cc315c5866bcd7ba7fe04043037629ef877cd
MD5 b6987611d4d12b538d206e1409c87a3b
BLAKE2b-256 27759355c19f17456f2cbfe6adccaaa6ead9ddeb14a9907ed5397e565e58f2be

See more details on using hashes here.

Provenance

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

Publisher: pypi_deployment.yml on NMRTeamTBI/MultiNMRFit

Attestations:

File details

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

File metadata

  • Download URL: multinmrfit-2.1.1-py3-none-any.whl
  • Upload date:
  • Size: 45.2 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2b3ddeac3ed80ac81cc94c29c27fbec72966f4c1e79996a19fa90780a0e029a4
MD5 e776a4a927d2bdbb7ef82268576f4f10
BLAKE2b-256 56cc3476c0f62a65824c3dc1c58d9436ae82051de184f4f33b85dea807905ef4

See more details on using hashes here.

Provenance

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

Publisher: pypi_deployment.yml on NMRTeamTBI/MultiNMRFit

Attestations:

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