Skip to main content

IsoCor: Isotope Correction for mass spectrometry labeling experiments

Project description

IsoCor - Isotope Correction for mass spectrometry labeling experiments

PyPI version PyPI pyversions Build Status Documentation Status

IsoCor graphical user interface

What is IsoCor?

IsoCor is a scientific software dedicated to the correction of mass spectrometry (MS) data for naturally occuring isotopes. IsoCor corrects raw MS data (mass fractions) for naturally-occurring isotopes of all elements and purity of the isotopic tracer. The output of IsoCor is the isotopologue distribution of the molecule (i.e. the relative fractions of molecular entities differing only in the number of isotopic substitutions of the tracer). IsoCor also calculates the mean enrichment (i.e. the mean isotopic content in the molecule) in metabolites.

It is one of the routine tools that we use at the MetaSys team and MetaToul platform in isotopic studies of metabolic systems.

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

Detailed documentation can be found online at Read the Docs (https://isocor.readthedocs.io/). Check out the Tutorials to use the best correction option!

Key features

  • correction of naturally occuring isotopes, both for non-tracer and tracer elements,
  • correction of tracer purity,
  • shipped as a library with both a graphical and command line interface,
  • mass-spectrometer and resolution agnostic,
  • can be applied to singly- and multiply-charged ions
  • can be used with any tracer element (having two or more isotopes)
  • account for the contribution of derivatization steps (if any),
  • generate isotopic InChIs of tracer isotopologues,
  • open-source, free and easy to install everywhere where Python 3 and pip run,
  • biologist-friendly.

Quick-start

IsoCor requires Python 3.7 or higher and run on all platforms. Please check the documentation for complete installation and usage instructions.

Use pip to install IsoCor from PyPi:

$ pip install isocor

Then, start the graphical interface with:

$ isocor

IsoCor is also available directly from command-line and as a Python library.

Bug and feature requests

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

Developers guide

Contributions

Contributions are very welcome! :heart:

Please work on your own fork, follow PEP8 style guide, and make sure you pass all the tests before a pull request.

Local install with pip

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

Unit tests

Isotope correction is a complex task and we use unit tests to make sure that critical features are not compromised during development.

You can run all tests by calling pytest in the shell at project's root directory.

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

Millard P., Delépine B., Guionnet M., Heuillet M., Bellvert F. and Letisse F. IsoCor: isotope correction for high-resolution MS labeling experiments. Bioinformatics, 2019, doi: 10.1093/bioinformatics/btz209

Authors

Baudoin Delépine, Matthieu Guionnet, Pierre Millard

Contact

:email: Pierre Millard, 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

IsoCor-2.2.2.tar.gz (53.4 kB view details)

Uploaded Source

Built Distribution

IsoCor-2.2.2-py3-none-any.whl (62.4 kB view details)

Uploaded Python 3

File details

Details for the file IsoCor-2.2.2.tar.gz.

File metadata

  • Download URL: IsoCor-2.2.2.tar.gz
  • Upload date:
  • Size: 53.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for IsoCor-2.2.2.tar.gz
Algorithm Hash digest
SHA256 eb4c91d2ed5b626adc6208454fd82b3e2ddd9a3ad0ccd964c8f16f9a310673e7
MD5 8b7851146f03dd6dea17c5a066f4e65d
BLAKE2b-256 fd3e9dfdba9783d0425f8f30e132d5c76afe57673af2c336f3de1e8446114d21

See more details on using hashes here.

File details

Details for the file IsoCor-2.2.2-py3-none-any.whl.

File metadata

  • Download URL: IsoCor-2.2.2-py3-none-any.whl
  • Upload date:
  • Size: 62.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for IsoCor-2.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d06358d59518324d09aa3985914acd822d87ef96312233e676620378eecbdcf0
MD5 44b930e0a22b537c379a5a3cca4137d9
BLAKE2b-256 ad744f8c57ad54d785c1ee178e9ce52eae263b40233013d1f012d29766a33502

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