Skip to main content

Perturbation Analysis in the scverse ecosystem.

Project description

Build codecov License PyPI Python Version Read the Docs Test PyPI

pertpy - Perturbation Analysis in Python

Pertpy is a scverse ecosystem framework for analyzing large-scale single-cell perturbation experiments. It provides tools for harmonizing perturbation datasets, automating metadata annotation, calculating perturbation distances, and efficiently analyzing how cells respond to various stimuli like genetic modifications, drug treatments, and environmental changes.

fig1

Documentation

Please read the documentation for installation, tutorials, use cases, and more.

Installation

We recommend installing and running pertpy on a recent version of Linux (e.g. Ubuntu 24.04 LTS). No particular hardware beyond a standard laptop is required.

You can install pertpy in less than a minute via pip from PyPI:

pip install pertpy

or conda-forge:

conda install -c conda-forge pertpy

Differential gene expression

If you want to use the differential gene expression interface, please install pertpy by running:

pip install 'pertpy[de]'

tascCODA

if you want to use tascCODA, please install pertpy as follows:

pip install 'pertpy[tcoda]'

milo

milo requires either the "de" extra for the "pydeseq2" solver:

pip install 'pertpy[de]'

or, edger, statmod, and rpy2 for the "edger" solver:

BiocManager::install("edgeR")
BiocManager::install("statmod")
pip install rpy2

Citation

@article {Heumos2024.08.04.606516,
    author = {Heumos, Lukas and Ji, Yuge and May, Lilly and Green, Tessa and Zhang, Xinyue and Wu, Xichen and Ostner, Johannes and Peidli, Stefan and Schumacher, Antonia and Hrovatin, Karin and Müller, Michaela and Chong, Faye and Sturm, Gregor and Tejada, Alejandro and Dann, Emma and Dong, Mingze and Bahrami, Mojtaba and Gold, Ilan and Rybakov, Sergei and Namsaraeva, Altana and Moinfar, Amir and Zheng, Zihe and Roellin, Eljas and Mekki, Isra and Sander, Chris and Lotfollahi, Mohammad and Schiller, Herbert B. and Theis, Fabian J.},
    title = {Pertpy: an end-to-end framework for perturbation analysis},
    elocation-id = {2024.08.04.606516},
    year = {2024},
    doi = {10.1101/2024.08.04.606516},
    publisher = {Cold Spring Harbor Laboratory},
    URL = {https://www.biorxiv.org/content/early/2024/08/07/2024.08.04.606516},
    eprint = {https://www.biorxiv.org/content/early/2024/08/07/2024.08.04.606516.full.pdf},
    journal = {bioRxiv}
}

pertpy is part of the scverse® project (website, governance) and is fiscally sponsored by NumFOCUS. If you like scverse® and want to support our mission, please consider making a tax-deductible donation to help the project pay for developer time, professional services, travel, workshops, and a variety of other needs.

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

pertpy-1.0.2.tar.gz (24.6 MB view details)

Uploaded Source

Built Distribution

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

pertpy-1.0.2-py3-none-any.whl (216.6 kB view details)

Uploaded Python 3

File details

Details for the file pertpy-1.0.2.tar.gz.

File metadata

  • Download URL: pertpy-1.0.2.tar.gz
  • Upload date:
  • Size: 24.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.4

File hashes

Hashes for pertpy-1.0.2.tar.gz
Algorithm Hash digest
SHA256 cb076e7c89c467af27e93ddc79496deb9237ae8fc5157e4644d02e98d57474f1
MD5 da2de88aeffcb1e19b0532ed2199ff13
BLAKE2b-256 1fa193da8203e4ef216e3733da2ce1d825e3daaebb3af459ace234ff633252a3

See more details on using hashes here.

File details

Details for the file pertpy-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: pertpy-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 216.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.4

File hashes

Hashes for pertpy-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0f323a6d4036a298be0a7a111ab21b629458a81029e13bd067842123ccfcbc19
MD5 094d8548754a5ebb30dd7e60c5ddd2c7
BLAKE2b-256 3634753474b7a51a32ab2b7eec15ccddc3268b8c76cf8be92f54d7578e615072

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