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 Documentation Status install with bioconda

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

isocor-2.2.3-py3-none-any.whl (62.5 kB view details)

Uploaded Python 3

File details

Details for the file isocor-2.2.3.tar.gz.

File metadata

  • Download URL: isocor-2.2.3.tar.gz
  • Upload date:
  • Size: 53.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for isocor-2.2.3.tar.gz
Algorithm Hash digest
SHA256 bf03affc6943a3fe931e3116f7cfc0f03de6cd7c5f16d855a0a6f9b924b81e8c
MD5 14460facaaaa58632f048b9cbb98e328
BLAKE2b-256 ea731d2a0aa62927c99a87f5b07e6fd6e1cb9f6d52086a2d512ebc3d176e78df

See more details on using hashes here.

Provenance

The following attestation bundles were made for isocor-2.2.3.tar.gz:

Publisher: pypi_deployment.yml on MetaSys-LISBP/IsoCor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file isocor-2.2.3-py3-none-any.whl.

File metadata

  • Download URL: isocor-2.2.3-py3-none-any.whl
  • Upload date:
  • Size: 62.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for isocor-2.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7153e53872870b91ae3ae627cbaf13152775703b2a73ef52f3d1d51cbd2bbf3c
MD5 6c819ade120c290567de750b7163f70f
BLAKE2b-256 5c4037c5577b9a265f9350cc3e2355bb0a3c0ebb8b58d2527d6e293c6e9a9f17

See more details on using hashes here.

Provenance

The following attestation bundles were made for isocor-2.2.3-py3-none-any.whl:

Publisher: pypi_deployment.yml on MetaSys-LISBP/IsoCor

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