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

Documentation/ Examples

ReadTheDocs

Features

  • 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! See CONTRIBUTING.md for guidelines on setting up the development environment, code style, testing, and submitting pull requests.

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.1.2.tar.gz (1.1 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.1.2-py3-none-any.whl (172.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for peptacular-3.1.2.tar.gz
Algorithm Hash digest
SHA256 d489112d3b0c5b77a9c7bbbbefa6d7e559868845795c8be2bb6b2e127d4afe63
MD5 53b8f77991f3481853a316c5208f4eba
BLAKE2b-256 68f25c352fc3fb7640c335870f341af54c33098c859a273ec8347790f6bce159

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for peptacular-3.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4a6a82c1745153ec32577631ed90bc7ff5f056a6af7698013fb3a5f6a8889a9d
MD5 23e19e9aa3e874db1f6925844698082f
BLAKE2b-256 b65a664a5ddd40d8890b7bc835dad9462882676615fc53ebb171a012fd31e3f1

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