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.4.tar.gz (4.1 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.4-py3-none-any.whl (225.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pertpy-1.0.4.tar.gz
  • Upload date:
  • Size: 4.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pertpy-1.0.4.tar.gz
Algorithm Hash digest
SHA256 d1bdd68fb679eb553c98d5a90bc5f45093a58db19f74803e7d2d537b90cc1ec1
MD5 7e92b32f7c22cd731dfde68f5769d76c
BLAKE2b-256 1cdac4ea567757c082c70c2cf4807eb1a863d1f96dc0267857402a38ee64cf77

See more details on using hashes here.

Provenance

The following attestation bundles were made for pertpy-1.0.4.tar.gz:

Publisher: release.yml on scverse/pertpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: pertpy-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 225.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pertpy-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0fb71568cdd22cd11ac34429558c44272b0cbb063660923c47da182c54dd78c0
MD5 167d644339fa7a109938c6e6b7b9a67f
BLAKE2b-256 36273ee5b2dc8e8b868e907e39eb4b164eec5a19f967285f99a968f751f10543

See more details on using hashes here.

Provenance

The following attestation bundles were made for pertpy-1.0.4-py3-none-any.whl:

Publisher: release.yml on scverse/pertpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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