Processing of NMR data
Project description
MultiNMRFit
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
Built Distribution
File details
Details for the file multinmrfit-2.0.0.tar.gz
.
File metadata
- Download URL: multinmrfit-2.0.0.tar.gz
- Upload date:
- Size: 36.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d69866df3bb707b75ba8a22ab2af39752bc9239addd2e0826c954d4df416600 |
|
MD5 | f3a148b6794394e092ffaf2bbe3bc54a |
|
BLAKE2b-256 | cd420933453e54af73b6b17704ff2c56ad955e5f8b7ecb8a2f2e1a8ab43ee846 |
File details
Details for the file multinmrfit-2.0.0-py3-none-any.whl
.
File metadata
- Download URL: multinmrfit-2.0.0-py3-none-any.whl
- Upload date:
- Size: 42.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | bcb3e218f31bdb1ea8fb994d1a4a98adf59f7179941e003d9b0a809c80e2e448 |
|
MD5 | 89c199e828f1ead724b66b503dc109e7 |
|
BLAKE2b-256 | 4ac5790c23448b71188a0453f58d3e4a1e7a5b28b8a7be953e9f31de545f4394 |