IsoGen
IsoGen is a toolbox for predicting isotope distributions from protein, RNA, DNA, neutral-mass, and elemental-formula inputs.
It includes both an absolute FFT-based calculation and a neural network prediction.
Pretrained models are included for both peptides and RNA based on either average mass or sequence. DNA prediction uses the RNA model due to the similarity of their elemental compositions.
The FFT methods are absolute and are limited only by the accuracy of the data you put in. They are a little faster, especially on larger species.
The NN methods are very accurate and can be faster on smaller species. The primary advantage of these is that they can be retrained on non-standard isotope distributions.
Installation
Install a published wheel from PyPI:
python -m pip install pyisogen
IsoGen requires Python 3.13 or newer.
Precompiled native libraries are provided for 64-bit Windows and Linux. Linux requires the FFTW 3 runtime; published Linux wheels bundle it during the manylinux repair step. For other platforms, build the native library from source using CMake.
Usage
From Python:
import isogen
protein = isogen.isodist("ACDEFGHIK", type="PEPTIDE", isolen=64)
rna = isogen.isodist("AUGCAGUACGUA", type="RNA", isolen=64)
dna = isogen.isodist("ATGCAGTACGTA", type="DNA", isolen=64)
glucose_mass_dist = isogen.isodist("C6H12O6", type="ATOM", isolen=32)
The output is a numpy array of shape (isolen, 2) with the first column containing the monoisotopic mass and the second column containing the relative intensity. The isolen parameter controls the number of isotopic peaks returned.
In addition to FFT methods, IsoGen provides neural-network models for peptides and RNA. The default is to use the exact "FFT" model with averagines to calculate the isotope distribution from an average protein, RNA, or DNA mass. Turning on "NN" mode uses the neural-network model to predict the isotope distribution from a peptide or RNA sequence.
The PEPTIDE model is trained on peptide sequences, while the RNA model is trained on RNA sequences. The DNA type uses the RNA model, and
The public ATOM type uses the FFT method; no neural-network formula model is
available.
Peptide ions and RNA termini
For peptide fragments, pass the fragment sequence and select its neutral
terminal composition with ion_type. IsoGen supports intact H2O (the
default) and the peptide a, b, c, x, y, and z ion types:
b6 = isogen.isodist("PEPTID", type="PEPTIDE", ion_type="b")
y6 = isogen.isodist("EPTIDE", type="PEPTIDE", ion_type="y")
Supply the N-terminal subsequence for a/b/c ions and the C-terminal subsequence for x/y/z ions. Returned values are neutral masses, not charge-adjusted m/z.
RNA does not currently accept named RNA fragment-ion series through
ion_type. For an intact or manually truncated RNA sequence, configure the
supported terminal chemistry with threeend and fiveend:
rna_5_triphosphate = isogen.isodist(
"AUGC",
type="RNA",
threeend="OH",
fiveend="TP",
)
The available 5' settings are hydroxyl (OH), monophosphate (MP, default),
and triphosphate (TP); the supported explicit 3' setting is hydroxyl (OH,
default). These peptide-ion and RNA-terminal options adjust the mass-axis
origin. The sequence-model intensity vector retains its standard terminal
composition.
From the command line:
isogen dist ACDEFGHIK --type PEPTIDE --isolen 64
isogen dist C6H12O6 --type ATOM --isolen 32
isogen plot
See python -m isogen --help for all options.
The source repository also builds a native development executable named
isogen_test.exe on Windows (isogen_test on Linux). It can be run from the
repository's bin directory with isogen_test.exe -mass 10000, but it is not
installed by the Python wheel. Use the isogen console command for installed
packages.
Documentation
Read the full IsoGen documentation.
The documentation sources are also available in the repository's docs
directory. To preview them locally:
python -m pip install -e ".[docs]"
python -m mkdocs serve
Tests
The test suite uses Pyteomics as an independent mass reference. Pyteomics is only part of the optional test dependencies and is not installed with IsoGen:
python -m pip install -e ".[test]"
python -m pytest
Development and model-training modules have additional dependencies:
python -m pip install -e ".[training]"
License
IsoGen is released under the BSD 3-Clause License. See LICENSE for details.
PLEASE CITE THIS SOFTWARE IN ANY PUBLICATIONS THAT USE IT (publication to follow).
Contact
If you have any questions, please email mtmarty@utexas.edu or open a ticket on GitHub.
CHANGELOG
1.0.0
Initial release. Rewrote significantly from UniDec build using AI tool to improve the release and add in atomic formula support.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pyisogen-1.0.1.tar.gz.
File metadata
- Download URL: pyisogen-1.0.1.tar.gz
- Upload date:
- Size: 24.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
67282f920246245ca0f60f0f74a196f07e8dddf12c3aa8f6af44a5054b64848d
|
|
| MD5 |
1003935bd8a4de90d17a862ed4f7493a
|
|
| BLAKE2b-256 |
0f9f4f193511ea9b408e846b861ee68069163d6cd9144f3f8c874880d6594774
|
Provenance
The following attestation bundles were made for pyisogen-1.0.1.tar.gz:
Publisher:
publish.yml on michaelmarty/IsoGen
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pyisogen-1.0.1.tar.gz -
Subject digest:
67282f920246245ca0f60f0f74a196f07e8dddf12c3aa8f6af44a5054b64848d - Sigstore transparency entry: 2292885300
- Sigstore integration time:
-
Permalink:
michaelmarty/IsoGen@ba966937e38219875b46f116b08c5e5f13364406 -
Branch / Tag:
refs/tags/v1.0.1 - Owner: https://github.com/michaelmarty
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@ba966937e38219875b46f116b08c5e5f13364406 -
Trigger Event:
release
-
Statement type:
File details
Details for the file pyisogen-1.0.1-py3-none-win_amd64.whl.
File metadata
- Download URL: pyisogen-1.0.1-py3-none-win_amd64.whl
- Upload date:
- Size: 22.2 MB
- Tags: Python 3, Windows x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fd8846f822f52124c20367121bc9abfa72eb530d03dc560f763979099fb83933
|
|
| MD5 |
6d8819d33c46c66c2d97f0c73f8a378a
|
|
| BLAKE2b-256 |
71569cbcbacfe84025cee4259d5805f21441b93d8146f709cffff4f77440ae7f
|
Provenance
The following attestation bundles were made for pyisogen-1.0.1-py3-none-win_amd64.whl:
Publisher:
publish.yml on michaelmarty/IsoGen
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pyisogen-1.0.1-py3-none-win_amd64.whl -
Subject digest:
fd8846f822f52124c20367121bc9abfa72eb530d03dc560f763979099fb83933 - Sigstore transparency entry: 2292885475
- Sigstore integration time:
-
Permalink:
michaelmarty/IsoGen@ba966937e38219875b46f116b08c5e5f13364406 -
Branch / Tag:
refs/tags/v1.0.1 - Owner: https://github.com/michaelmarty
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@ba966937e38219875b46f116b08c5e5f13364406 -
Trigger Event:
release
-
Statement type:
File details
Details for the file pyisogen-1.0.1-py3-none-manylinux_2_31_x86_64.whl.
File metadata
- Download URL: pyisogen-1.0.1-py3-none-manylinux_2_31_x86_64.whl
- Upload date:
- Size: 13.1 MB
- Tags: Python 3, manylinux: glibc 2.31+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
23fcd688b8a5ab56af53ef1549a9bce42837d263a6750a7b683002c5576d09e7
|
|
| MD5 |
1687eb2cbda1f08963a75a9972c04272
|
|
| BLAKE2b-256 |
acdf88c5fccf043803a9bc02d2a6ca2e4c94524f6c40d3ba6e919eaef961c3f7
|
Provenance
The following attestation bundles were made for pyisogen-1.0.1-py3-none-manylinux_2_31_x86_64.whl:
Publisher:
publish.yml on michaelmarty/IsoGen
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pyisogen-1.0.1-py3-none-manylinux_2_31_x86_64.whl -
Subject digest:
23fcd688b8a5ab56af53ef1549a9bce42837d263a6750a7b683002c5576d09e7 - Sigstore transparency entry: 2292885643
- Sigstore integration time:
-
Permalink:
michaelmarty/IsoGen@ba966937e38219875b46f116b08c5e5f13364406 -
Branch / Tag:
refs/tags/v1.0.1 - Owner: https://github.com/michaelmarty
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@ba966937e38219875b46f116b08c5e5f13364406 -
Trigger Event:
release
-
Statement type: