Skip to main content

A library to calculate peptide features.

Project description

PEPSI: PEPtide Sequence Information

CI Coverage badge Code style: black

PEPSIPy (PEPtide Sequence Information for Python) is an open-source Python library that provides methods for computing a wide range of peptide features, including sequence composition, charge, hydrophobicity, and other physicochemical properties. All features can be calculated on an entire dataset or on a single peptide sequence of interest. Additionally, PEPSI offers a selection of visualisations, such as hydropathy profile or amino acid classification.
This work was conducted as part of the project 'Veni, Vidi, Visualization: Improving Analysis Communication for a Million-Dollar Machine' at the Data Analytics and Computational Statistics Chair, Hasso Plattner Institute.

💻 Python library 📊 Web-based dashboard Miscellaneous
Installation
Usage
Installation
Usage
Third-party resources
License

💻 Python library

Installation

  1. Make sure you have pip installed
  2. Install PEPSI
    pip install pepsipy
  3. Import and use PEPSI in your project!

Usage

  1. Initialize a calculator instance
    import pandas as pd
    from pepsipy import Calculator
    calc = Calculator(
       dataset=pd.read_csv("data/peptides.csv"),
       metadata=pd.read_csv("data/metadata.csv"),
       seq="SVIDQSRVLNLGPITR",
    )
    
  2. Select desired features and plots with related parameters
    calc.set_feature_params(
       gravy=True,
       molecular_weight=True,
    )
    calc.set_plot_params(
       hydropathy_profile=True,
       classification=True,
       classification_classify_by="charge",
    )
    
  3. Compute and show results
    print(calc.get_features())
    plots = calc.get_plots()
    for plot in plots:
       plot.show()
    

📊 Web-based dashboard

Installation

  1. Make sure you have a virtual environment manager available, e.g., venv (recommended), or any other manager such as Conda or Poetry.
  2. Clone this repository and enter the frontend folder
    git clone https://github.com/ronjakrg/pepsipy.git
    cd pepsipy/frontend
    
  3. Create and activate a virtual environment and install all necessary requirements
    python -m venv .venv
    source .venv/bin/activate
    pip install -r requirements.txt
    
  4. Start the server
    python manage.py runserver
    
  5. Open http://127.0.0.1:8000/ in the browser of your choice to use the PEPSI Dashboard!

Usage

  1. Select a dataset and a metadata file (must be uploaded to the /data folder) and a peptide sequence of interest.
  2. Select desired features and plots with related parameters
  3. Click on 'Calculate' and inspect results
Screenshot of PEPSI Dashboard



Third-party resources

Type Name DOI Saved in
Dataset Urinary peptidomics in youths with and without type 1 diabetes 10.1074/mcp.RA119.001858 - /data/peptides.csv
- /data/metadata.csv
Code Isoelectric Point Calculator 2.0 10.1093/nar/gkab295 - /src/pepsipy/external/ipc-2.0.1

License

This project is licensed under the MIT License.

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

pepsipy-1.0.0.tar.gz (23.1 kB view details)

Uploaded Source

Built Distribution

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

pepsipy-1.0.0-py3-none-any.whl (20.0 kB view details)

Uploaded Python 3

File details

Details for the file pepsipy-1.0.0.tar.gz.

File metadata

  • Download URL: pepsipy-1.0.0.tar.gz
  • Upload date:
  • Size: 23.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for pepsipy-1.0.0.tar.gz
Algorithm Hash digest
SHA256 914955277f586bff399f43dcc80d94b6e77a166208b870dd56b3e1017406e725
MD5 c8f46f525aa7d0edde894a6f11fe38e9
BLAKE2b-256 060a228cbb54e3b83fa8ed0dffe7901505aa884e9e7d394d198c76569ee0aca5

See more details on using hashes here.

File details

Details for the file pepsipy-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: pepsipy-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 20.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for pepsipy-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e1a7b7a04769f345519d9b928163b03a006cda01bb85232797b336a984d55ff0
MD5 e118e0f59bceb89a2c1f3d33a0f61699
BLAKE2b-256 5b90bca4b86660c5fd74155b2ec7b4b323e01a63d5775953b21b439da9bfb69c

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