Skip to main content

A ProForma peptide sequence parser and annotation library

Project description

Peptacular

Peptacular Logo

A Python package for peptide sequence analysis built around ProForma 2.1 notation. Calculate masses, generate fragments, predict isotopic patterns, and more. Peptacular uses type annotations extensively, so it is type safe.

Python package codecov PyPI version Python 3.12+ License: MIT

Features

  • Nearly Complete ProForma 2.1 Parsing
  • Modifiable ProFormaAnnotation Objects (Factory Pattern)
  • Mass/Mz/Composition Calculations
  • Predicted Isotopic Distributions
  • Enzymatic Protein Digestion
  • Fragment Ion Generation
  • Physiochemical Property Calculations
  • Built-in Parallel Processing

Installation

pip install peptacular

Quick Start (Object Based)

See docs for more detail.

import peptacular as pt

# Parse a sequence into a ProFormaAnnotation
peptide: pt.ProFormaAnnotation = pt.parse("PEM[Oxidation]TIDE")

# Calculate mass and m/z
mass: float = peptide.mass() # 849.342
mz: float = peptide.mz(charge=2) # 425.678

# Factory pattern
print(peptide.set_charge(2).set_peptide_name("Peptacular").serialize())
# (>Peptacular)PEM[Oxidation]TIDE/2

Quick Start (Functional Based)

When more than one item is passed to the functional API methods, it is automatically parallelized.

import peptacular as pt

peptides = ['[Acetyl]-PEPTIDES', '<C13>ARE', 'SICK/2']

# Calculate mass and m/z for all peptides
masses: list[float] = pt.mass(peptides) # [928.4026, 374.1914, 451.2454]
mzs: list[float] = pt.mz(peptides, charge=2) # [465.2086, 188.103, 225.6227]

ProForma 2.1 Compliance

See PROFORMA_COMPLIANCE.md for detailed compliance status.

Contributing

Contributions welcome! Check the examples directory for code style and documentation patterns.

License

MIT

Citation

Working on a JOSS submission, but in the meantime use:

https://doi.org/10.5281/zenodo.15054278

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

peptacular-3.0.0.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

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

peptacular-3.0.0-py3-none-any.whl (158.4 kB view details)

Uploaded Python 3

File details

Details for the file peptacular-3.0.0.tar.gz.

File metadata

  • Download URL: peptacular-3.0.0.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for peptacular-3.0.0.tar.gz
Algorithm Hash digest
SHA256 9a8685836871d46b84fa70fad2fd52077c462880997f9a89575852e6f4788cc5
MD5 9e636c51fc363b14e7a994cdfd4a2945
BLAKE2b-256 622f9ed9860b0eeb10350011ad6d4900a48f168689b5c6c7506ecf04f625edde

See more details on using hashes here.

File details

Details for the file peptacular-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: peptacular-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 158.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for peptacular-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 23219a8f86ebb4b30a891a693544e2757770305dd4f840dbed8cbe0723732203
MD5 e3ff17f8133ba1050dc54d3a14194086
BLAKE2b-256 973de6679aa339dd39320f7c125e20351cc39458178a6904f9a4cd1d54ac99d7

See more details on using hashes here.

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